@dropins/tools 0.23.0-alpha36 → 0.23.0-alpha38
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/package.json +1 -1
- package/types.d.ts +242 -0
- package/typing/elsie/src/lib/initializer.d.ts.map +1 -0
- package/typing/event-bus/src/index.d.ts +51 -0
- package/typing/event-bus/src/index.d.ts.map +1 -0
- package/typing/fetch-graphql/src/index.d.ts +105 -0
- package/typing/fetch-graphql/src/index.d.ts.map +1 -0
- package/typing/components/Icon.d.ts +0 -1
- package/typing/components/UIProvider.d.ts +0 -1
- package/typing/event-bus.d.ts +0 -4
- package/typing/fetch-graphql.d.ts +0 -4
- package/typing/initializer.d.ts +0 -4
- package/typing/lib/initializer.d.ts.map +0 -1
- package/typing/preact-compat.d.ts +0 -1
- package/typing/preact-hooks.d.ts +0 -1
- package/typing/preact-jsx-runtime.d.ts +0 -1
- package/typing/preact.d.ts +0 -1
- /package/typing/{lib → elsie/src/lib}/initializer.d.ts +0 -0
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name": "@dropins/tools", "version": "0.23.0-
|
|
1
|
+
{"name": "@dropins/tools", "version": "0.23.0-alpha38"}
|
package/types.d.ts
ADDED
|
@@ -0,0 +1,242 @@
|
|
|
1
|
+
declare module '@dropins/tools/initializer.js'{
|
|
2
|
+
import { Config } from '.';
|
|
3
|
+
|
|
4
|
+
type Listener = {
|
|
5
|
+
off(): void;
|
|
6
|
+
};
|
|
7
|
+
type Listeners<T> = (config?: T) => Array<Listener | undefined>;
|
|
8
|
+
type Init<T> = (config?: T) => Promise<void>;
|
|
9
|
+
type Options<T> = {
|
|
10
|
+
init: Init<T>;
|
|
11
|
+
listeners: Listeners<T>;
|
|
12
|
+
};
|
|
13
|
+
/**
|
|
14
|
+
* `Initializer` is a class that represents an initializer.
|
|
15
|
+
* An initializer is responsible for setting up event listeners and initializing a module.
|
|
16
|
+
*
|
|
17
|
+
* @class
|
|
18
|
+
*
|
|
19
|
+
* @property {Function} listeners - A method that accepts a config object and returns an array of listeners.
|
|
20
|
+
* @property {Function} init - A method that initializes the module. It accepts an options object.
|
|
21
|
+
* @property {Config} config - A Config object that stores the configuration for the module.
|
|
22
|
+
*
|
|
23
|
+
* @method constructor - Constructs a new Initializer. Accepts an options object with `init` and `listeners` properties.
|
|
24
|
+
*/
|
|
25
|
+
export declare class Initializer<T> {
|
|
26
|
+
private _listeners;
|
|
27
|
+
listeners: Listeners<T>;
|
|
28
|
+
init: Init<T>;
|
|
29
|
+
config: Config<T>;
|
|
30
|
+
/**
|
|
31
|
+
* Constructs a new Initializer.
|
|
32
|
+
*
|
|
33
|
+
* @param {Object} options - The options for the Initializer.
|
|
34
|
+
* @param {Function} options.listeners - A function that accepts a config object and returns an array of listeners.
|
|
35
|
+
* @param {Function} options.init - A function that initializes the module. It accepts an options object.
|
|
36
|
+
*/
|
|
37
|
+
constructor({ init, listeners }: Options<T>);
|
|
38
|
+
}
|
|
39
|
+
type Initializers = [Initializer<any>, {
|
|
40
|
+
[key: string]: any;
|
|
41
|
+
} | undefined][];
|
|
42
|
+
/**
|
|
43
|
+
* Class representing initializerss.
|
|
44
|
+
*
|
|
45
|
+
* @class
|
|
46
|
+
*
|
|
47
|
+
* @method register - Registers a new initializer. If the initializers have already been mounted, it also immediately binds the event listeners and initializes the API for the new initializer.
|
|
48
|
+
* @method mount - Mounts all registered initializers. This involves binding the event listeners and initializing the APIs for each initializer, in that order.
|
|
49
|
+
* @method setImageParamKeys - Sets the image parameter keys. These keys are used when initializing the APIs for the initializers.
|
|
50
|
+
*/
|
|
51
|
+
export declare class initializers {
|
|
52
|
+
static _initializers: Initializers;
|
|
53
|
+
static _mounted: boolean;
|
|
54
|
+
static _imageParamsKeyMap: {
|
|
55
|
+
[key: string]: string;
|
|
56
|
+
} | undefined;
|
|
57
|
+
/**
|
|
58
|
+
* Registers a new initializer.
|
|
59
|
+
*
|
|
60
|
+
* @param {Initializer<any>} initializer - The initializer to register. This should be an object with `listeners` and `init` methods.
|
|
61
|
+
* @param {Object.<string, any>} [options] - An optional object with additional options. These options are passed to the `listeners` and `init` methods of the initializer.
|
|
62
|
+
*/
|
|
63
|
+
static register(initializer: Initializer<any>, options?: {
|
|
64
|
+
[key: string]: any;
|
|
65
|
+
}): void;
|
|
66
|
+
/**
|
|
67
|
+
* Mounts all registered initializers.
|
|
68
|
+
*
|
|
69
|
+
* @returns {void}
|
|
70
|
+
*/
|
|
71
|
+
static mount(): void;
|
|
72
|
+
/**
|
|
73
|
+
* Sets the image parameter keys.
|
|
74
|
+
*
|
|
75
|
+
* @param {Object.<string, any>} params - An object mapping keys to values.
|
|
76
|
+
* @returns {void}
|
|
77
|
+
*/
|
|
78
|
+
static setImageParamKeys(params: {
|
|
79
|
+
[key: string]: any;
|
|
80
|
+
}): void;
|
|
81
|
+
}
|
|
82
|
+
export {};
|
|
83
|
+
//# sourceMappingURL=initializer.d.ts.map
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
declare module '@dropins/tools/event-bus.js'{
|
|
87
|
+
import { Events } from './events-catalog';
|
|
88
|
+
|
|
89
|
+
export * from './events-catalog';
|
|
90
|
+
/**
|
|
91
|
+
* `events` is a class that provides static methods for event handling.
|
|
92
|
+
*
|
|
93
|
+
* @class
|
|
94
|
+
* @extends {Events}
|
|
95
|
+
*
|
|
96
|
+
* @property {Function} on - Subscribes to an event. Accepts an event name, a handler function, and an optional options object.
|
|
97
|
+
* @property {Function} emit - Emits an event. Accepts an event name and a payload.
|
|
98
|
+
* @property {Function} enableLogger - Enables or disables logging of events. Accepts a boolean.
|
|
99
|
+
*/
|
|
100
|
+
export declare class events {
|
|
101
|
+
static _identifier: string;
|
|
102
|
+
static _logger: BroadcastChannel | null;
|
|
103
|
+
static _lastEvent: {
|
|
104
|
+
[key: string]: {
|
|
105
|
+
payload: any;
|
|
106
|
+
};
|
|
107
|
+
};
|
|
108
|
+
/**
|
|
109
|
+
* Subscribes to an event.
|
|
110
|
+
*
|
|
111
|
+
* @param {string} event - The name of the event to subscribe to.
|
|
112
|
+
* @param {Function} handler - The function to call when the event is emitted.
|
|
113
|
+
* @param {Object} [options] - An optional object with additional options.
|
|
114
|
+
* @param {boolean} [options.eager] - If true, the handler will be called immediately with the last emitted event.
|
|
115
|
+
*/
|
|
116
|
+
static on<K extends keyof Events>(event: K, handler: (payload: Events[K]) => void, options?: {
|
|
117
|
+
eager?: boolean;
|
|
118
|
+
}): {
|
|
119
|
+
off(): void;
|
|
120
|
+
} | undefined;
|
|
121
|
+
/**
|
|
122
|
+
* Emits an event.
|
|
123
|
+
*
|
|
124
|
+
* @param {string} event - The name of the event to emit.
|
|
125
|
+
* @param {*} payload - The data to send with the event.
|
|
126
|
+
*/
|
|
127
|
+
static emit<K extends keyof Events>(event: K, payload: Events[K]): void;
|
|
128
|
+
/**
|
|
129
|
+
* Enables or disables logging of events.
|
|
130
|
+
*
|
|
131
|
+
* @param {boolean} enabled - If true, events will be logged to the console.
|
|
132
|
+
*/
|
|
133
|
+
static enableLogger(enabled: boolean): void;
|
|
134
|
+
}
|
|
135
|
+
//# sourceMappingURL=index.d.ts.map
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
declare module '@dropins/tools/fetch-graphql.js'{
|
|
139
|
+
/**
|
|
140
|
+
* @typedef {Object} Header
|
|
141
|
+
* @property {string|null} key - The header name and value.
|
|
142
|
+
*/
|
|
143
|
+
export type Header = {
|
|
144
|
+
[key: string]: string | null;
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* Type representing options for a fetch request.
|
|
148
|
+
* @typedef {Object} FetchOptions
|
|
149
|
+
* @property {'GET'|'POST'} [method] - The HTTP method to use for the request.
|
|
150
|
+
* @property {Object} [variables] - Variables to include in the request.
|
|
151
|
+
* @property {AbortSignal} [signal] - An AbortSignal to cancel the request.
|
|
152
|
+
* @property {'default'|'no-store'|'reload'|'no-cache'|'force-cache'|'only-if-cached'} [cache] - The cache mode to use for the request.
|
|
153
|
+
*/
|
|
154
|
+
export type FetchOptions = {
|
|
155
|
+
method?: 'GET' | 'POST';
|
|
156
|
+
variables?: {
|
|
157
|
+
[key: string]: any;
|
|
158
|
+
};
|
|
159
|
+
signal?: AbortSignal;
|
|
160
|
+
cache?: 'default' | 'no-store' | 'reload' | 'no-cache' | 'force-cache' | 'only-if-cached';
|
|
161
|
+
};
|
|
162
|
+
/**
|
|
163
|
+
* Represents an array of error objects that might be returned from a fetch query.
|
|
164
|
+
* Each error object contains a message and extensions with a category.
|
|
165
|
+
*
|
|
166
|
+
* @typedef {Object} FetchQueryError
|
|
167
|
+
* @property {string} message - The error message.
|
|
168
|
+
* @property {Object} extensions - Additional error information.
|
|
169
|
+
* @property {string} extensions.category - The category of the error.
|
|
170
|
+
*/
|
|
171
|
+
export type FetchQueryError = Array<{
|
|
172
|
+
message: string;
|
|
173
|
+
extensions: {
|
|
174
|
+
category: string;
|
|
175
|
+
};
|
|
176
|
+
}>;
|
|
177
|
+
declare class FetchGraphQLMesh {
|
|
178
|
+
_endpoint?: string;
|
|
179
|
+
get endpoint(): string | undefined;
|
|
180
|
+
get fetchGraphQlHeaders(): Header | undefined;
|
|
181
|
+
_fetchGraphQlHeaders: Header | undefined;
|
|
182
|
+
setEndpoint(endpoint: string): void;
|
|
183
|
+
setFetchGraphQlHeader(key: string, value: string | null): void;
|
|
184
|
+
removeFetchGraphQlHeader(key: string): void;
|
|
185
|
+
setFetchGraphQlHeaders(header: Header): void;
|
|
186
|
+
fetchGraphQl<T = any>(query: string, options?: FetchOptions): Promise<{
|
|
187
|
+
errors?: FetchQueryError;
|
|
188
|
+
data: T;
|
|
189
|
+
}>;
|
|
190
|
+
getConfig(): {
|
|
191
|
+
endpoint: string | undefined;
|
|
192
|
+
fetchGraphQlHeaders: Header | undefined;
|
|
193
|
+
};
|
|
194
|
+
getMethods(): {
|
|
195
|
+
setEndpoint: (endpoint: string) => void;
|
|
196
|
+
setFetchGraphQlHeader: (key: string, value: string | null) => void;
|
|
197
|
+
removeFetchGraphQlHeader: (key: string) => void;
|
|
198
|
+
setFetchGraphQlHeaders: (header: Header) => void;
|
|
199
|
+
fetchGraphQl: <T = any>(query: string, options?: FetchOptions | undefined) => Promise<{
|
|
200
|
+
errors?: FetchQueryError | undefined;
|
|
201
|
+
data: T;
|
|
202
|
+
}>;
|
|
203
|
+
getConfig: () => {
|
|
204
|
+
endpoint: string | undefined;
|
|
205
|
+
fetchGraphQlHeaders: Header | undefined;
|
|
206
|
+
};
|
|
207
|
+
};
|
|
208
|
+
}
|
|
209
|
+
/**
|
|
210
|
+
* `FetchGraphQL` is a class that extends `FetchGraphQLMesh`. It provides methods to get the GraphQL endpoint and headers.
|
|
211
|
+
*
|
|
212
|
+
* @property {string} endpoint - Gets the GraphQL endpoint. If `_endpoint` is not defined, it will return the `mesh.endpoint`.
|
|
213
|
+
* @property {Object} fetchGraphQlHeaders - Gets the GraphQL headers. If `_endpoint` is defined, it will return `_fetchGraphQlHeaders`.
|
|
214
|
+
* Otherwise, it will return a combination of `_fetchGraphQlHeaders` and `mesh.fetchGraphQlHeaders`.
|
|
215
|
+
* If neither is defined, it will return an empty object.
|
|
216
|
+
*
|
|
217
|
+
* @extends FetchGraphQLMesh
|
|
218
|
+
*/
|
|
219
|
+
export declare class FetchGraphQL extends FetchGraphQLMesh {
|
|
220
|
+
get endpoint(): string | undefined;
|
|
221
|
+
get fetchGraphQlHeaders(): Header;
|
|
222
|
+
}
|
|
223
|
+
/**
|
|
224
|
+
* Exports several methods from the `mesh` object.
|
|
225
|
+
*
|
|
226
|
+
* @property {Function} setEndpoint - Sets the GraphQL endpoint. Accepts a string as parameter.
|
|
227
|
+
* @property {Function} setFetchGraphQlHeaders - Sets the GraphQL headers. Accepts an object of headers as parameter.
|
|
228
|
+
* @property {Function} setFetchGraphQlHeader - Sets a specific GraphQL header. Accepts a key-value pair as parameters.
|
|
229
|
+
* @property {Function} removeFetchGraphQlHeader - Removes a specific GraphQL header. Accepts the key of the header as parameter.
|
|
230
|
+
* @property {Function} fetchGraphQl - Fetches GraphQL data. Accepts a query string and an optional options object as parameters. Returns a promise that resolves with the fetched data.
|
|
231
|
+
* @property {Function} getConfig - Gets the configuration. Returns an object with the endpoint and GraphQL headers.
|
|
232
|
+
*/
|
|
233
|
+
export declare const setEndpoint: (endpoint: string) => void, setFetchGraphQlHeaders: (header: Header) => void, setFetchGraphQlHeader: (key: string, value: string | null) => void, removeFetchGraphQlHeader: (key: string) => void, fetchGraphQl: <T = any>(query: string, options?: FetchOptions) => Promise<{
|
|
234
|
+
errors?: FetchQueryError | undefined;
|
|
235
|
+
data: T;
|
|
236
|
+
}>, getConfig: () => {
|
|
237
|
+
endpoint: string | undefined;
|
|
238
|
+
fetchGraphQlHeaders: Header | undefined;
|
|
239
|
+
};
|
|
240
|
+
export {};
|
|
241
|
+
//# sourceMappingURL=index.d.ts.map
|
|
242
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"initializer.d.ts","sourceRoot":"","sources":["../../../../../src/lib/initializer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAwB,MAAM,kBAAkB,CAAC;AAEhE,KAAK,QAAQ,GAAG;IAAE,GAAG,IAAI,IAAI,CAAA;CAAE,CAAC;AAEhC,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;AAEhE,KAAK,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE7C,KAAK,OAAO,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;CAAE,CAAC;AAE7D;;;;;;;;;;;GAWG;AACH,qBAAa,WAAW,CAAC,CAAC;IACxB,OAAO,CAAC,UAAU,CAAkB;IACpC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACd,MAAM,YAA4B;IAElC;;;;;;OAMG;gBACS,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;CAe5C;AAED,KAAK,YAAY,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,GAAG,SAAS,CAAC,EAAE,CAAC;AAE7E;;;;;;;;GAQG;AACH,qBAAa,YAAY;IACvB,MAAM,CAAC,aAAa,EAAE,YAAY,CAAM;IACxC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAS;IACjC,MAAM,CAAC,kBAAkB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,SAAS,CAAa;IAE7E;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CACb,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,EAC7B,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IASlC;;;;OAIG;IACH,MAAM,CAAC,KAAK;IAgBZ;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;CAGxD"}
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
declare module '@dropins/tools/event-bus.js'{
|
|
2
|
+
import { Events } from './events-catalog';
|
|
3
|
+
|
|
4
|
+
export * from './events-catalog';
|
|
5
|
+
/**
|
|
6
|
+
* `events` is a class that provides static methods for event handling.
|
|
7
|
+
*
|
|
8
|
+
* @class
|
|
9
|
+
* @extends {Events}
|
|
10
|
+
*
|
|
11
|
+
* @property {Function} on - Subscribes to an event. Accepts an event name, a handler function, and an optional options object.
|
|
12
|
+
* @property {Function} emit - Emits an event. Accepts an event name and a payload.
|
|
13
|
+
* @property {Function} enableLogger - Enables or disables logging of events. Accepts a boolean.
|
|
14
|
+
*/
|
|
15
|
+
export declare class events {
|
|
16
|
+
static _identifier: string;
|
|
17
|
+
static _logger: BroadcastChannel | null;
|
|
18
|
+
static _lastEvent: {
|
|
19
|
+
[key: string]: {
|
|
20
|
+
payload: any;
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* Subscribes to an event.
|
|
25
|
+
*
|
|
26
|
+
* @param {string} event - The name of the event to subscribe to.
|
|
27
|
+
* @param {Function} handler - The function to call when the event is emitted.
|
|
28
|
+
* @param {Object} [options] - An optional object with additional options.
|
|
29
|
+
* @param {boolean} [options.eager] - If true, the handler will be called immediately with the last emitted event.
|
|
30
|
+
*/
|
|
31
|
+
static on<K extends keyof Events>(event: K, handler: (payload: Events[K]) => void, options?: {
|
|
32
|
+
eager?: boolean;
|
|
33
|
+
}): {
|
|
34
|
+
off(): void;
|
|
35
|
+
} | undefined;
|
|
36
|
+
/**
|
|
37
|
+
* Emits an event.
|
|
38
|
+
*
|
|
39
|
+
* @param {string} event - The name of the event to emit.
|
|
40
|
+
* @param {*} payload - The data to send with the event.
|
|
41
|
+
*/
|
|
42
|
+
static emit<K extends keyof Events>(event: K, payload: Events[K]): void;
|
|
43
|
+
/**
|
|
44
|
+
* Enables or disables logging of events.
|
|
45
|
+
*
|
|
46
|
+
* @param {boolean} enabled - If true, events will be logged to the console.
|
|
47
|
+
*/
|
|
48
|
+
static enableLogger(enabled: boolean): void;
|
|
49
|
+
}
|
|
50
|
+
//# sourceMappingURL=index.d.ts.map
|
|
51
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../event-bus/src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,cAAc,kBAAkB,CAAC;AAIjC;;;;;;;;;GASG;AACH,qBAAa,MAAM;IACjB,MAAM,CAAC,WAAW,SAAQ;IAE1B,MAAM,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAQ;IAE/C,MAAM,CAAC,UAAU,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG;YAAE,OAAO,EAAE,GAAG,CAAA;SAAE,CAAA;KAAE,CAAM;IAC5D;;;;;;;OAOG;IACH,MAAM,CAAC,EAAE,CAAC,CAAC,SAAS,MAAM,MAAM,EAC9B,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,EACrC,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE;;;IAoC/B;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,CAAC,SAAS,MAAM,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAehE;;;;OAIG;IACH,MAAM,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO;CA0BrC"}
|
|
@@ -0,0 +1,105 @@
|
|
|
1
|
+
declare module '@dropins/tools/fetch-graphql.js'{
|
|
2
|
+
/**
|
|
3
|
+
* @typedef {Object} Header
|
|
4
|
+
* @property {string|null} key - The header name and value.
|
|
5
|
+
*/
|
|
6
|
+
export type Header = {
|
|
7
|
+
[key: string]: string | null;
|
|
8
|
+
};
|
|
9
|
+
/**
|
|
10
|
+
* Type representing options for a fetch request.
|
|
11
|
+
* @typedef {Object} FetchOptions
|
|
12
|
+
* @property {'GET'|'POST'} [method] - The HTTP method to use for the request.
|
|
13
|
+
* @property {Object} [variables] - Variables to include in the request.
|
|
14
|
+
* @property {AbortSignal} [signal] - An AbortSignal to cancel the request.
|
|
15
|
+
* @property {'default'|'no-store'|'reload'|'no-cache'|'force-cache'|'only-if-cached'} [cache] - The cache mode to use for the request.
|
|
16
|
+
*/
|
|
17
|
+
export type FetchOptions = {
|
|
18
|
+
method?: 'GET' | 'POST';
|
|
19
|
+
variables?: {
|
|
20
|
+
[key: string]: any;
|
|
21
|
+
};
|
|
22
|
+
signal?: AbortSignal;
|
|
23
|
+
cache?: 'default' | 'no-store' | 'reload' | 'no-cache' | 'force-cache' | 'only-if-cached';
|
|
24
|
+
};
|
|
25
|
+
/**
|
|
26
|
+
* Represents an array of error objects that might be returned from a fetch query.
|
|
27
|
+
* Each error object contains a message and extensions with a category.
|
|
28
|
+
*
|
|
29
|
+
* @typedef {Object} FetchQueryError
|
|
30
|
+
* @property {string} message - The error message.
|
|
31
|
+
* @property {Object} extensions - Additional error information.
|
|
32
|
+
* @property {string} extensions.category - The category of the error.
|
|
33
|
+
*/
|
|
34
|
+
export type FetchQueryError = Array<{
|
|
35
|
+
message: string;
|
|
36
|
+
extensions: {
|
|
37
|
+
category: string;
|
|
38
|
+
};
|
|
39
|
+
}>;
|
|
40
|
+
declare class FetchGraphQLMesh {
|
|
41
|
+
_endpoint?: string;
|
|
42
|
+
get endpoint(): string | undefined;
|
|
43
|
+
get fetchGraphQlHeaders(): Header | undefined;
|
|
44
|
+
_fetchGraphQlHeaders: Header | undefined;
|
|
45
|
+
setEndpoint(endpoint: string): void;
|
|
46
|
+
setFetchGraphQlHeader(key: string, value: string | null): void;
|
|
47
|
+
removeFetchGraphQlHeader(key: string): void;
|
|
48
|
+
setFetchGraphQlHeaders(header: Header): void;
|
|
49
|
+
fetchGraphQl<T = any>(query: string, options?: FetchOptions): Promise<{
|
|
50
|
+
errors?: FetchQueryError;
|
|
51
|
+
data: T;
|
|
52
|
+
}>;
|
|
53
|
+
getConfig(): {
|
|
54
|
+
endpoint: string | undefined;
|
|
55
|
+
fetchGraphQlHeaders: Header | undefined;
|
|
56
|
+
};
|
|
57
|
+
getMethods(): {
|
|
58
|
+
setEndpoint: (endpoint: string) => void;
|
|
59
|
+
setFetchGraphQlHeader: (key: string, value: string | null) => void;
|
|
60
|
+
removeFetchGraphQlHeader: (key: string) => void;
|
|
61
|
+
setFetchGraphQlHeaders: (header: Header) => void;
|
|
62
|
+
fetchGraphQl: <T = any>(query: string, options?: FetchOptions | undefined) => Promise<{
|
|
63
|
+
errors?: FetchQueryError | undefined;
|
|
64
|
+
data: T;
|
|
65
|
+
}>;
|
|
66
|
+
getConfig: () => {
|
|
67
|
+
endpoint: string | undefined;
|
|
68
|
+
fetchGraphQlHeaders: Header | undefined;
|
|
69
|
+
};
|
|
70
|
+
};
|
|
71
|
+
}
|
|
72
|
+
/**
|
|
73
|
+
* `FetchGraphQL` is a class that extends `FetchGraphQLMesh`. It provides methods to get the GraphQL endpoint and headers.
|
|
74
|
+
*
|
|
75
|
+
* @property {string} endpoint - Gets the GraphQL endpoint. If `_endpoint` is not defined, it will return the `mesh.endpoint`.
|
|
76
|
+
* @property {Object} fetchGraphQlHeaders - Gets the GraphQL headers. If `_endpoint` is defined, it will return `_fetchGraphQlHeaders`.
|
|
77
|
+
* Otherwise, it will return a combination of `_fetchGraphQlHeaders` and `mesh.fetchGraphQlHeaders`.
|
|
78
|
+
* If neither is defined, it will return an empty object.
|
|
79
|
+
*
|
|
80
|
+
* @extends FetchGraphQLMesh
|
|
81
|
+
*/
|
|
82
|
+
export declare class FetchGraphQL extends FetchGraphQLMesh {
|
|
83
|
+
get endpoint(): string | undefined;
|
|
84
|
+
get fetchGraphQlHeaders(): Header;
|
|
85
|
+
}
|
|
86
|
+
/**
|
|
87
|
+
* Exports several methods from the `mesh` object.
|
|
88
|
+
*
|
|
89
|
+
* @property {Function} setEndpoint - Sets the GraphQL endpoint. Accepts a string as parameter.
|
|
90
|
+
* @property {Function} setFetchGraphQlHeaders - Sets the GraphQL headers. Accepts an object of headers as parameter.
|
|
91
|
+
* @property {Function} setFetchGraphQlHeader - Sets a specific GraphQL header. Accepts a key-value pair as parameters.
|
|
92
|
+
* @property {Function} removeFetchGraphQlHeader - Removes a specific GraphQL header. Accepts the key of the header as parameter.
|
|
93
|
+
* @property {Function} fetchGraphQl - Fetches GraphQL data. Accepts a query string and an optional options object as parameters. Returns a promise that resolves with the fetched data.
|
|
94
|
+
* @property {Function} getConfig - Gets the configuration. Returns an object with the endpoint and GraphQL headers.
|
|
95
|
+
*/
|
|
96
|
+
export declare const setEndpoint: (endpoint: string) => void, setFetchGraphQlHeaders: (header: Header) => void, setFetchGraphQlHeader: (key: string, value: string | null) => void, removeFetchGraphQlHeader: (key: string) => void, fetchGraphQl: <T = any>(query: string, options?: FetchOptions) => Promise<{
|
|
97
|
+
errors?: FetchQueryError | undefined;
|
|
98
|
+
data: T;
|
|
99
|
+
}>, getConfig: () => {
|
|
100
|
+
endpoint: string | undefined;
|
|
101
|
+
fetchGraphQlHeaders: Header | undefined;
|
|
102
|
+
};
|
|
103
|
+
export {};
|
|
104
|
+
//# sourceMappingURL=index.d.ts.map
|
|
105
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../fetch-graphql/src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,MAAM,MAAM,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC;AAEtD;;;;;;;GAOG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IACnC,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,KAAK,CAAC,EACF,SAAS,GACT,UAAU,GACV,QAAQ,GACR,UAAU,GACV,aAAa,GACb,gBAAgB,CAAC;CACtB,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;CAClC,CAAC,CAAC;AAOH,cAAM,gBAAgB;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IAE1B,IAAI,QAAQ,uBAEX;IAED,IAAI,mBAAmB,uBAEtB;IAEM,oBAAoB,EAAE,MAAM,GAAG,SAAS,CAAC;IAEzC,WAAW,CAAC,QAAQ,EAAE,MAAM;IAI5B,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAOvD,wBAAwB,CAAC,GAAG,EAAE,MAAM;IAIpC,sBAAsB,CAAC,MAAM,EAAE,MAAM;IAI/B,YAAY,CAAC,CAAC,GAAG,GAAG,EAC/B,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,YAAY,GACrB,OAAO,CAAC;QAAE,MAAM,CAAC,EAAE,eAAe,CAAC;QAAC,IAAI,EAAE,CAAC,CAAA;KAAE,CAAC;IAwC1C,SAAS;;;;IAOT,UAAU;;;;;;;;;;;;;;CAUlB;AAID;;;;;;;;;GASG;AACH,qBAAa,YAAa,SAAQ,gBAAgB;IAChD,IAAI,QAAQ,uBAEX;IAED,IAAI,mBAAmB,WAMtB;CACF;AAYD;;;;;;;;;GASG;AAGH,eAAO,MACL,WAAW,aAlIkB,MAAM,WAmInC,sBAAsB,WApHgB,MAAM,WAqH5C,qBAAqB,QAhIa,MAAM,SAAS,MAAM,GAAG,IAAI,WAiI9D,wBAAwB,QA1Ha,MAAM,WA2H3C,YAAY,mBAlHH,MAAM,YACH,YAAY;;;IAkHxB,SAAS;;;CACU,CAAC"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from './Icon/index'
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from './UIProvider/index'
|
package/typing/event-bus.d.ts
DELETED
package/typing/initializer.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"initializer.d.ts","sourceRoot":"","sources":["../../../src/lib/initializer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAwB,MAAM,kBAAkB,CAAC;AAEhE,KAAK,QAAQ,GAAG;IAAE,GAAG,IAAI,IAAI,CAAA;CAAE,CAAC;AAEhC,KAAK,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,QAAQ,GAAG,SAAS,CAAC,CAAC;AAEhE,KAAK,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE7C,KAAK,OAAO,CAAC,CAAC,IAAI;IAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;CAAE,CAAC;AAE7D;;;;;;;;;;;GAWG;AACH,qBAAa,WAAW,CAAC,CAAC;IACxB,OAAO,CAAC,UAAU,CAAkB;IACpC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IACd,MAAM,YAA4B;IAElC;;;;;;OAMG;gBACS,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;CAe5C;AAED,KAAK,YAAY,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,GAAG,SAAS,CAAC,EAAE,CAAC;AAE7E;;;;;;;;GAQG;AACH,qBAAa,YAAY;IACvB,MAAM,CAAC,aAAa,EAAE,YAAY,CAAM;IACxC,MAAM,CAAC,QAAQ,EAAE,OAAO,CAAS;IACjC,MAAM,CAAC,kBAAkB,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,GAAG,SAAS,CAAa;IAE7E;;;;;OAKG;IACH,MAAM,CAAC,QAAQ,CACb,WAAW,EAAE,WAAW,CAAC,GAAG,CAAC,EAC7B,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;IASlC;;;;OAIG;IACH,MAAM,CAAC,KAAK;IAgBZ;;;;;OAKG;IACH,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE;CAGxD"}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from '../preact/compat'
|
package/typing/preact-hooks.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from '../preact/hooks'
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from '../preact/jsx-runtime'
|
package/typing/preact.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export * from '../preact'
|
|
File without changes
|