@orpc/shared 0.0.0-next.10945d3 → 0.0.0-next.172fe95

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.js CHANGED
@@ -1,67 +1,92 @@
1
- import {
2
- convertToStandardError
3
- } from "./chunk-CCTAECMC.js";
4
-
5
1
  // src/constants.ts
6
- var ORPC_PROTOCOL_HEADER = "x-orpc-protocol";
7
- var ORPC_PROTOCOL_VALUE = "orpc";
2
+ var ORPC_HANDLER_HEADER = "x-orpc-handler";
3
+ var ORPC_HANDLER_VALUE = "orpc";
8
4
 
9
- // src/hook.ts
10
- async function executeWithHooks(options) {
11
- const executes = convertToArray(options.hooks?.execute);
12
- const onStarts = convertToArray(options.hooks?.onStart);
13
- const onSuccesses = convertToArray(options.hooks?.onSuccess);
14
- const onErrors = convertToArray(options.hooks?.onError);
15
- const onFinishes = convertToArray(options.hooks?.onFinish);
16
- let currentExecuteIndex = 0;
17
- const next = async () => {
18
- const execute = executes[currentExecuteIndex];
19
- if (execute) {
20
- currentExecuteIndex++;
21
- return await execute(options.input, options.context, {
22
- ...options.meta,
23
- next
24
- });
5
+ // src/error.ts
6
+ import { isPlainObject } from "is-what";
7
+ function toError(error) {
8
+ if (error instanceof Error) {
9
+ return error;
10
+ }
11
+ if (typeof error === "string") {
12
+ return new Error(error, { cause: error });
13
+ }
14
+ if (isPlainObject(error)) {
15
+ if ("message" in error && typeof error.message === "string") {
16
+ return new Error(error.message, { cause: error });
25
17
  }
26
- let state = { status: "pending", input: options.input, output: void 0, error: void 0 };
27
- try {
28
- for (const onStart of onStarts) {
29
- await onStart(state, options.context, options.meta);
30
- }
31
- const output = await options.execute();
32
- state = { status: "success", input: options.input, output, error: void 0 };
33
- for (let i = onSuccesses.length - 1; i >= 0; i--) {
34
- await onSuccesses[i](state, options.context, options.meta);
35
- }
36
- } catch (e) {
37
- state = { status: "error", input: options.input, error: convertToStandardError(e), output: void 0 };
38
- for (let i = onErrors.length - 1; i >= 0; i--) {
39
- try {
40
- await onErrors[i](state, options.context, options.meta);
41
- } catch (e2) {
42
- state = { status: "error", input: options.input, error: convertToStandardError(e2), output: void 0 };
43
- }
44
- }
18
+ if ("name" in error && typeof error.name === "string") {
19
+ return new Error(error.name, { cause: error });
45
20
  }
46
- for (let i = onFinishes.length - 1; i >= 0; i--) {
47
- try {
48
- await onFinishes[i](state, options.context, options.meta);
49
- } catch (e) {
50
- state = { status: "error", input: options.input, error: convertToStandardError(e), output: void 0 };
51
- }
21
+ }
22
+ return new Error("Unknown error", { cause: error });
23
+ }
24
+
25
+ // src/function.ts
26
+ function once(fn) {
27
+ let cached;
28
+ return () => {
29
+ if (cached) {
30
+ return cached.result;
52
31
  }
53
- if (state.status === "error") {
54
- throw state.error;
32
+ const result = fn();
33
+ cached = { result };
34
+ return result;
35
+ };
36
+ }
37
+
38
+ // src/interceptor.ts
39
+ function onStart(callback) {
40
+ return async (options, ...rest) => {
41
+ await callback(options, ...rest);
42
+ return await options.next();
43
+ };
44
+ }
45
+ function onSuccess(callback) {
46
+ return async (options, ...rest) => {
47
+ const result = await options.next();
48
+ await callback(result, options, ...rest);
49
+ return result;
50
+ };
51
+ }
52
+ function onError(callback) {
53
+ return async (options, ...rest) => {
54
+ try {
55
+ return await options.next();
56
+ } catch (error) {
57
+ await callback(error, options, ...rest);
58
+ throw error;
55
59
  }
56
- return state.output;
57
60
  };
58
- return await next();
59
61
  }
60
- function convertToArray(value2) {
61
- if (value2 === void 0) {
62
- return [];
63
- }
64
- return Array.isArray(value2) ? value2 : [value2];
62
+ function onFinish(callback) {
63
+ let state;
64
+ return async (options, ...rest) => {
65
+ try {
66
+ const result = await options.next();
67
+ state = [result, void 0, "success"];
68
+ return result;
69
+ } catch (error) {
70
+ state = [void 0, error, "error"];
71
+ throw error;
72
+ } finally {
73
+ await callback(state, options, ...rest);
74
+ }
75
+ };
76
+ }
77
+ async function intercept(interceptors, options, main) {
78
+ let index = 0;
79
+ const next = async (options2) => {
80
+ const interceptor = interceptors[index++];
81
+ if (!interceptor) {
82
+ return await main(options2);
83
+ }
84
+ return await interceptor({
85
+ ...options2,
86
+ next: (newOptions = options2) => next(newOptions)
87
+ });
88
+ };
89
+ return await next(options);
65
90
  }
66
91
 
67
92
  // src/json.ts
@@ -76,7 +101,7 @@ function parseJSONSafely(text) {
76
101
  }
77
102
 
78
103
  // src/object.ts
79
- import { isPlainObject } from "is-what";
104
+ import { isPlainObject as isPlainObject2 } from "is-what";
80
105
  function set(root, segments, value2) {
81
106
  const ref = { root };
82
107
  let currentRef = ref;
@@ -112,39 +137,82 @@ function findDeepMatches(check, payload, segments = [], maps = [], values = [])
112
137
  payload.forEach((v, i) => {
113
138
  findDeepMatches(check, v, [...segments, i], maps, values);
114
139
  });
115
- } else if (isPlainObject(payload)) {
140
+ } else if (isPlainObject2(payload)) {
116
141
  for (const key in payload) {
117
142
  findDeepMatches(check, payload[key], [...segments, key], maps, values);
118
143
  }
119
144
  }
120
145
  return { maps, values };
121
146
  }
147
+ function isObject(value2) {
148
+ if (!value2 || typeof value2 !== "object") {
149
+ return false;
150
+ }
151
+ const proto = Object.getPrototypeOf(value2);
152
+ return proto === Object.prototype || proto === null;
153
+ }
154
+
155
+ // src/proxy.ts
156
+ function createCallableObject(obj, handler) {
157
+ const proxy = new Proxy(handler, {
158
+ has(target, key) {
159
+ return Reflect.has(obj, key) || Reflect.has(target, key);
160
+ },
161
+ ownKeys(target) {
162
+ return Array.from(new Set(Reflect.ownKeys(obj).concat(...Reflect.ownKeys(target))));
163
+ },
164
+ get(target, key) {
165
+ if (!Reflect.has(target, key) || Reflect.has(obj, key)) {
166
+ return Reflect.get(obj, key);
167
+ }
168
+ return Reflect.get(target, key);
169
+ },
170
+ defineProperty(_, key, descriptor) {
171
+ return Reflect.defineProperty(obj, key, descriptor);
172
+ },
173
+ set(_, key, value2) {
174
+ return Reflect.set(obj, key, value2);
175
+ },
176
+ deleteProperty(target, key) {
177
+ return Reflect.deleteProperty(target, key) && Reflect.deleteProperty(obj, key);
178
+ }
179
+ });
180
+ return proxy;
181
+ }
122
182
 
123
183
  // src/value.ts
124
- function value(value2) {
184
+ function value(value2, ...args) {
125
185
  if (typeof value2 === "function") {
126
- return value2();
186
+ return value2(...args);
127
187
  }
128
188
  return value2;
129
189
  }
130
190
 
131
191
  // src/index.ts
132
- import { isPlainObject as isPlainObject2 } from "is-what";
133
- import { guard, mapEntries, mapValues, omit, trim } from "radash";
192
+ import { isPlainObject as isPlainObject3 } from "is-what";
193
+ import { group, guard, mapEntries, mapValues, omit, trim } from "radash";
134
194
  export {
135
- ORPC_PROTOCOL_HEADER,
136
- ORPC_PROTOCOL_VALUE,
137
- convertToArray,
138
- executeWithHooks,
195
+ ORPC_HANDLER_HEADER,
196
+ ORPC_HANDLER_VALUE,
197
+ createCallableObject,
139
198
  findDeepMatches,
140
199
  get,
200
+ group,
141
201
  guard,
142
- isPlainObject2 as isPlainObject,
202
+ intercept,
203
+ isObject,
204
+ isPlainObject3 as isPlainObject,
143
205
  mapEntries,
144
206
  mapValues,
145
207
  omit,
208
+ onError,
209
+ onFinish,
210
+ onStart,
211
+ onSuccess,
212
+ once,
146
213
  parseJSONSafely,
147
214
  set,
215
+ toError,
148
216
  trim,
149
217
  value
150
218
  };
@@ -0,0 +1,5 @@
1
+ import type { AnyFunction } from './function';
2
+ export type OmitChainMethodDeep<T extends object, K extends keyof any> = {
3
+ [P in keyof Omit<T, K>]: T[P] extends AnyFunction ? ((...args: Parameters<T[P]>) => OmitChainMethodDeep<ReturnType<T[P]>, K>) : T[P];
4
+ };
5
+ //# sourceMappingURL=chain.d.ts.map
@@ -1,3 +1,3 @@
1
- export declare const ORPC_PROTOCOL_HEADER = "x-orpc-protocol";
2
- export declare const ORPC_PROTOCOL_VALUE = "orpc";
1
+ export declare const ORPC_HANDLER_HEADER = "x-orpc-handler";
2
+ export declare const ORPC_HANDLER_VALUE = "orpc";
3
3
  //# sourceMappingURL=constants.d.ts.map
@@ -1,65 +1,2 @@
1
- import type { StandardSchemaV1 } from '@standard-schema/spec';
2
- export declare const ORPC_ERROR_CODE_STATUSES: {
3
- readonly BAD_REQUEST: 400;
4
- readonly UNAUTHORIZED: 401;
5
- readonly FORBIDDEN: 403;
6
- readonly NOT_FOUND: 404;
7
- readonly METHOD_NOT_SUPPORTED: 405;
8
- readonly NOT_ACCEPTABLE: 406;
9
- readonly TIMEOUT: 408;
10
- readonly CONFLICT: 409;
11
- readonly PRECONDITION_FAILED: 412;
12
- readonly PAYLOAD_TOO_LARGE: 413;
13
- readonly UNSUPPORTED_MEDIA_TYPE: 415;
14
- readonly UNPROCESSABLE_CONTENT: 422;
15
- readonly TOO_MANY_REQUESTS: 429;
16
- readonly CLIENT_CLOSED_REQUEST: 499;
17
- readonly INTERNAL_SERVER_ERROR: 500;
18
- readonly NOT_IMPLEMENTED: 501;
19
- readonly BAD_GATEWAY: 502;
20
- readonly SERVICE_UNAVAILABLE: 503;
21
- readonly GATEWAY_TIMEOUT: 504;
22
- };
23
- export type ORPCErrorCode = keyof typeof ORPC_ERROR_CODE_STATUSES;
24
- export interface ORPCErrorJSON<TCode extends ORPCErrorCode, TData> {
25
- code: TCode;
26
- status: number;
27
- message: string;
28
- data: TData;
29
- issues?: readonly StandardSchemaV1.Issue[];
30
- }
31
- export type ANY_ORPC_ERROR_JSON = ORPCErrorJSON<any, any>;
32
- export type WELL_ORPC_ERROR_JSON = ORPCErrorJSON<ORPCErrorCode, unknown>;
33
- export declare class ORPCError<TCode extends ORPCErrorCode, TData> extends Error {
34
- zz$oe: {
35
- code: TCode;
36
- status?: number;
37
- message?: string;
38
- cause?: unknown;
39
- issues?: readonly StandardSchemaV1.Issue[];
40
- } & (undefined extends TData ? {
41
- data?: TData;
42
- } : {
43
- data: TData;
44
- });
45
- constructor(zz$oe: {
46
- code: TCode;
47
- status?: number;
48
- message?: string;
49
- cause?: unknown;
50
- issues?: readonly StandardSchemaV1.Issue[];
51
- } & (undefined extends TData ? {
52
- data?: TData;
53
- } : {
54
- data: TData;
55
- }));
56
- get code(): TCode;
57
- get status(): number;
58
- get data(): TData;
59
- get issues(): readonly StandardSchemaV1.Issue[] | undefined;
60
- toJSON(): ORPCErrorJSON<TCode, TData>;
61
- static fromJSON(json: unknown): ORPCError<ORPCErrorCode, any> | undefined;
62
- }
63
- export type WELL_ORPC_ERROR = ORPCError<ORPCErrorCode, unknown>;
64
- export declare function convertToStandardError(error: unknown): Error;
1
+ export declare function toError(error: unknown): Error;
65
2
  //# sourceMappingURL=error.d.ts.map
@@ -1,2 +1,3 @@
1
1
  export type AnyFunction = (...args: any[]) => any;
2
+ export declare function once<T extends () => any>(fn: T): () => ReturnType<T>;
2
3
  //# sourceMappingURL=function.d.ts.map
@@ -1,10 +1,14 @@
1
+ export * from './chain';
1
2
  export * from './constants';
3
+ export * from './error';
2
4
  export * from './function';
3
- export * from './hook';
5
+ export * from './interceptor';
4
6
  export * from './json';
5
7
  export * from './object';
8
+ export * from './proxy';
9
+ export * from './types';
6
10
  export * from './value';
7
11
  export { isPlainObject } from 'is-what';
8
- export { guard, mapEntries, mapValues, omit, trim } from 'radash';
9
- export type * from 'type-fest';
12
+ export { group, guard, mapEntries, mapValues, omit, trim } from 'radash';
13
+ export type { IsEqual, IsNever, JsonValue, PartialDeep, Promisable } from 'type-fest';
10
14
  //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1,47 @@
1
+ import type { Promisable } from 'type-fest';
2
+ import type { AnyFunction } from './function';
3
+ export type InterceptableOptions = Record<string, any>;
4
+ export type InterceptorOptions<TOptions extends InterceptableOptions, TResult> = Omit<TOptions, 'next'> & {
5
+ next(options?: TOptions): Promise<TResult>;
6
+ };
7
+ export type Interceptor<TOptions extends InterceptableOptions, TResult, TError> = (options: InterceptorOptions<TOptions, TResult>) => Promise<TResult> & {
8
+ __error?: {
9
+ type: TError;
10
+ };
11
+ };
12
+ /**
13
+ * Can used for interceptors or middlewares
14
+ */
15
+ export declare function onStart<TOptions extends {
16
+ next(): any;
17
+ }, TRest extends any[]>(callback: NoInfer<(options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
18
+ /**
19
+ * Can used for interceptors or middlewares
20
+ */
21
+ export declare function onSuccess<TOptions extends {
22
+ next(): any;
23
+ }, TRest extends any[]>(callback: NoInfer<(result: Awaited<ReturnType<TOptions['next']>>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>>;
24
+ export type InferError<T extends AnyFunction> = T extends Interceptor<any, any, infer TError> ? TError : unknown;
25
+ /**
26
+ * Can used for interceptors or middlewares
27
+ */
28
+ export declare function onError<TError, TOptions extends {
29
+ next(): any;
30
+ }, TRest extends any[]>(callback: NoInfer<(error: TError, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>> & {
31
+ __error?: {
32
+ type: TError;
33
+ };
34
+ };
35
+ export type OnFinishState<TResult, TError> = [TResult, undefined, 'success'] | [undefined, TError, 'error'];
36
+ /**
37
+ * Can used for interceptors or middlewares
38
+ */
39
+ export declare function onFinish<TError, TOptions extends {
40
+ next(): any;
41
+ }, TRest extends any[]>(callback: NoInfer<(state: OnFinishState<Awaited<ReturnType<TOptions['next']>>, TError>, options: TOptions, ...rest: TRest) => Promisable<void>>): (options: TOptions, ...rest: TRest) => Promise<Awaited<ReturnType<TOptions['next']>>> & {
42
+ __error?: {
43
+ type: TError;
44
+ };
45
+ };
46
+ export declare function intercept<TOptions extends InterceptableOptions, TResult, TError>(interceptors: Interceptor<TOptions, TResult, TError>[], options: NoInfer<TOptions>, main: NoInfer<(options: TOptions) => Promisable<TResult>>): Promise<TResult>;
47
+ //# sourceMappingURL=interceptor.d.ts.map
@@ -1,8 +1,13 @@
1
1
  export type Segment = string | number;
2
- export declare function set(root: Readonly<Record<string, unknown> | unknown[]>, segments: Readonly<Segment[]>, value: unknown): unknown;
2
+ export declare function set(root: unknown, segments: Readonly<Segment[]>, value: unknown): unknown;
3
3
  export declare function get(root: Readonly<Record<string, unknown> | unknown[]>, segments: Readonly<Segment[]>): unknown;
4
4
  export declare function findDeepMatches(check: (value: unknown) => boolean, payload: unknown, segments?: Segment[], maps?: Segment[][], values?: unknown[]): {
5
5
  maps: Segment[][];
6
6
  values: unknown[];
7
7
  };
8
+ /**
9
+ * Check if the value is an object.
10
+ * Even object created by Object.create(null) is considered an object.
11
+ */
12
+ export declare function isObject(value: unknown): value is Record<string, unknown>;
8
13
  //# sourceMappingURL=object.d.ts.map
@@ -0,0 +1,3 @@
1
+ import type { AnyFunction } from './function';
2
+ export declare function createCallableObject<TObject extends object, THandler extends AnyFunction>(obj: TObject, handler: THandler): TObject & THandler;
3
+ //# sourceMappingURL=proxy.d.ts.map
@@ -0,0 +1,3 @@
1
+ export type MaybeOptionalOptions<TOptions> = [options: TOptions] | (Record<never, never> extends TOptions ? [] : never);
2
+ export type SetOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
3
+ //# sourceMappingURL=types.d.ts.map
@@ -1,4 +1,4 @@
1
1
  import type { Promisable } from 'type-fest';
2
- export type Value<T> = T | (() => Promisable<T>);
3
- export declare function value<T extends Value<any>>(value: T): Promise<T extends Value<infer U> ? U : never>;
2
+ export type Value<T, TArgs extends any[] = []> = T | ((...args: TArgs) => Promisable<T>);
3
+ export declare function value<T extends Value<any, TArgs>, TArgs extends any[] = []>(value: T, ...args: TArgs): Promise<T extends Value<infer U, any> ? U : never>;
4
4
  //# sourceMappingURL=value.d.ts.map
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@orpc/shared",
3
3
  "type": "module",
4
- "version": "0.0.0-next.10945d3",
4
+ "version": "0.0.0-next.172fe95",
5
5
  "license": "MIT",
6
6
  "homepage": "https://orpc.unnoq.com",
7
7
  "repository": {
@@ -19,11 +19,6 @@
19
19
  "import": "./dist/index.js",
20
20
  "default": "./dist/index.js"
21
21
  },
22
- "./error": {
23
- "types": "./dist/src/error.d.ts",
24
- "import": "./dist/error.js",
25
- "default": "./dist/error.js"
26
- },
27
22
  "./🔒/*": {
28
23
  "types": "./dist/src/*.d.ts"
29
24
  }
@@ -34,13 +29,12 @@
34
29
  "dist"
35
30
  ],
36
31
  "dependencies": {
37
- "@standard-schema/spec": "1.0.0-beta.4",
38
32
  "is-what": "^5.0.2",
39
33
  "radash": "^12.1.0",
40
34
  "type-fest": "^4.26.1"
41
35
  },
42
36
  "scripts": {
43
- "build": "tsup --clean --sourcemap --entry.index=src/index.ts --entry.error=src/error.ts --format=esm --onSuccess='tsc -b --noCheck'",
37
+ "build": "tsup --clean --sourcemap --entry.index=src/index.ts --format=esm --onSuccess='tsc -b --noCheck'",
44
38
  "build:watch": "pnpm run build --watch",
45
39
  "type:check": "tsc -b"
46
40
  }
@@ -1,88 +0,0 @@
1
- // src/error.ts
2
- var ORPC_ERROR_CODE_STATUSES = {
3
- BAD_REQUEST: 400,
4
- UNAUTHORIZED: 401,
5
- FORBIDDEN: 403,
6
- NOT_FOUND: 404,
7
- METHOD_NOT_SUPPORTED: 405,
8
- NOT_ACCEPTABLE: 406,
9
- TIMEOUT: 408,
10
- CONFLICT: 409,
11
- PRECONDITION_FAILED: 412,
12
- PAYLOAD_TOO_LARGE: 413,
13
- UNSUPPORTED_MEDIA_TYPE: 415,
14
- UNPROCESSABLE_CONTENT: 422,
15
- TOO_MANY_REQUESTS: 429,
16
- CLIENT_CLOSED_REQUEST: 499,
17
- INTERNAL_SERVER_ERROR: 500,
18
- NOT_IMPLEMENTED: 501,
19
- BAD_GATEWAY: 502,
20
- SERVICE_UNAVAILABLE: 503,
21
- GATEWAY_TIMEOUT: 504
22
- };
23
- var ORPCError = class _ORPCError extends Error {
24
- constructor(zz$oe) {
25
- if (zz$oe.status && (zz$oe.status < 400 || zz$oe.status >= 600)) {
26
- throw new Error("The ORPCError status code must be in the 400-599 range.");
27
- }
28
- super(zz$oe.message, { cause: zz$oe.cause });
29
- this.zz$oe = zz$oe;
30
- }
31
- get code() {
32
- return this.zz$oe.code;
33
- }
34
- get status() {
35
- return this.zz$oe.status ?? ORPC_ERROR_CODE_STATUSES[this.code];
36
- }
37
- get data() {
38
- return this.zz$oe.data;
39
- }
40
- get issues() {
41
- return this.zz$oe.issues;
42
- }
43
- toJSON() {
44
- return {
45
- code: this.code,
46
- status: this.status,
47
- message: this.message,
48
- data: this.data,
49
- issues: this.issues
50
- };
51
- }
52
- static fromJSON(json) {
53
- if (typeof json !== "object" || json === null || !("code" in json) || !Object.keys(ORPC_ERROR_CODE_STATUSES).find((key) => json.code === key) || !("status" in json) || typeof json.status !== "number" || "message" in json && json.message !== void 0 && typeof json.message !== "string" || "issues" in json && json.issues !== void 0 && !Array.isArray(json.issues)) {
54
- return void 0;
55
- }
56
- return new _ORPCError({
57
- code: json.code,
58
- status: json.status,
59
- message: json.message,
60
- data: json.data,
61
- issues: json.issues
62
- });
63
- }
64
- };
65
- function convertToStandardError(error) {
66
- if (error instanceof Error) {
67
- return error;
68
- }
69
- if (typeof error === "string") {
70
- return new Error(error, { cause: error });
71
- }
72
- if (typeof error === "object" && error !== null) {
73
- if ("message" in error && typeof error.message === "string") {
74
- return new Error(error.message, { cause: error });
75
- }
76
- if ("name" in error && typeof error.name === "string") {
77
- return new Error(error.name, { cause: error });
78
- }
79
- }
80
- return new Error("Unknown error", { cause: error });
81
- }
82
-
83
- export {
84
- ORPC_ERROR_CODE_STATUSES,
85
- ORPCError,
86
- convertToStandardError
87
- };
88
- //# sourceMappingURL=chunk-CCTAECMC.js.map
package/dist/error.js DELETED
@@ -1,11 +0,0 @@
1
- import {
2
- ORPCError,
3
- ORPC_ERROR_CODE_STATUSES,
4
- convertToStandardError
5
- } from "./chunk-CCTAECMC.js";
6
- export {
7
- ORPCError,
8
- ORPC_ERROR_CODE_STATUSES,
9
- convertToStandardError
10
- };
11
- //# sourceMappingURL=error.js.map
@@ -1,42 +0,0 @@
1
- import type { Arrayable, Promisable } from 'type-fest';
2
- export type OnStartState<TInput> = {
3
- status: 'pending';
4
- input: TInput;
5
- output: undefined;
6
- error: undefined;
7
- };
8
- export type OnSuccessState<TInput, TOutput> = {
9
- status: 'success';
10
- input: TInput;
11
- output: TOutput;
12
- error: undefined;
13
- };
14
- export type OnErrorState<TInput> = {
15
- status: 'error';
16
- input: TInput;
17
- output: undefined;
18
- error: Error;
19
- };
20
- export interface BaseHookMeta<TOutput> {
21
- next: () => Promise<TOutput>;
22
- }
23
- export interface Hooks<TInput, TOutput, TContext, TMeta extends (Record<string, any> & {
24
- next?: never;
25
- }) | undefined> {
26
- execute?: Arrayable<(input: TInput, context: TContext, meta: (TMeta extends undefined ? unknown : TMeta) & BaseHookMeta<TOutput>) => Promise<TOutput>>;
27
- onStart?: Arrayable<(state: OnStartState<TInput>, context: TContext, meta: TMeta) => Promisable<void>>;
28
- onSuccess?: Arrayable<(state: OnSuccessState<TInput, TOutput>, context: TContext, meta: TMeta) => Promisable<void>>;
29
- onError?: Arrayable<(state: OnErrorState<TInput>, context: TContext, meta: TMeta) => Promisable<void>>;
30
- onFinish?: Arrayable<(state: OnSuccessState<TInput, TOutput> | OnErrorState<TInput>, context: TContext, meta: TMeta) => Promisable<void>>;
31
- }
32
- export declare function executeWithHooks<TInput, TOutput, TContext, TMeta extends (Record<string, unknown> & {
33
- next?: never;
34
- }) | undefined>(options: {
35
- hooks?: Hooks<TInput, TOutput, TContext, TMeta>;
36
- input: TInput;
37
- context: TContext;
38
- meta: TMeta;
39
- execute: BaseHookMeta<TOutput>['next'];
40
- }): Promise<TOutput>;
41
- export declare function convertToArray<T>(value: undefined | T | readonly T[]): readonly T[];
42
- //# sourceMappingURL=hook.d.ts.map