@mapples/types 2.0.0 → 2.0.1-beta.20261101104526
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/CHANGELOG.md +7 -0
- package/dist/api.d.ts +28 -0
- package/dist/api.d.ts.map +1 -1
- package/dist/api.js +2 -0
- package/dist/api.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,12 @@
|
|
|
1
1
|
# @mapples/types
|
|
2
2
|
|
|
3
|
+
## 2.0.1-beta.20261101104526
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- cb10390: The canvas previews one saved data state at a time (Loading, Success, Error or All), can hide components it can't draw, calls the API only in Develop with Live data on, and keeps the sample when a live call fails. Adds ApiRequest.states and RequestProvider's sampleOnFailure and stateOverride.
|
|
8
|
+
- 7aa4590: ApiRequest.headerValues sends headers read when the request runs, such as a signed-in user's token.
|
|
9
|
+
|
|
3
10
|
## 2.0.0
|
|
4
11
|
|
|
5
12
|
### Major Changes
|
package/dist/api.d.ts
CHANGED
|
@@ -60,6 +60,21 @@ export interface ApiRequestAuth {
|
|
|
60
60
|
*/
|
|
61
61
|
secretRef?: string;
|
|
62
62
|
}
|
|
63
|
+
/**
|
|
64
|
+
* What a request previews with when nothing has really run: the data states an
|
|
65
|
+
* author or an agent saved for it.
|
|
66
|
+
*/
|
|
67
|
+
export interface ApiRequestStates {
|
|
68
|
+
/** The response body. Wins over {@link ApiRequest.responseSample}. */
|
|
69
|
+
success?: unknown;
|
|
70
|
+
/** The failure: its HTTP status and body. */
|
|
71
|
+
error?: {
|
|
72
|
+
status: number;
|
|
73
|
+
body: unknown;
|
|
74
|
+
};
|
|
75
|
+
/** What `data` holds while loading, for skeleton content. */
|
|
76
|
+
loading?: unknown;
|
|
77
|
+
}
|
|
63
78
|
export interface ApiRequest {
|
|
64
79
|
id: string;
|
|
65
80
|
/** Unique per document; doubles as the default state key suffix. */
|
|
@@ -76,6 +91,15 @@ export interface ApiRequest {
|
|
|
76
91
|
* string.
|
|
77
92
|
*/
|
|
78
93
|
params?: Record<string, ApiValueSource>;
|
|
94
|
+
/**
|
|
95
|
+
* Headers read when the request runs — a signed-in user's token from
|
|
96
|
+
* `api.signIn.data.access_token`. `prefix` goes in front (`Bearer `). A value
|
|
97
|
+
* that resolves to nothing leaves the header out; wins over {@link headers}.
|
|
98
|
+
*/
|
|
99
|
+
headerValues?: Record<string, {
|
|
100
|
+
source: ApiValueSource;
|
|
101
|
+
prefix?: string;
|
|
102
|
+
}>;
|
|
79
103
|
/** JSON body template; leaf values may be {@link ApiValueSource}s. */
|
|
80
104
|
body?: {
|
|
81
105
|
kind: 'json';
|
|
@@ -87,12 +111,16 @@ export interface ApiRequest {
|
|
|
87
111
|
* execution in the editor preview.
|
|
88
112
|
*/
|
|
89
113
|
responseSample?: unknown;
|
|
114
|
+
/** The request's saved data states; see {@link ApiRequestStates}. */
|
|
115
|
+
states?: ApiRequestStates;
|
|
90
116
|
/**
|
|
91
117
|
* State path the response lands under (`api.<name>` by default). Bindings
|
|
92
118
|
* read `<stateKey>.data`, `<stateKey>.loading`, `<stateKey>.error`.
|
|
93
119
|
*/
|
|
94
120
|
stateKey?: string;
|
|
95
121
|
}
|
|
122
|
+
/** The body a request previews with on success. */
|
|
123
|
+
export declare const apiRequestSuccessState: (request: Pick<ApiRequest, "states" | "responseSample">) => unknown;
|
|
96
124
|
export interface ApiDocument {
|
|
97
125
|
version: 1;
|
|
98
126
|
/** The environment used by the editor preview. */
|
package/dist/api.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,yEAAyE;AACzE,MAAM,MAAM,cAAc;AACxB,wBAAwB;AACtB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE;AACnC,gEAAgE;GAC9D;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE;AACrC;;;GAGG;GACD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE;AAClC;;;;;;;GAOG;GACD;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpC,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAErE,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,gEAAgE;IAChE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACnC,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACxC,sEAAsE;IACtE,IAAI,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC;IAC3C,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,CAAC,CAAC;IACX,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CACtC;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC,oEAAoE;AACpE,eAAO,MAAM,kBAAkB,GAAI,SAAS,UAAU,KAAG,MACD,CAAC"}
|
|
1
|
+
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,yEAAyE;AACzE,MAAM,MAAM,cAAc;AACxB,wBAAwB;AACtB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE;AACnC,gEAAgE;GAC9D;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE;AACrC;;;GAGG;GACD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE;AAClC;;;;;;;GAOG;GACD;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpC,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAErE,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,MAAM,CAAC;IACX,wCAAwC;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,OAAO,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,gEAAgE;IAChE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACnC,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B,sEAAsE;IACtE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,6CAA6C;IAC7C,KAAK,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,CAAC;IAC1C,6DAA6D;IAC7D,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,oEAAoE;IACpE,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,UAAU,CAAC;IACnB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IACxC;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,MAAM,EAAE,cAAc,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC3E,sEAAsE;IACtE,IAAI,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,OAAO,CAAA;KAAE,CAAC;IAC3C,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,qEAAqE;IACrE,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,mDAAmD;AACnD,eAAO,MAAM,sBAAsB,GACjC,SAAS,IAAI,CAAC,UAAU,EAAE,QAAQ,GAAG,gBAAgB,CAAC,KACrD,OAA4D,CAAC;AAEhE,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,CAAC,CAAC;IACX,kDAAkD;IAClD,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC7C,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;CACtC;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAQ,CAAC;AAEnC,oEAAoE;AACpE,eAAO,MAAM,kBAAkB,GAAI,SAAS,UAAU,KAAG,MACD,CAAC"}
|
package/dist/api.js
CHANGED
|
@@ -6,6 +6,8 @@
|
|
|
6
6
|
* Persisted as one opaque row per project (mirroring the navigation
|
|
7
7
|
* document); validated client-side by `validateApiDocument`.
|
|
8
8
|
*/
|
|
9
|
+
/** The body a request previews with on success. */
|
|
10
|
+
export const apiRequestSuccessState = (request) => request.states?.success ?? request.responseSample;
|
|
9
11
|
/**
|
|
10
12
|
* Root of every request state key. Responses live in their own context, which
|
|
11
13
|
* scope providers (a frame's data state, a list row) never shadow, so
|
package/dist/api.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;
|
|
1
|
+
{"version":3,"file":"api.js","sourceRoot":"","sources":["../src/api.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAoGH,mDAAmD;AACnD,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,OAAsD,EAC7C,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,IAAI,OAAO,CAAC,cAAc,CAAC;AAUhE;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,KAAK,CAAC;AAEnC,oEAAoE;AACpE,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,OAAmB,EAAU,EAAE,CAChE,OAAO,CAAC,QAAQ,IAAI,GAAG,aAAa,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC"}
|