@shware/http 2.5.1 → 2.6.0
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/README.md +27 -0
- package/dist/error/detail.cjs.map +1 -1
- package/dist/error/detail.d.cts +2 -2
- package/dist/error/detail.d.ts +2 -2
- package/dist/error/detail.mjs.map +1 -1
- package/dist/error/parse.d.cts +2 -2
- package/dist/error/parse.d.ts +2 -2
- package/dist/error/reason.cjs.map +1 -1
- package/dist/error/reason.d.cts +4 -2
- package/dist/error/reason.d.ts +4 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -47,4 +47,31 @@ app.get('/', () => {
|
|
|
47
47
|
serve({ fetch: app.fetch, port: 3000 });
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
+
## Custom ErrorReason
|
|
51
|
+
|
|
52
|
+
By default, `ErrorInfo.reason` accepts any `string`. You can use TypeScript [declaration merging](https://www.typescriptlang.org/docs/handbook/declaration-merging.html) to constrain it to a set of known keys:
|
|
53
|
+
|
|
54
|
+
```typescript
|
|
55
|
+
// e.g. shware-http.d.ts
|
|
56
|
+
declare module '@shware/http' {
|
|
57
|
+
interface ErrorReason {
|
|
58
|
+
ACCOUNT_BLOCKED: string;
|
|
59
|
+
ACCOUNT_LOCKED: string;
|
|
60
|
+
SUBSCRIPTION_EXPIRED: string;
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Once declared, `Details.errorInfo({ reason })` will only accept the keys you defined, with full autocomplete support:
|
|
66
|
+
|
|
67
|
+
```typescript
|
|
68
|
+
import { Details } from '@shware/http';
|
|
69
|
+
|
|
70
|
+
// OK
|
|
71
|
+
Details.new().errorInfo({ reason: 'ACCOUNT_BLOCKED' });
|
|
72
|
+
|
|
73
|
+
// Type error: Type '"INVALID"' is not assignable to type 'keyof ErrorReason'
|
|
74
|
+
Details.new().errorInfo({ reason: 'INVALID' });
|
|
75
|
+
```
|
|
76
|
+
|
|
50
77
|
## nestjs example
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/error/detail.ts"],"sourcesContent":["/** reference: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto */\nimport type {
|
|
1
|
+
{"version":3,"sources":["../../src/error/detail.ts"],"sourcesContent":["/** reference: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto */\nimport type { ResolvedErrorReason } from './reason';\n\nexport enum DetailType {\n ERROR_INFO = 'type.googleapis.com/google.rpc.ErrorInfo',\n RETRY_INFO = 'type.googleapis.com/google.rpc.RetryInfo',\n DEBUG_INFO = 'type.googleapis.com/google.rpc.DebugInfo',\n QUOTA_FAILURE = 'type.googleapis.com/google.rpc.QuotaFailure',\n PRECONDITION_FAILURE = 'type.googleapis.com/google.rpc.PreconditionFailure',\n BAD_REQUEST = 'type.googleapis.com/google.rpc.BadRequest',\n REQUEST_INFO = 'type.googleapis.com/google.rpc.RequestInfo',\n RESOURCE_INFO = 'type.googleapis.com/google.rpc.ResourceInfo',\n HELP = 'type.googleapis.com/google.rpc.Help',\n LOCALIZED_MESSAGE = 'type.googleapis.com/google.rpc.LocalizedMessage',\n}\n\nexport interface ErrorInfo {\n '@type': DetailType.ERROR_INFO;\n reason: ResolvedErrorReason;\n domain?: string;\n metadata?: Record<string, string>;\n}\n\nexport interface RetryInfo {\n '@type': DetailType.RETRY_INFO;\n retryDelay: number;\n}\n\nexport interface DebugInfo {\n '@type': DetailType.DEBUG_INFO;\n stackEntries: string[];\n detail: string;\n}\n\nexport interface QuotaFailure {\n '@type': DetailType.QUOTA_FAILURE;\n violations: {\n subject: string;\n description: string;\n apiService: string;\n quoteId: string;\n quoteValue: number;\n quotaMetric: string;\n quotaDimensions: Record<string, string>;\n futureQuotaValue: number;\n }[];\n}\n\nexport interface PreconditionFailure {\n '@type': DetailType.PRECONDITION_FAILURE;\n violations: { type: string; subject: string; description: string }[];\n}\n\nexport interface BadRequest {\n '@type': DetailType.BAD_REQUEST;\n fieldViolations: {\n field: string;\n description: string;\n reason: string;\n localizedMessage: Omit<LocalizedMessage, '@type'>;\n }[];\n}\n\nexport interface RequestInfo {\n '@type': DetailType.REQUEST_INFO;\n requestId: string;\n servingData: string;\n}\n\nexport interface ResourceInfo {\n '@type': DetailType.RESOURCE_INFO;\n resourceType: string;\n resourceName: string;\n owner: string;\n description: string;\n}\n\nexport interface Help {\n '@type': DetailType.HELP;\n links: { url: string; description: string }[];\n}\n\nexport interface LocalizedMessage {\n '@type': DetailType.LOCALIZED_MESSAGE;\n locale: string;\n message: string;\n}\n\nexport type Detail =\n | RetryInfo\n | DebugInfo\n | QuotaFailure\n | ErrorInfo\n | PreconditionFailure\n | BadRequest\n | RequestInfo\n | ResourceInfo\n | Help\n | LocalizedMessage;\n\n/**\n * Example usage:\n * const details = Details.new()\n * .requestInfo({ requestId: '1234567890', servingData: '/v1/tests' })\n * .errorInfo({ reason: 'ACCOUNT_LOCKED' });\n * */\nexport class Details {\n readonly list: Detail[] = [];\n private constructor() {}\n\n static new() {\n return new Details();\n }\n\n errorInfo(detail: Omit<ErrorInfo, '@type'>) {\n this.list.push({ '@type': DetailType.ERROR_INFO, ...detail });\n return this;\n }\n\n retryInfo(detail: Omit<RetryInfo, '@type'>) {\n this.list.push({ '@type': DetailType.RETRY_INFO, ...detail });\n return this;\n }\n\n debugInfo(detail: Omit<DebugInfo, '@type'>) {\n this.list.push({ '@type': DetailType.DEBUG_INFO, ...detail });\n return this;\n }\n\n quotaFailure(detail: Omit<QuotaFailure, '@type'>) {\n this.list.push({ '@type': DetailType.QUOTA_FAILURE, ...detail });\n return this;\n }\n\n preconditionFailure(detail: Omit<PreconditionFailure, '@type'>) {\n this.list.push({ '@type': DetailType.PRECONDITION_FAILURE, ...detail });\n return this;\n }\n\n badRequest(detail: Omit<BadRequest, '@type'>) {\n this.list.push({ '@type': DetailType.BAD_REQUEST, ...detail });\n return this;\n }\n\n requestInfo(detail: Omit<RequestInfo, '@type'>) {\n this.list.push({ '@type': DetailType.REQUEST_INFO, ...detail });\n return this;\n }\n\n resourceInfo(detail: Omit<ResourceInfo, '@type'>) {\n this.list.push({ '@type': DetailType.RESOURCE_INFO, ...detail });\n return this;\n }\n\n help(detail: Omit<Help, '@type'>) {\n this.list.push({ '@type': DetailType.HELP, ...detail });\n return this;\n }\n\n localizedMessage(detail: Omit<LocalizedMessage, '@type'>) {\n this.list.push({ '@type': DetailType.LOCALIZED_MESSAGE, ...detail });\n return this;\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAGO,IAAK,aAAL,kBAAKA,gBAAL;AACL,EAAAA,YAAA,gBAAa;AACb,EAAAA,YAAA,gBAAa;AACb,EAAAA,YAAA,gBAAa;AACb,EAAAA,YAAA,mBAAgB;AAChB,EAAAA,YAAA,0BAAuB;AACvB,EAAAA,YAAA,iBAAc;AACd,EAAAA,YAAA,kBAAe;AACf,EAAAA,YAAA,mBAAgB;AAChB,EAAAA,YAAA,UAAO;AACP,EAAAA,YAAA,uBAAoB;AAVV,SAAAA;AAAA,GAAA;AAuGL,IAAM,UAAN,MAAM,SAAQ;AAAA,EACV,OAAiB,CAAC;AAAA,EACnB,cAAc;AAAA,EAAC;AAAA,EAEvB,OAAO,MAAM;AACX,WAAO,IAAI,SAAQ;AAAA,EACrB;AAAA,EAEA,UAAU,QAAkC;AAC1C,SAAK,KAAK,KAAK,EAAE,SAAS,6DAAuB,GAAG,OAAO,CAAC;AAC5D,WAAO;AAAA,EACT;AAAA,EAEA,UAAU,QAAkC;AAC1C,SAAK,KAAK,KAAK,EAAE,SAAS,6DAAuB,GAAG,OAAO,CAAC;AAC5D,WAAO;AAAA,EACT;AAAA,EAEA,UAAU,QAAkC;AAC1C,SAAK,KAAK,KAAK,EAAE,SAAS,6DAAuB,GAAG,OAAO,CAAC;AAC5D,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,QAAqC;AAChD,SAAK,KAAK,KAAK,EAAE,SAAS,mEAA0B,GAAG,OAAO,CAAC;AAC/D,WAAO;AAAA,EACT;AAAA,EAEA,oBAAoB,QAA4C;AAC9D,SAAK,KAAK,KAAK,EAAE,SAAS,iFAAiC,GAAG,OAAO,CAAC;AACtE,WAAO;AAAA,EACT;AAAA,EAEA,WAAW,QAAmC;AAC5C,SAAK,KAAK,KAAK,EAAE,SAAS,+DAAwB,GAAG,OAAO,CAAC;AAC7D,WAAO;AAAA,EACT;AAAA,EAEA,YAAY,QAAoC;AAC9C,SAAK,KAAK,KAAK,EAAE,SAAS,iEAAyB,GAAG,OAAO,CAAC;AAC9D,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,QAAqC;AAChD,SAAK,KAAK,KAAK,EAAE,SAAS,mEAA0B,GAAG,OAAO,CAAC;AAC/D,WAAO;AAAA,EACT;AAAA,EAEA,KAAK,QAA6B;AAChC,SAAK,KAAK,KAAK,EAAE,SAAS,kDAAiB,GAAG,OAAO,CAAC;AACtD,WAAO;AAAA,EACT;AAAA,EAEA,iBAAiB,QAAyC;AACxD,SAAK,KAAK,KAAK,EAAE,SAAS,2EAA8B,GAAG,OAAO,CAAC;AACnE,WAAO;AAAA,EACT;AACF;","names":["DetailType"]}
|
package/dist/error/detail.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ResolvedErrorReason } from './reason.cjs';
|
|
2
2
|
|
|
3
3
|
/** reference: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto */
|
|
4
4
|
|
|
@@ -16,7 +16,7 @@ declare enum DetailType {
|
|
|
16
16
|
}
|
|
17
17
|
interface ErrorInfo {
|
|
18
18
|
'@type': DetailType.ERROR_INFO;
|
|
19
|
-
reason:
|
|
19
|
+
reason: ResolvedErrorReason;
|
|
20
20
|
domain?: string;
|
|
21
21
|
metadata?: Record<string, string>;
|
|
22
22
|
}
|
package/dist/error/detail.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ResolvedErrorReason } from './reason.js';
|
|
2
2
|
|
|
3
3
|
/** reference: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto */
|
|
4
4
|
|
|
@@ -16,7 +16,7 @@ declare enum DetailType {
|
|
|
16
16
|
}
|
|
17
17
|
interface ErrorInfo {
|
|
18
18
|
'@type': DetailType.ERROR_INFO;
|
|
19
|
-
reason:
|
|
19
|
+
reason: ResolvedErrorReason;
|
|
20
20
|
domain?: string;
|
|
21
21
|
metadata?: Record<string, string>;
|
|
22
22
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/error/detail.ts"],"sourcesContent":["/** reference: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto */\nimport type {
|
|
1
|
+
{"version":3,"sources":["../../src/error/detail.ts"],"sourcesContent":["/** reference: https://github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto */\nimport type { ResolvedErrorReason } from './reason';\n\nexport enum DetailType {\n ERROR_INFO = 'type.googleapis.com/google.rpc.ErrorInfo',\n RETRY_INFO = 'type.googleapis.com/google.rpc.RetryInfo',\n DEBUG_INFO = 'type.googleapis.com/google.rpc.DebugInfo',\n QUOTA_FAILURE = 'type.googleapis.com/google.rpc.QuotaFailure',\n PRECONDITION_FAILURE = 'type.googleapis.com/google.rpc.PreconditionFailure',\n BAD_REQUEST = 'type.googleapis.com/google.rpc.BadRequest',\n REQUEST_INFO = 'type.googleapis.com/google.rpc.RequestInfo',\n RESOURCE_INFO = 'type.googleapis.com/google.rpc.ResourceInfo',\n HELP = 'type.googleapis.com/google.rpc.Help',\n LOCALIZED_MESSAGE = 'type.googleapis.com/google.rpc.LocalizedMessage',\n}\n\nexport interface ErrorInfo {\n '@type': DetailType.ERROR_INFO;\n reason: ResolvedErrorReason;\n domain?: string;\n metadata?: Record<string, string>;\n}\n\nexport interface RetryInfo {\n '@type': DetailType.RETRY_INFO;\n retryDelay: number;\n}\n\nexport interface DebugInfo {\n '@type': DetailType.DEBUG_INFO;\n stackEntries: string[];\n detail: string;\n}\n\nexport interface QuotaFailure {\n '@type': DetailType.QUOTA_FAILURE;\n violations: {\n subject: string;\n description: string;\n apiService: string;\n quoteId: string;\n quoteValue: number;\n quotaMetric: string;\n quotaDimensions: Record<string, string>;\n futureQuotaValue: number;\n }[];\n}\n\nexport interface PreconditionFailure {\n '@type': DetailType.PRECONDITION_FAILURE;\n violations: { type: string; subject: string; description: string }[];\n}\n\nexport interface BadRequest {\n '@type': DetailType.BAD_REQUEST;\n fieldViolations: {\n field: string;\n description: string;\n reason: string;\n localizedMessage: Omit<LocalizedMessage, '@type'>;\n }[];\n}\n\nexport interface RequestInfo {\n '@type': DetailType.REQUEST_INFO;\n requestId: string;\n servingData: string;\n}\n\nexport interface ResourceInfo {\n '@type': DetailType.RESOURCE_INFO;\n resourceType: string;\n resourceName: string;\n owner: string;\n description: string;\n}\n\nexport interface Help {\n '@type': DetailType.HELP;\n links: { url: string; description: string }[];\n}\n\nexport interface LocalizedMessage {\n '@type': DetailType.LOCALIZED_MESSAGE;\n locale: string;\n message: string;\n}\n\nexport type Detail =\n | RetryInfo\n | DebugInfo\n | QuotaFailure\n | ErrorInfo\n | PreconditionFailure\n | BadRequest\n | RequestInfo\n | ResourceInfo\n | Help\n | LocalizedMessage;\n\n/**\n * Example usage:\n * const details = Details.new()\n * .requestInfo({ requestId: '1234567890', servingData: '/v1/tests' })\n * .errorInfo({ reason: 'ACCOUNT_LOCKED' });\n * */\nexport class Details {\n readonly list: Detail[] = [];\n private constructor() {}\n\n static new() {\n return new Details();\n }\n\n errorInfo(detail: Omit<ErrorInfo, '@type'>) {\n this.list.push({ '@type': DetailType.ERROR_INFO, ...detail });\n return this;\n }\n\n retryInfo(detail: Omit<RetryInfo, '@type'>) {\n this.list.push({ '@type': DetailType.RETRY_INFO, ...detail });\n return this;\n }\n\n debugInfo(detail: Omit<DebugInfo, '@type'>) {\n this.list.push({ '@type': DetailType.DEBUG_INFO, ...detail });\n return this;\n }\n\n quotaFailure(detail: Omit<QuotaFailure, '@type'>) {\n this.list.push({ '@type': DetailType.QUOTA_FAILURE, ...detail });\n return this;\n }\n\n preconditionFailure(detail: Omit<PreconditionFailure, '@type'>) {\n this.list.push({ '@type': DetailType.PRECONDITION_FAILURE, ...detail });\n return this;\n }\n\n badRequest(detail: Omit<BadRequest, '@type'>) {\n this.list.push({ '@type': DetailType.BAD_REQUEST, ...detail });\n return this;\n }\n\n requestInfo(detail: Omit<RequestInfo, '@type'>) {\n this.list.push({ '@type': DetailType.REQUEST_INFO, ...detail });\n return this;\n }\n\n resourceInfo(detail: Omit<ResourceInfo, '@type'>) {\n this.list.push({ '@type': DetailType.RESOURCE_INFO, ...detail });\n return this;\n }\n\n help(detail: Omit<Help, '@type'>) {\n this.list.push({ '@type': DetailType.HELP, ...detail });\n return this;\n }\n\n localizedMessage(detail: Omit<LocalizedMessage, '@type'>) {\n this.list.push({ '@type': DetailType.LOCALIZED_MESSAGE, ...detail });\n return this;\n }\n}\n"],"mappings":";AAGO,IAAK,aAAL,kBAAKA,gBAAL;AACL,EAAAA,YAAA,gBAAa;AACb,EAAAA,YAAA,gBAAa;AACb,EAAAA,YAAA,gBAAa;AACb,EAAAA,YAAA,mBAAgB;AAChB,EAAAA,YAAA,0BAAuB;AACvB,EAAAA,YAAA,iBAAc;AACd,EAAAA,YAAA,kBAAe;AACf,EAAAA,YAAA,mBAAgB;AAChB,EAAAA,YAAA,UAAO;AACP,EAAAA,YAAA,uBAAoB;AAVV,SAAAA;AAAA,GAAA;AAuGL,IAAM,UAAN,MAAM,SAAQ;AAAA,EACV,OAAiB,CAAC;AAAA,EACnB,cAAc;AAAA,EAAC;AAAA,EAEvB,OAAO,MAAM;AACX,WAAO,IAAI,SAAQ;AAAA,EACrB;AAAA,EAEA,UAAU,QAAkC;AAC1C,SAAK,KAAK,KAAK,EAAE,SAAS,6DAAuB,GAAG,OAAO,CAAC;AAC5D,WAAO;AAAA,EACT;AAAA,EAEA,UAAU,QAAkC;AAC1C,SAAK,KAAK,KAAK,EAAE,SAAS,6DAAuB,GAAG,OAAO,CAAC;AAC5D,WAAO;AAAA,EACT;AAAA,EAEA,UAAU,QAAkC;AAC1C,SAAK,KAAK,KAAK,EAAE,SAAS,6DAAuB,GAAG,OAAO,CAAC;AAC5D,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,QAAqC;AAChD,SAAK,KAAK,KAAK,EAAE,SAAS,mEAA0B,GAAG,OAAO,CAAC;AAC/D,WAAO;AAAA,EACT;AAAA,EAEA,oBAAoB,QAA4C;AAC9D,SAAK,KAAK,KAAK,EAAE,SAAS,iFAAiC,GAAG,OAAO,CAAC;AACtE,WAAO;AAAA,EACT;AAAA,EAEA,WAAW,QAAmC;AAC5C,SAAK,KAAK,KAAK,EAAE,SAAS,+DAAwB,GAAG,OAAO,CAAC;AAC7D,WAAO;AAAA,EACT;AAAA,EAEA,YAAY,QAAoC;AAC9C,SAAK,KAAK,KAAK,EAAE,SAAS,iEAAyB,GAAG,OAAO,CAAC;AAC9D,WAAO;AAAA,EACT;AAAA,EAEA,aAAa,QAAqC;AAChD,SAAK,KAAK,KAAK,EAAE,SAAS,mEAA0B,GAAG,OAAO,CAAC;AAC/D,WAAO;AAAA,EACT;AAAA,EAEA,KAAK,QAA6B;AAChC,SAAK,KAAK,KAAK,EAAE,SAAS,kDAAiB,GAAG,OAAO,CAAC;AACtD,WAAO;AAAA,EACT;AAAA,EAEA,iBAAiB,QAAyC;AACxD,SAAK,KAAK,KAAK,EAAE,SAAS,2EAA8B,GAAG,OAAO,CAAC;AACnE,WAAO;AAAA,EACT;AACF;","names":["DetailType"]}
|
package/dist/error/parse.d.cts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { NetworkErrorReason, StatusErrorReason, AuthenticationErrorReason, ModerationErrorReason, MultipartErrorReason, AppErrorReason } from './reason.cjs';
|
|
2
1
|
import { Namespace, DefaultNamespace, TFunction } from 'i18next';
|
|
3
2
|
import { BadRequest } from './detail.cjs';
|
|
3
|
+
import './reason.cjs';
|
|
4
4
|
|
|
5
|
-
declare function getErrorReason(data: unknown):
|
|
5
|
+
declare function getErrorReason(data: unknown): string;
|
|
6
6
|
/**
|
|
7
7
|
* @example For axios:
|
|
8
8
|
*
|
package/dist/error/parse.d.ts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { NetworkErrorReason, StatusErrorReason, AuthenticationErrorReason, ModerationErrorReason, MultipartErrorReason, AppErrorReason } from './reason.js';
|
|
2
1
|
import { Namespace, DefaultNamespace, TFunction } from 'i18next';
|
|
3
2
|
import { BadRequest } from './detail.js';
|
|
3
|
+
import './reason.js';
|
|
4
4
|
|
|
5
|
-
declare function getErrorReason(data: unknown):
|
|
5
|
+
declare function getErrorReason(data: unknown): string;
|
|
6
6
|
/**
|
|
7
7
|
* @example For axios:
|
|
8
8
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/error/reason.ts"],"sourcesContent":["export interface NetworkErrorReason {\n DNS_ERROR: string;\n MISCONFIGURATION: string;\n CONNECTION_ERROR: string;\n}\n\nexport interface StatusErrorReason {\n OK: string;\n CANCELLED: string;\n UNKNOWN: string;\n INVALID_ARGUMENT: string;\n DEADLINE_EXCEEDED: string;\n NOT_FOUND: string;\n ALREADY_EXISTS: string;\n PERMISSION_DENIED: string;\n RESOURCE_EXHAUSTED: string;\n FAILED_PRECONDITION: string;\n ABORTED: string;\n OUT_OF_RANGE: string;\n UNIMPLEMENTED: string;\n INTERNAL: string;\n UNAVAILABLE: string;\n DATA_LOSS: string;\n UNAUTHENTICATED: string;\n // other http status code\n}\n\nexport interface AuthenticationErrorReason {\n ACCOUNT_LOCKED: string;\n ACCOUNT_EXPIRED: string;\n ACCOUNT_INACTIVE: string;\n ACCOUNT_DISABLED: string;\n ACCOUNT_SUSPENDED: string;\n ACCESS_DENIED: string;\n ACCESS_TOKEN_REQUIRED: string;\n PASSWORD_MISMATCH: string;\n USERNAME_ALREADY_EXISTS: string;\n VERIFICATION_CODE_MISMATCH: string;\n VERIFICATION_CODE_SEND_FAILED: string;\n}\n\nexport interface ModerationErrorReason {\n POSSIBLY_SENSITIVE: string;\n ADULT_CONTENT: string;\n NUDITY_CONTENT: string;\n SEXUAL_CONTENT: string;\n BLOODY_CONTENT: string;\n WEAPON_CONTENT: string;\n POLITICS_CONTENT: string;\n VIOLENCE_CONTENT: string;\n ABUSE_CONTENT: string;\n ADVERTISEMENT_CONTENT: string;\n CONTRABAND_CONTENT: string;\n SPAM_CONTENT: string;\n MEANINGLESS_CONTENT: string;\n UNSAFE_TEXT_DETECTED: string;\n}\n\nexport interface MultipartErrorReason {\n MAX_UPLOAD_SIZE_EXCEEDED: string;\n MEDIA_TYPE_NOT_SUPPORTED: string;\n MEDIA_TYPE_NOT_ACCEPTABLE: string;\n}\n\nexport interface AppErrorReason {\n RATE_LIMIT_EXCEEDED: string;\n INSUFFICIENT_CREDITS: string;\n ALREADY_SUBSCRIBED_AT_OTHER_PLATFORM: string;\n}\n\
|
|
1
|
+
{"version":3,"sources":["../../src/error/reason.ts"],"sourcesContent":["export interface NetworkErrorReason {\n DNS_ERROR: string;\n MISCONFIGURATION: string;\n CONNECTION_ERROR: string;\n}\n\nexport interface StatusErrorReason {\n OK: string;\n CANCELLED: string;\n UNKNOWN: string;\n INVALID_ARGUMENT: string;\n DEADLINE_EXCEEDED: string;\n NOT_FOUND: string;\n ALREADY_EXISTS: string;\n PERMISSION_DENIED: string;\n RESOURCE_EXHAUSTED: string;\n FAILED_PRECONDITION: string;\n ABORTED: string;\n OUT_OF_RANGE: string;\n UNIMPLEMENTED: string;\n INTERNAL: string;\n UNAVAILABLE: string;\n DATA_LOSS: string;\n UNAUTHENTICATED: string;\n // other http status code\n}\n\nexport interface AuthenticationErrorReason {\n ACCOUNT_LOCKED: string;\n ACCOUNT_EXPIRED: string;\n ACCOUNT_INACTIVE: string;\n ACCOUNT_DISABLED: string;\n ACCOUNT_SUSPENDED: string;\n ACCESS_DENIED: string;\n ACCESS_TOKEN_REQUIRED: string;\n PASSWORD_MISMATCH: string;\n USERNAME_ALREADY_EXISTS: string;\n VERIFICATION_CODE_MISMATCH: string;\n VERIFICATION_CODE_SEND_FAILED: string;\n}\n\nexport interface ModerationErrorReason {\n POSSIBLY_SENSITIVE: string;\n ADULT_CONTENT: string;\n NUDITY_CONTENT: string;\n SEXUAL_CONTENT: string;\n BLOODY_CONTENT: string;\n WEAPON_CONTENT: string;\n POLITICS_CONTENT: string;\n VIOLENCE_CONTENT: string;\n ABUSE_CONTENT: string;\n ADVERTISEMENT_CONTENT: string;\n CONTRABAND_CONTENT: string;\n SPAM_CONTENT: string;\n MEANINGLESS_CONTENT: string;\n UNSAFE_TEXT_DETECTED: string;\n}\n\nexport interface MultipartErrorReason {\n MAX_UPLOAD_SIZE_EXCEEDED: string;\n MEDIA_TYPE_NOT_SUPPORTED: string;\n MEDIA_TYPE_NOT_ACCEPTABLE: string;\n}\n\nexport interface AppErrorReason {\n RATE_LIMIT_EXCEEDED: string;\n INSUFFICIENT_CREDITS: string;\n ALREADY_SUBSCRIBED_AT_OTHER_PLATFORM: string;\n}\n\n// oxlint-disable-next-line typescript/no-empty-object-type\nexport interface ErrorReason {}\n\nexport type ResolvedErrorReason = keyof ErrorReason extends never\n ? string\n : keyof ErrorReason;\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
|
package/dist/error/reason.d.cts
CHANGED
|
@@ -61,6 +61,8 @@ interface AppErrorReason {
|
|
|
61
61
|
INSUFFICIENT_CREDITS: string;
|
|
62
62
|
ALREADY_SUBSCRIBED_AT_OTHER_PLATFORM: string;
|
|
63
63
|
}
|
|
64
|
-
|
|
64
|
+
interface ErrorReason {
|
|
65
|
+
}
|
|
66
|
+
type ResolvedErrorReason = keyof ErrorReason extends never ? string : keyof ErrorReason;
|
|
65
67
|
|
|
66
|
-
export type { AppErrorReason, AuthenticationErrorReason, ErrorReason, ModerationErrorReason, MultipartErrorReason, NetworkErrorReason, StatusErrorReason };
|
|
68
|
+
export type { AppErrorReason, AuthenticationErrorReason, ErrorReason, ModerationErrorReason, MultipartErrorReason, NetworkErrorReason, ResolvedErrorReason, StatusErrorReason };
|
package/dist/error/reason.d.ts
CHANGED
|
@@ -61,6 +61,8 @@ interface AppErrorReason {
|
|
|
61
61
|
INSUFFICIENT_CREDITS: string;
|
|
62
62
|
ALREADY_SUBSCRIBED_AT_OTHER_PLATFORM: string;
|
|
63
63
|
}
|
|
64
|
-
|
|
64
|
+
interface ErrorReason {
|
|
65
|
+
}
|
|
66
|
+
type ResolvedErrorReason = keyof ErrorReason extends never ? string : keyof ErrorReason;
|
|
65
67
|
|
|
66
|
-
export type { AppErrorReason, AuthenticationErrorReason, ErrorReason, ModerationErrorReason, MultipartErrorReason, NetworkErrorReason, StatusErrorReason };
|
|
68
|
+
export type { AppErrorReason, AuthenticationErrorReason, ErrorReason, ModerationErrorReason, MultipartErrorReason, NetworkErrorReason, ResolvedErrorReason, StatusErrorReason };
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @example\n * import { Details, Status } from '@repo/error';\n *\n * Status.adapter = () => new Error('Error');\n *\n * const details = Details.new()\n * .requestInfo({ requestId: '1234567890', servingData: '/v1/tests' })\n * .errorInfo({ reason: 'ACCOUNT_LOCKED' });\n *\n * throw Status.alreadyExists('xxx').error(details);\n */\n\nexport {\n LoginTimeoutError,\n LoginCanceledError,\n CheckoutCreateError,\n PurchaseError,\n} from './error/index';\nexport type {\n NetworkErrorReason,\n StatusErrorReason,\n AuthenticationErrorReason,\n ModerationErrorReason,\n MultipartErrorReason,\n AppErrorReason,\n ErrorReason,\n} from './error/reason';\nexport {\n DetailType,\n Details,\n type ErrorInfo,\n type RetryInfo,\n type DebugInfo,\n type QuotaFailure,\n type PreconditionFailure,\n type BadRequest,\n type RequestInfo,\n type ResourceInfo,\n type Help,\n type LocalizedMessage,\n type Detail,\n} from './error/detail';\nexport { Status, StatusError, type ErrorBody } from './error/status';\nexport { getErrorReason, getErrorMessage, getFieldViolations } from './error/parse';\nexport {\n Items,\n Pages,\n Cursor,\n pageParamsSchema,\n initialPageParam,\n getPreviousPageParam,\n getNextPageParam,\n} from './response';\nexport type {\n Empty,\n EntityId,\n Entity,\n Response,\n InitParams,\n NextParams,\n PrevParams,\n PageParams,\n ParentPageParams,\n Page,\n InfinitePageData,\n} from './response';\n\nexport { UidGenerator, uid } from './snowflake';\n\nexport * as MAX_LENGTH from './max-length/index';\nexport { timing } from './utils/timing';\nexport { ISO_3601_1, type ISO3166CountryCode } from './iso/iso_3601_1';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAaA,mBAKO;
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @example\n * import { Details, Status } from '@repo/error';\n *\n * Status.adapter = () => new Error('Error');\n *\n * const details = Details.new()\n * .requestInfo({ requestId: '1234567890', servingData: '/v1/tests' })\n * .errorInfo({ reason: 'ACCOUNT_LOCKED' });\n *\n * throw Status.alreadyExists('xxx').error(details);\n */\n\nexport {\n LoginTimeoutError,\n LoginCanceledError,\n CheckoutCreateError,\n PurchaseError,\n} from './error/index';\nexport type {\n NetworkErrorReason,\n StatusErrorReason,\n AuthenticationErrorReason,\n ModerationErrorReason,\n MultipartErrorReason,\n AppErrorReason,\n ErrorReason,\n ResolvedErrorReason,\n} from './error/reason';\nexport {\n DetailType,\n Details,\n type ErrorInfo,\n type RetryInfo,\n type DebugInfo,\n type QuotaFailure,\n type PreconditionFailure,\n type BadRequest,\n type RequestInfo,\n type ResourceInfo,\n type Help,\n type LocalizedMessage,\n type Detail,\n} from './error/detail';\nexport { Status, StatusError, type ErrorBody } from './error/status';\nexport { getErrorReason, getErrorMessage, getFieldViolations } from './error/parse';\nexport {\n Items,\n Pages,\n Cursor,\n pageParamsSchema,\n initialPageParam,\n getPreviousPageParam,\n getNextPageParam,\n} from './response';\nexport type {\n Empty,\n EntityId,\n Entity,\n Response,\n InitParams,\n NextParams,\n PrevParams,\n PageParams,\n ParentPageParams,\n Page,\n InfinitePageData,\n} from './response';\n\nexport { UidGenerator, uid } from './snowflake';\n\nexport * as MAX_LENGTH from './max-length/index';\nexport { timing } from './utils/timing';\nexport { ISO_3601_1, type ISO3166CountryCode } from './iso/iso_3601_1';\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAaA,mBAKO;AAWP,oBAcO;AACP,oBAAoD;AACpD,mBAAoE;AACpE,sBAQO;AAeP,uBAAkC;AAElC,iBAA4B;AAC5B,oBAAuB;AACvB,wBAAoD;","names":[]}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { CheckoutCreateError, LoginCanceledError, LoginTimeoutError, PurchaseError } from './error/index.cjs';
|
|
2
|
-
export { AppErrorReason, AuthenticationErrorReason, ErrorReason, ModerationErrorReason, MultipartErrorReason, NetworkErrorReason, StatusErrorReason } from './error/reason.cjs';
|
|
2
|
+
export { AppErrorReason, AuthenticationErrorReason, ErrorReason, ModerationErrorReason, MultipartErrorReason, NetworkErrorReason, ResolvedErrorReason, StatusErrorReason } from './error/reason.cjs';
|
|
3
3
|
export { BadRequest, DebugInfo, Detail, DetailType, Details, ErrorInfo, Help, LocalizedMessage, PreconditionFailure, QuotaFailure, RequestInfo, ResourceInfo, RetryInfo } from './error/detail.cjs';
|
|
4
4
|
export { ErrorBody, Status, StatusError } from './error/status.cjs';
|
|
5
5
|
export { getErrorMessage, getErrorReason, getFieldViolations } from './error/parse.cjs';
|
package/dist/index.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
export { CheckoutCreateError, LoginCanceledError, LoginTimeoutError, PurchaseError } from './error/index.js';
|
|
2
|
-
export { AppErrorReason, AuthenticationErrorReason, ErrorReason, ModerationErrorReason, MultipartErrorReason, NetworkErrorReason, StatusErrorReason } from './error/reason.js';
|
|
2
|
+
export { AppErrorReason, AuthenticationErrorReason, ErrorReason, ModerationErrorReason, MultipartErrorReason, NetworkErrorReason, ResolvedErrorReason, StatusErrorReason } from './error/reason.js';
|
|
3
3
|
export { BadRequest, DebugInfo, Detail, DetailType, Details, ErrorInfo, Help, LocalizedMessage, PreconditionFailure, QuotaFailure, RequestInfo, ResourceInfo, RetryInfo } from './error/detail.js';
|
|
4
4
|
export { ErrorBody, Status, StatusError } from './error/status.js';
|
|
5
5
|
export { getErrorMessage, getErrorReason, getFieldViolations } from './error/parse.js';
|
package/dist/index.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @example\n * import { Details, Status } from '@repo/error';\n *\n * Status.adapter = () => new Error('Error');\n *\n * const details = Details.new()\n * .requestInfo({ requestId: '1234567890', servingData: '/v1/tests' })\n * .errorInfo({ reason: 'ACCOUNT_LOCKED' });\n *\n * throw Status.alreadyExists('xxx').error(details);\n */\n\nexport {\n LoginTimeoutError,\n LoginCanceledError,\n CheckoutCreateError,\n PurchaseError,\n} from './error/index';\nexport type {\n NetworkErrorReason,\n StatusErrorReason,\n AuthenticationErrorReason,\n ModerationErrorReason,\n MultipartErrorReason,\n AppErrorReason,\n ErrorReason,\n} from './error/reason';\nexport {\n DetailType,\n Details,\n type ErrorInfo,\n type RetryInfo,\n type DebugInfo,\n type QuotaFailure,\n type PreconditionFailure,\n type BadRequest,\n type RequestInfo,\n type ResourceInfo,\n type Help,\n type LocalizedMessage,\n type Detail,\n} from './error/detail';\nexport { Status, StatusError, type ErrorBody } from './error/status';\nexport { getErrorReason, getErrorMessage, getFieldViolations } from './error/parse';\nexport {\n Items,\n Pages,\n Cursor,\n pageParamsSchema,\n initialPageParam,\n getPreviousPageParam,\n getNextPageParam,\n} from './response';\nexport type {\n Empty,\n EntityId,\n Entity,\n Response,\n InitParams,\n NextParams,\n PrevParams,\n PageParams,\n ParentPageParams,\n Page,\n InfinitePageData,\n} from './response';\n\nexport { UidGenerator, uid } from './snowflake';\n\nexport * as MAX_LENGTH from './max-length/index';\nexport { timing } from './utils/timing';\nexport { ISO_3601_1, type ISO3166CountryCode } from './iso/iso_3601_1';\n"],"mappings":";AAaA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["/**\n * @example\n * import { Details, Status } from '@repo/error';\n *\n * Status.adapter = () => new Error('Error');\n *\n * const details = Details.new()\n * .requestInfo({ requestId: '1234567890', servingData: '/v1/tests' })\n * .errorInfo({ reason: 'ACCOUNT_LOCKED' });\n *\n * throw Status.alreadyExists('xxx').error(details);\n */\n\nexport {\n LoginTimeoutError,\n LoginCanceledError,\n CheckoutCreateError,\n PurchaseError,\n} from './error/index';\nexport type {\n NetworkErrorReason,\n StatusErrorReason,\n AuthenticationErrorReason,\n ModerationErrorReason,\n MultipartErrorReason,\n AppErrorReason,\n ErrorReason,\n ResolvedErrorReason,\n} from './error/reason';\nexport {\n DetailType,\n Details,\n type ErrorInfo,\n type RetryInfo,\n type DebugInfo,\n type QuotaFailure,\n type PreconditionFailure,\n type BadRequest,\n type RequestInfo,\n type ResourceInfo,\n type Help,\n type LocalizedMessage,\n type Detail,\n} from './error/detail';\nexport { Status, StatusError, type ErrorBody } from './error/status';\nexport { getErrorReason, getErrorMessage, getFieldViolations } from './error/parse';\nexport {\n Items,\n Pages,\n Cursor,\n pageParamsSchema,\n initialPageParam,\n getPreviousPageParam,\n getNextPageParam,\n} from './response';\nexport type {\n Empty,\n EntityId,\n Entity,\n Response,\n InitParams,\n NextParams,\n PrevParams,\n PageParams,\n ParentPageParams,\n Page,\n InfinitePageData,\n} from './response';\n\nexport { UidGenerator, uid } from './snowflake';\n\nexport * as MAX_LENGTH from './max-length/index';\nexport { timing } from './utils/timing';\nexport { ISO_3601_1, type ISO3166CountryCode } from './iso/iso_3601_1';\n"],"mappings":";AAaA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAWP;AAAA,EACE;AAAA,EACA;AAAA,OAYK;AACP,SAAS,QAAQ,mBAAmC;AACpD,SAAS,gBAAgB,iBAAiB,0BAA0B;AACpE;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAeP,SAAS,cAAc,WAAW;AAElC,YAAY,gBAAgB;AAC5B,SAAS,cAAc;AACvB,SAAS,kBAA2C;","names":[]}
|