@etohq/types 1.5.4-next.1 → 1.5.4-next.3
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/http/common/request.d.ts +17 -1
- package/dist/http/common/request.d.ts.map +1 -1
- package/dist/http/common/request.js +2 -0
- package/dist/http/common/request.js.map +1 -1
- package/dist/http/encore/encore.d.ts +3 -1
- package/dist/http/encore/encore.d.ts.map +1 -1
- package/dist/http/encore/encore.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { Header } from "../encore";
|
|
1
2
|
/**
|
|
2
3
|
* Generic type to modify a property of a base interface only if it exists.
|
|
3
4
|
* Makes the specified key required with the new type.
|
|
@@ -65,7 +66,22 @@ export type EtoRequest<Body = unknown> = Body;
|
|
|
65
66
|
/**
|
|
66
67
|
* Combines ModReqId and EtoRequest: ensures `id` is required string and merges with QueryFields.
|
|
67
68
|
*/
|
|
68
|
-
export type
|
|
69
|
+
export type EtoRequestWithHeaders<T extends object, H extends object> = T & H;
|
|
70
|
+
export type EtoRequestWithId<T extends object> = T & {
|
|
69
71
|
id: string;
|
|
70
72
|
};
|
|
73
|
+
export type EtoDraftHeader = {
|
|
74
|
+
draft_session_id?: Header<"X-Draft-Session-Id">;
|
|
75
|
+
};
|
|
76
|
+
export type EtoAuthHeader = {
|
|
77
|
+
authorization?: Header<"Authorization">;
|
|
78
|
+
};
|
|
79
|
+
export type EtoDraftReqIdRequest<T extends object> = EtoRequestWithId<EtoRequestWithHeaders<T, EtoDraftHeader>>;
|
|
80
|
+
export type EtoAuthReqIdRequest<T extends object> = EtoRequestWithId<EtoRequestWithHeaders<T, EtoAuthHeader>>;
|
|
81
|
+
export type EtoAuthDraftReqIdRequest<T extends object> = EtoRequestWithId<EtoRequestWithHeaders<T, EtoDraftHeader & EtoAuthHeader>>;
|
|
82
|
+
export type EtoReqIdRequest<T extends object> = EtoRequestWithId<T>;
|
|
83
|
+
export declare const DRAFT_SESSION_HEADER: "x-draft-session-id";
|
|
84
|
+
export type DraftSessionHeaders = {
|
|
85
|
+
[DRAFT_SESSION_HEADER]?: string | string[];
|
|
86
|
+
};
|
|
71
87
|
//# sourceMappingURL=request.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../src/http/common/request.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,IAAI;KAC7C,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACvC,CAAA;AAED,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB,CAAA;AACD;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,IAAI,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAEvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE;QACX,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;QACjB,UAAU,EAAE;YAEV,IAAI,CAAC,EAAE,MAAM,CAAA;YACb,IAAI,CAAC,EAAE,MAAM,CAAA;SACd,CAAA;KACF,CAAA;CACF,CAAA;AAED,MAAM,MAAM,UAAU,CAAC,IAAI,GAAG,OAAO,IAAI,IAAI,CAAA;AAE7C;;GAEG;AACH,MAAM,MAAM,
|
|
1
|
+
{"version":3,"file":"request.d.ts","sourceRoot":"","sources":["../../../src/http/common/request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAEvC;;;GAGG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,CAAC,EAAE,CAAC,IAAI;KAC7C,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;CACvC,CAAA;AAED,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;OAKG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,CAAC,EAAE,MAAM,EAAE,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB,CAAA;AACD;;;;GAIG;AACH,MAAM,MAAM,QAAQ,CAAC,CAAC,SAAS,MAAM,IAAI,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAEvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE;QACX,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;QACjB,UAAU,EAAE;YAEV,IAAI,CAAC,EAAE,MAAM,CAAA;YACb,IAAI,CAAC,EAAE,MAAM,CAAA;SACd,CAAA;KACF,CAAA;CACF,CAAA;AAED,MAAM,MAAM,UAAU,CAAC,IAAI,GAAG,OAAO,IAAI,IAAI,CAAA;AAE7C;;GAEG;AACH,MAAM,MAAM,qBAAqB,CAC/B,CAAC,SAAS,MAAM,EAChB,CAAC,SAAS,MAAM,IACd,CAAC,GAAG,CAAC,CAAA;AAET,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,GAAG;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,CAAA;AAEnE,MAAM,MAAM,cAAc,GAAG;IAC3B,gBAAgB,CAAC,EAAE,MAAM,CAAC,oBAAoB,CAAC,CAAA;CAChD,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC,CAAA;CACxC,CAAA;AAED,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,MAAM,IAAI,gBAAgB,CACnE,qBAAqB,CAAC,CAAC,EAAE,cAAc,CAAC,CACzC,CAAA;AAED,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,MAAM,IAAI,gBAAgB,CAClE,qBAAqB,CAAC,CAAC,EAAE,aAAa,CAAC,CACxC,CAAA;AAED,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,MAAM,IAAI,gBAAgB,CACvE,qBAAqB,CAAC,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC,CACzD,CAAA;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,MAAM,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAAA;AAEnE,eAAO,MAAM,oBAAoB,EAAG,oBAA6B,CAAA;AAEjE,MAAM,MAAM,mBAAmB,GAAG;IAChC,CAAC,oBAAoB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;CAC3C,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/http/common/request.ts"],"names":[],"mappings":""}
|
|
1
|
+
{"version":3,"file":"request.js","sourceRoot":"","sources":["../../../src/http/common/request.ts"],"names":[],"mappings":";;;AAwGa,QAAA,oBAAoB,GAAG,oBAA6B,CAAA"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { DraftSessionHeaders } from "../common/request";
|
|
1
2
|
/** Describes an API endpoint. */
|
|
2
3
|
/** Describes an API endpoint. */
|
|
3
4
|
export interface APIDesc {
|
|
@@ -13,6 +14,7 @@ export interface APIDesc {
|
|
|
13
14
|
tags: string[];
|
|
14
15
|
}
|
|
15
16
|
export type Method = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS" | "CONNECT" | "TRACE";
|
|
17
|
+
export type Header<TypeOrName extends string | number | boolean | Date = string, Name extends string = ""> = TypeOrName extends string ? string : TypeOrName;
|
|
16
18
|
/**
|
|
17
19
|
* List of all the supported HTTP methods
|
|
18
20
|
*/
|
|
@@ -52,7 +54,7 @@ export interface APICallMeta {
|
|
|
52
54
|
* The values are arrays if the header contains multiple values,
|
|
53
55
|
* either separated by ";" or when the header key appears more than once.
|
|
54
56
|
*/
|
|
55
|
-
headers: Record<string, string | string[]
|
|
57
|
+
headers: Record<string, string | string[]> & DraftSessionHeaders;
|
|
56
58
|
/**
|
|
57
59
|
* The parsed request payload, as expected by the application code.
|
|
58
60
|
* Not provided for raw endpoints or when the API endpoint expects no
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"encore.d.ts","sourceRoot":"","sources":["../../../src/http/encore/encore.ts"],"names":[],"mappings":"AACA,iCAAiC;AACjC,iCAAiC;AACjC,MAAM,WAAW,OAAO;IACtB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAEhB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IAEjB,8CAA8C;IAC9C,GAAG,EAAE,OAAO,CAAC;IAEb,0CAA0C;IAC1C,IAAI,EAAE,OAAO,CAAC;IAEd,sCAAsC;IACtC,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAGD,MAAM,MAAM,MAAM,GACd,KAAK,GACL,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,MAAM,GACN,SAAS,GACT,SAAS,GACT,OAAO,CAAA;
|
|
1
|
+
{"version":3,"file":"encore.d.ts","sourceRoot":"","sources":["../../../src/http/encore/encore.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAE5D,iCAAiC;AACjC,iCAAiC;AACjC,MAAM,WAAW,OAAO;IACtB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAEhB,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IAEjB,8CAA8C;IAC9C,GAAG,EAAE,OAAO,CAAC;IAEb,0CAA0C;IAC1C,IAAI,EAAE,OAAO,CAAC;IAEd,sCAAsC;IACtC,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAGD,MAAM,MAAM,MAAM,GACd,KAAK,GACL,MAAM,GACN,KAAK,GACL,OAAO,GACP,QAAQ,GACR,MAAM,GACN,SAAS,GACT,SAAS,GACT,OAAO,CAAA;AAEX,MAAM,MAAM,MAAM,CAChB,UAAU,SAAS,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,MAAM,EAC5D,IAAI,SAAS,MAAM,GAAG,EAAE,IACtB,UAAU,SAAS,MAAM,GAAG,MAAM,GAAG,UAAU,CAAA;AAGnD;;GAEG;AACH,eAAO,MAAM,YAAY,uEAQf,CAAA;AACR,MAAM,MAAM,SAAS,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAA;AACrD,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,KAAK,GAAG,SAAS,CAAA;AAExD,6CAA6C;AAC7C,MAAM,WAAW,WAAW;IAC1B,iDAAiD;IACjD,IAAI,EAAE,UAAU,CAAC;IAEjB,+CAA+C;IAC/C,GAAG,EAAE,OAAO,CAAC;IAEb,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEhC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,GAAG,mBAAmB,CAAC;IAEjE;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CACtC;AACD,mDAAmD;AACnD,MAAM,WAAW,iBAAiB;IAChC,uDAAuD;IACvD,IAAI,EAAE,gBAAgB,CAAA;IACtB,0CAA0C;IAC1C,OAAO,EAAE,MAAM,CAAA;IACf,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAA;IACb,4CAA4C;IAC5C,YAAY,EAAE,MAAM,CAAA;IACpB;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,eAAe,EAAE,MAAM,CAAA;IACvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACpC;AACD,mDAAmD;AACnD,MAAM,WAAW,SAAS;IACxB,oBAAoB;IACpB,OAAO,EAAE,MAAM,CAAA;IACf,2BAA2B;IAC3B,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;CAC1B;AACD,MAAM,WAAW,eAAe;IAC9B,kEAAkE;IAClE,KAAK,CAAC,EAAE,SAAS,CAAA;CAClB;AACD,gEAAgE;AAChE,MAAM,MAAM,WAAW,GAAG,CAAC,WAAW,GAAG,iBAAiB,CAAC,GAAG,eAAe,CAAA;AAC7E;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,cAAc,IAAI,WAAW,GAAG,SAAS,CAAA;AAKjE,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE;QACP;;;WAGG;QACH,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB;;;WAGG;QACH,IAAI,CAAC,EAAE,OAAO,CAAA;QACd;;WAEG;QACH,KAAK,CAAC,EAAE,OAAO,CAAA;QACf;;WAEG;QACH,QAAQ,CAAC,EAAE,OAAO,CAAA;QAClB;;;;WAIG;QACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAA;KAChB,CAAA;CACF;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,WAAW,GAAG,SAAS,CAAA;IACpC,MAAM,EAAE,GAAG,GAAG,SAAS,CAAA;IACvB,UAAU,EAAE,GAAG,GAAG,SAAS,CAAA;IAC3B,WAAW,EAAE,GAAG,GAAG,SAAS,CAAA;IAC5B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC1B,CAAA;AAGD,MAAM,MAAM,cAAc,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC1C,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IAChD,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;CACjD,CAAA;AACD,MAAM,MAAM,eAAe,GAAG;IAC5B;;;OAGG;IACH,OAAO,EAAE,GAAG,CAAA;IACZ;;;;OAIG;IACH,MAAM,EAAE,cAAc,CAAA;IACtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,oBAAoB,IAAI,GAAG,CAAA;CAC5B,CAAA;AACD,MAAM,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,eAAe,CAAC,CAAA;AACvE,MAAM,MAAM,YAAY,GAAG,CACzB,GAAG,EAAE,iBAAiB,EACtB,IAAI,EAAE,IAAI,KACP,OAAO,CAAC,eAAe,CAAC,CAAA;AAC7B,MAAM,WAAW,UAAW,SAAQ,YAAY;IAC9C,OAAO,CAAC,EAAE,iBAAiB,CAAA;CAC5B;AACD,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,CAAC,EAAE,YAAY,GAAG,UAAU,CAAA;AAC/D,MAAM,CAAC,OAAO,UAAU,UAAU,CAChC,OAAO,EAAE,iBAAiB,EAC1B,EAAE,EAAE,YAAY,GACf,UAAU,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"encore.js","sourceRoot":"","sources":["../../../src/http/encore/encore.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"encore.js","sourceRoot":"","sources":["../../../src/http/encore/encore.ts"],"names":[],"mappings":";;;AAwCA;;GAEG;AACU,QAAA,YAAY,GAAG;IAC1B,KAAK;IACL,MAAM;IACN,KAAK;IACL,OAAO;IACP,QAAQ;IACR,SAAS;IACT,MAAM;CACE,CAAA"}
|