@loaders.gl/loader-utils 4.0.0-alpha.20 → 4.0.0-alpha.22
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/es5/index.js +19 -0
- package/dist/es5/index.js.map +1 -1
- package/dist/es5/json-loader.js +1 -1
- package/dist/es5/json-loader.js.map +1 -1
- package/dist/es5/lib/option-utils/merge-loader-options.js.map +1 -1
- package/dist/es5/lib/worker-loader-utils/create-loader-worker.js +2 -2
- package/dist/es5/lib/worker-loader-utils/create-loader-worker.js.map +1 -1
- package/dist/es5/lib/worker-loader-utils/encode-with-worker.js.map +1 -1
- package/dist/es5/lib/worker-loader-utils/parse-with-worker.js.map +1 -1
- package/dist/es5/loader-types.js +58 -0
- package/dist/es5/loader-types.js.map +1 -0
- package/dist/es5/types.js.map +1 -1
- package/dist/es5/writer-types.js +2 -0
- package/dist/es5/writer-types.js.map +1 -0
- package/dist/esm/index.js +1 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/json-loader.js +1 -1
- package/dist/esm/json-loader.js.map +1 -1
- package/dist/esm/lib/option-utils/merge-loader-options.js.map +1 -1
- package/dist/esm/lib/worker-loader-utils/create-loader-worker.js +2 -2
- package/dist/esm/lib/worker-loader-utils/create-loader-worker.js.map +1 -1
- package/dist/esm/lib/worker-loader-utils/encode-with-worker.js.map +1 -1
- package/dist/esm/lib/worker-loader-utils/parse-with-worker.js.map +1 -1
- package/dist/esm/loader-types.js +16 -0
- package/dist/esm/loader-types.js.map +1 -0
- package/dist/esm/types.js.map +1 -1
- package/dist/esm/writer-types.js +2 -0
- package/dist/esm/writer-types.js.map +1 -0
- package/dist/index.d.ts +4 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -2
- package/dist/json-loader.d.ts +1 -1
- package/dist/json-loader.d.ts.map +1 -1
- package/dist/lib/option-utils/merge-loader-options.d.ts +1 -1
- package/dist/lib/option-utils/merge-loader-options.d.ts.map +1 -1
- package/dist/lib/worker-loader-utils/create-loader-worker.d.ts +1 -1
- package/dist/lib/worker-loader-utils/create-loader-worker.d.ts.map +1 -1
- package/dist/lib/worker-loader-utils/create-loader-worker.js +3 -2
- package/dist/lib/worker-loader-utils/encode-with-worker.d.ts +1 -1
- package/dist/lib/worker-loader-utils/encode-with-worker.d.ts.map +1 -1
- package/dist/lib/worker-loader-utils/parse-with-worker.d.ts +2 -2
- package/dist/lib/worker-loader-utils/parse-with-worker.d.ts.map +1 -1
- package/dist/loader-types.d.ts +208 -0
- package/dist/loader-types.d.ts.map +1 -0
- package/dist/loader-types.js +36 -0
- package/dist/types.d.ts +1 -200
- package/dist/types.d.ts.map +1 -1
- package/dist/writer-types.d.ts +36 -0
- package/dist/writer-types.d.ts.map +1 -0
- package/dist/writer-types.js +3 -0
- package/package.json +3 -3
- package/src/index.ts +24 -13
- package/src/json-loader.ts +1 -1
- package/src/lib/option-utils/merge-loader-options.ts +1 -1
- package/src/lib/worker-loader-utils/create-loader-worker.ts +20 -4
- package/src/lib/worker-loader-utils/encode-with-worker.ts +1 -1
- package/src/lib/worker-loader-utils/parse-with-worker.ts +2 -2
- package/src/loader-types.ts +366 -0
- package/src/types.ts +2 -321
- package/src/writer-types.ts +61 -0
package/dist/types.d.ts
CHANGED
|
@@ -8,206 +8,7 @@ export type BigTypedArrayConstructor = TypedArrayConstructor | BigInt64ArrayCons
|
|
|
8
8
|
/** Any numeric array: typed array or `number[]` */
|
|
9
9
|
export type NumberArray = number[] | TypedArray;
|
|
10
10
|
export type NumericArray = number[] | TypedArray;
|
|
11
|
-
type FetchLike = (url: string, options?: RequestInit) => Promise<Response>;
|
|
12
|
-
/**
|
|
13
|
-
* Core Loader Options
|
|
14
|
-
*/
|
|
15
|
-
export type LoaderOptions = {
|
|
16
|
-
/** fetch options or a custom fetch function */
|
|
17
|
-
fetch?: typeof fetch | FetchLike | RequestInit | null;
|
|
18
|
-
/** Do not throw on errors */
|
|
19
|
-
nothrow?: boolean;
|
|
20
|
-
/** loader selection, search first for supplied mimeType */
|
|
21
|
-
mimeType?: string;
|
|
22
|
-
/** loader selection, provide fallback mimeType is server does not provide */
|
|
23
|
-
fallbackMimeType?: string;
|
|
24
|
-
/** loader selection, avoid searching registered loaders */
|
|
25
|
-
ignoreRegisteredLoaders?: boolean;
|
|
26
|
-
/** Experimental: Supply a logger to the parser */
|
|
27
|
-
log?: any;
|
|
28
|
-
/** Force to load WASM libraries from local file system in NodeJS or from loaders.gl CDN in a web browser */
|
|
29
|
-
useLocalLibraries?: boolean;
|
|
30
|
-
/** Size of each batch. `auto` matches batches to size of incoming chunks */
|
|
31
|
-
batchSize?: number | 'auto';
|
|
32
|
-
/** Minimal amount of time between batches */
|
|
33
|
-
batchDebounceMs?: number;
|
|
34
|
-
/** Stop loading after a given number of rows (compare SQL limit clause) */
|
|
35
|
-
limit?: 0;
|
|
36
|
-
/** Experimental: Stop loading after reaching */
|
|
37
|
-
_limitMB?: 0;
|
|
38
|
-
/** Generate metadata batches */
|
|
39
|
-
metadata?: boolean;
|
|
40
|
-
/** Transforms to run on incoming batches */
|
|
41
|
-
transforms?: TransformBatches[];
|
|
42
|
-
/** CDN load workers from */
|
|
43
|
-
CDN?: string | null;
|
|
44
|
-
/** Set to `false` to disable workers */
|
|
45
|
-
worker?: boolean;
|
|
46
|
-
/** Number of concurrent workers (per loader) on desktop browser */
|
|
47
|
-
maxConcurrency?: number;
|
|
48
|
-
/** Number of concurrent workers (per loader) on mobile browsers */
|
|
49
|
-
maxMobileConcurrency?: number;
|
|
50
|
-
/** Set to `false` to prevent reuse workers */
|
|
51
|
-
reuseWorkers?: boolean;
|
|
52
|
-
/** Whether to use workers under Node.js (experimental) */
|
|
53
|
-
_nodeWorkers?: boolean;
|
|
54
|
-
/** set to 'test' to run local worker */
|
|
55
|
-
_workerType?: string;
|
|
56
|
-
/** @deprecated `options.batchType` removed, Use `options.<loader>.type` instead */
|
|
57
|
-
batchType?: 'row' | 'columnar' | 'arrow';
|
|
58
|
-
/** @deprecated `options.throw removed`, Use `options.nothrow` instead */
|
|
59
|
-
throws?: boolean;
|
|
60
|
-
/** @deprecated `options.dataType` no longer used */
|
|
61
|
-
dataType?: never;
|
|
62
|
-
/** @deprecated `options.uri` no longer used */
|
|
63
|
-
uri?: never;
|
|
64
|
-
/** @deprecated `options.method` removed. Use `options.fetch.method` */
|
|
65
|
-
method?: never;
|
|
66
|
-
/** @deprecated `options.headers` removed. Use `options.fetch.headers` */
|
|
67
|
-
headers?: never;
|
|
68
|
-
/** @deprecated `options.body` removed. Use `options.fetch.body` */
|
|
69
|
-
body?: never;
|
|
70
|
-
/** @deprecated `options.mode` removed. Use `options.fetch.mode` */
|
|
71
|
-
mode?: never;
|
|
72
|
-
/** @deprecated `options.credentials` removed. Use `options.fetch.credentials` */
|
|
73
|
-
credentials?: never;
|
|
74
|
-
/** @deprecated `options.cache` removed. Use `options.fetch.cache` */
|
|
75
|
-
cache?: never;
|
|
76
|
-
/** @deprecated `options.redirect` removed. Use `options.fetch.redirect` */
|
|
77
|
-
redirect?: never;
|
|
78
|
-
/** @deprecated `options.referrer` removed. Use `options.fetch.referrer` */
|
|
79
|
-
referrer?: never;
|
|
80
|
-
/** @deprecated `options.referrerPolicy` removed. Use `options.fetch.referrerPolicy` */
|
|
81
|
-
referrerPolicy?: never;
|
|
82
|
-
/** @deprecated `options.integrity` removed. Use `options.fetch.integrity` */
|
|
83
|
-
integrity?: never;
|
|
84
|
-
/** @deprecated `options.keepalive` removed. Use `options.fetch.keepalive` */
|
|
85
|
-
keepalive?: never;
|
|
86
|
-
/** @deprecated `options.signal` removed. Use `options.fetch.signal` */
|
|
87
|
-
signal?: never;
|
|
88
|
-
[loaderId: string]: unknown;
|
|
89
|
-
};
|
|
90
|
-
type PreloadOptions = {
|
|
91
|
-
[key: string]: unknown;
|
|
92
|
-
};
|
|
93
|
-
/**
|
|
94
|
-
* A worker loader definition that can be used with `@loaders.gl/core` functions
|
|
95
|
-
*/
|
|
96
|
-
export type Loader<DataT = any, BatchT = any, LoaderOptionsT = LoaderOptions> = {
|
|
97
|
-
dataType?: DataT;
|
|
98
|
-
batchType?: BatchT;
|
|
99
|
-
/** Default Options */
|
|
100
|
-
options: LoaderOptionsT;
|
|
101
|
-
/** Deprecated Options */
|
|
102
|
-
deprecatedOptions?: Record<string, string | Record<string, string>>;
|
|
103
|
-
name: string;
|
|
104
|
-
/** id should be the same as the field used in LoaderOptions */
|
|
105
|
-
id: string;
|
|
106
|
-
/** module is used to generate worker threads, need to be the module directory name */
|
|
107
|
-
module: string;
|
|
108
|
-
/** Version should be injected by build tools */
|
|
109
|
-
version: string;
|
|
110
|
-
/** A boolean, or a URL */
|
|
111
|
-
worker?: string | boolean;
|
|
112
|
-
/** Which category does this loader belong to */
|
|
113
|
-
category?: string;
|
|
114
|
-
/** What extensions does this loader generate */
|
|
115
|
-
extensions: string[];
|
|
116
|
-
mimeTypes: string[];
|
|
117
|
-
binary?: boolean;
|
|
118
|
-
text?: boolean;
|
|
119
|
-
tests?: (((ArrayBuffer: ArrayBuffer) => boolean) | ArrayBuffer | string)[];
|
|
120
|
-
supported?: boolean;
|
|
121
|
-
testText?: (string: string) => boolean;
|
|
122
|
-
};
|
|
123
|
-
/**
|
|
124
|
-
* A "bundled" loader definition that can be used with `@loaders.gl/core` functions
|
|
125
|
-
* If a worker loader is supported it will also be supported.
|
|
126
|
-
*/
|
|
127
|
-
export type LoaderWithParser<DataT = any, BatchT = any, LoaderOptionsT = LoaderOptions> = Loader<DataT, BatchT, LoaderOptionsT> & {
|
|
128
|
-
testText?: (string: string) => boolean;
|
|
129
|
-
parse: (arrayBuffer: ArrayBuffer, options?: LoaderOptionsT, context?: LoaderContext) => Promise<DataT>;
|
|
130
|
-
preload?: Preload;
|
|
131
|
-
parseSync?: (arrayBuffer: ArrayBuffer, options?: LoaderOptionsT, context?: LoaderContext) => DataT;
|
|
132
|
-
parseText?: (text: string, options?: LoaderOptionsT) => Promise<DataT>;
|
|
133
|
-
parseTextSync?: (text: string, options?: LoaderOptionsT) => DataT;
|
|
134
|
-
parseInBatches?: (iterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>, options?: LoaderOptionsT, context?: LoaderContext) => AsyncIterable<BatchT>;
|
|
135
|
-
parseFileInBatches?: (file: Blob, options?: LoaderOptionsT, context?: LoaderContext) => AsyncIterable<BatchT>;
|
|
136
|
-
};
|
|
137
|
-
/**
|
|
138
|
-
* A Loader context is provided as a third parameters to a loader object's
|
|
139
|
-
* parse functions when that loader is called by other loaders rather then
|
|
140
|
-
* directly by the application.
|
|
141
|
-
*
|
|
142
|
-
* - The context object allows the subloaders to be aware of the parameters and
|
|
143
|
-
* options that the application provided in the top level call.
|
|
144
|
-
* - The context also providedsaccess to parse functions so that the subloader
|
|
145
|
-
* does not need to include the core module.
|
|
146
|
-
* - In addition, the context's parse functions may also redirect loads from worker
|
|
147
|
-
* threads back to main thread.
|
|
148
|
-
*/
|
|
149
|
-
export type LoaderContext = {
|
|
150
|
-
loaders?: Loader[] | null;
|
|
151
|
-
/** If URL is available. */
|
|
152
|
-
url?: string;
|
|
153
|
-
/** the file name component of the URL (leading path and query string removed) */
|
|
154
|
-
filename?: string;
|
|
155
|
-
/** the directory name component of the URL (leading path excluding file name and query string) */
|
|
156
|
-
baseUrl?: string;
|
|
157
|
-
/** Query string (characters after `?`) */
|
|
158
|
-
queryString?: string;
|
|
159
|
-
/** Provides access to any application overrides of fetch() */
|
|
160
|
-
fetch: typeof fetch | FetchLike;
|
|
161
|
-
/** TBD */
|
|
162
|
-
response?: Response;
|
|
163
|
-
/** Parse function. Use instead of importing `core`. In workers, may redirect to main thread */
|
|
164
|
-
parse: (arrayBuffer: ArrayBuffer, loaders?: Loader | Loader[] | LoaderOptions, options?: LoaderOptions, context?: LoaderContext) => Promise<any>;
|
|
165
|
-
/** ParseSync function. Use instead of importing `core`. In workers, may redirect to main thread */
|
|
166
|
-
parseSync?: (arrayBuffer: ArrayBuffer, loaders?: Loader | Loader[] | LoaderOptions, options?: LoaderOptions, context?: LoaderContext) => any;
|
|
167
|
-
/** ParseInBatches function. Use instead of importing `core`. */
|
|
168
|
-
parseInBatches?: (iterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>, loaders?: Loader | Loader[] | LoaderOptions, options?: LoaderOptions, context?: LoaderContext) => AsyncIterable<any> | Promise<AsyncIterable<any>>;
|
|
169
|
-
};
|
|
170
|
-
type Preload = (url: string, options?: PreloadOptions) => any;
|
|
171
|
-
/** Typescript helper to extract options type from a generic loader type */
|
|
172
|
-
export type LoaderOptionsType<T = Loader> = T extends Loader<any, any, infer Options> ? Options : never;
|
|
173
|
-
/** Typescript helper to extract data type from a generic loader type */
|
|
174
|
-
export type LoaderReturnType<T = Loader> = T extends Loader<infer Return, any, any> ? Return : never;
|
|
175
|
-
/** Typescript helper to extract batch type from a generic loader type */
|
|
176
|
-
export type LoaderBatchType<T = Loader> = T extends Loader<any, infer Batch, any> ? Batch : never;
|
|
177
|
-
/** Options for writers */
|
|
178
|
-
export type WriterOptions = {
|
|
179
|
-
/** worker source. If is set will be used instead of loading worker from the Internet */
|
|
180
|
-
souce?: string | null;
|
|
181
|
-
/** Force to load WASM libraries from local file system in NodeJS or from loaders.gl CDN in a web browser */
|
|
182
|
-
useLocalLibraries?: boolean;
|
|
183
|
-
/** writer-specific options */
|
|
184
|
-
[writerId: string]: any;
|
|
185
|
-
};
|
|
186
|
-
/**
|
|
187
|
-
* A writer definition that can be used with `@loaders.gl/core` functions
|
|
188
|
-
*/
|
|
189
|
-
export type Writer<DataT = unknown, BatchT = unknown, WriterOptionsT = WriterOptions> = {
|
|
190
|
-
name: string;
|
|
191
|
-
id: string;
|
|
192
|
-
module: string;
|
|
193
|
-
version: string;
|
|
194
|
-
worker?: string | boolean;
|
|
195
|
-
extensions?: string[];
|
|
196
|
-
mimeTypes?: string[];
|
|
197
|
-
binary?: boolean;
|
|
198
|
-
text?: boolean;
|
|
199
|
-
options: WriterOptionsT;
|
|
200
|
-
deprecatedOptions?: Record<string, string>;
|
|
201
|
-
encodeSync?: EncodeSync;
|
|
202
|
-
encodeURLtoURL?: EncodeURLtoURL;
|
|
203
|
-
encode?(data: DataT, options?: WriterOptionsT): Promise<ArrayBuffer>;
|
|
204
|
-
encodeText?(table: DataT, options?: WriterOptionsT): Promise<string> | string;
|
|
205
|
-
encodeInBatches?(data: AsyncIterable<any>, options?: WriterOptionsT): AsyncIterable<ArrayBuffer>;
|
|
206
|
-
};
|
|
207
|
-
type EncodeSync = (data: any, options?: WriterOptions) => ArrayBuffer;
|
|
208
|
-
type EncodeURLtoURL = (inputUrl: string, outputUrl: string, options?: WriterOptions) => Promise<string>;
|
|
209
|
-
/** Typescript helper to extract the writer options type from a generic writer type */
|
|
210
|
-
export type WriterOptionsType<T = Writer> = T extends Writer<unknown, unknown, infer Options> ? Options : never;
|
|
11
|
+
export type FetchLike = (url: string, options?: RequestInit) => Promise<Response>;
|
|
211
12
|
export type TransformBatches = (asyncIterator: AsyncIterable<ArrayBuffer> | Iterable<ArrayBuffer>) => AsyncIterable<ArrayBuffer>;
|
|
212
13
|
/** Types that can be synchronously parsed */
|
|
213
14
|
export type SyncDataType = string | ArrayBuffer;
|
package/dist/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAEA,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,UAAU,GACV,iBAAiB,GACjB,UAAU,GACV,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,WAAW,CAAC;AAEhB,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC;AAExE,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,eAAe,CAAC;AAEzD,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,aAAa,GAAG,cAAc,CAAC;AAExE,MAAM,MAAM,qBAAqB,GAC7B,oBAAoB,GACpB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,qBAAqB,GACrB,sBAAsB,GACtB,qBAAqB,GACrB,sBAAsB,GACtB,uBAAuB,GACvB,uBAAuB,CAAC;AAE5B,MAAM,MAAM,wBAAwB,GAChC,qBAAqB,GACrB,wBAAwB,GACxB,yBAAyB,CAAC;AAE9B,mDAAmD;AACnD,MAAM,MAAM,WAAW,GAAG,MAAM,EAAE,GAAG,UAAU,CAAC;AAEhD,MAAM,MAAM,YAAY,GAAG,MAAM,EAAE,GAAG,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAEA,MAAM,MAAM,aAAa,GACrB,SAAS,GACT,UAAU,GACV,iBAAiB,GACjB,UAAU,GACV,WAAW,GACX,UAAU,GACV,WAAW,GACX,UAAU,GACV,WAAW,CAAC;AAEhB,MAAM,MAAM,eAAe,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC;AAExE,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,eAAe,CAAC;AAEzD,MAAM,MAAM,aAAa,GAAG,UAAU,GAAG,aAAa,GAAG,cAAc,CAAC;AAExE,MAAM,MAAM,qBAAqB,GAC7B,oBAAoB,GACpB,qBAAqB,GACrB,qBAAqB,GACrB,sBAAsB,GACtB,qBAAqB,GACrB,sBAAsB,GACtB,qBAAqB,GACrB,sBAAsB,GACtB,uBAAuB,GACvB,uBAAuB,CAAC;AAE5B,MAAM,MAAM,wBAAwB,GAChC,qBAAqB,GACrB,wBAAwB,GACxB,yBAAyB,CAAC;AAE9B,mDAAmD;AACnD,MAAM,MAAM,WAAW,GAAG,MAAM,EAAE,GAAG,UAAU,CAAC;AAEhD,MAAM,MAAM,YAAY,GAAG,MAAM,EAAE,GAAG,UAAU,CAAC;AAIjD,MAAM,MAAM,SAAS,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,WAAW,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC;AAIlF,MAAM,MAAM,gBAAgB,GAAG,CAC7B,aAAa,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC,KAC9D,aAAa,CAAC,WAAW,CAAC,CAAC;AAEhC,6CAA6C;AAC7C,MAAM,MAAM,YAAY,GAAG,MAAM,GAAG,WAAW,CAAC;AAEhD,qCAAqC;AACrC,MAAM,MAAM,QAAQ,GAChB,MAAM,GACN,WAAW,GACX,IAAI,GACJ,IAAI,GACJ,QAAQ,GACR,cAAc,GACd,QAAQ,CAAC,WAAW,CAAC,GACrB,aAAa,CAAC,WAAW,CAAC,CAAC;AAE/B,0CAA0C;AAC1C,MAAM,MAAM,iBAAiB,GACzB,QAAQ,GACR,QAAQ,CAAC,WAAW,CAAC,GACrB,aAAa,CAAC,WAAW,CAAC,GAC1B,OAAO,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC;AAExC;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAC,SAAS,CAAC,EAAE,OAAO,CAAA;KAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAE9E;;;;;OAKG;IACH,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAC,CAAC,CAAC;IAElE;;;;OAIG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;CAC9D;AAED,KAAK,WAAW,GAAG;IAAC,MAAM,CAAC,EAAE,WAAW,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAC,CAAC;AAC/F,MAAM,WAAW,2BAA4B,SAAQ,WAAW;IAC9D,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACrE,KAAK,CAAC,EAAE,EAAE,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9B,KAAK,CAAC,EAAE,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC;QAAC,SAAS,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAC,CAAC,CAAC;CACpF"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/** Options for writers */
|
|
2
|
+
export type WriterOptions = {
|
|
3
|
+
/** worker source. If is set will be used instead of loading worker from the Internet */
|
|
4
|
+
source?: string | null;
|
|
5
|
+
/** Force to load WASM libraries from local file system in NodeJS or from loaders.gl CDN in a web browser */
|
|
6
|
+
useLocalLibraries?: boolean;
|
|
7
|
+
/** writer-specific options */
|
|
8
|
+
[writerId: string]: any;
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* A writer definition that can be used with `@loaders.gl/core` functions
|
|
12
|
+
*/
|
|
13
|
+
export type Writer<DataT = unknown, BatchT = unknown, WriterOptionsT = WriterOptions> = {
|
|
14
|
+
name: string;
|
|
15
|
+
id: string;
|
|
16
|
+
module: string;
|
|
17
|
+
version: string;
|
|
18
|
+
worker?: string | boolean;
|
|
19
|
+
extensions?: string[];
|
|
20
|
+
mimeTypes?: string[];
|
|
21
|
+
binary?: boolean;
|
|
22
|
+
text?: boolean;
|
|
23
|
+
options: WriterOptionsT;
|
|
24
|
+
deprecatedOptions?: Record<string, string>;
|
|
25
|
+
encodeSync?: EncodeSync;
|
|
26
|
+
encodeURLtoURL?: EncodeURLtoURL;
|
|
27
|
+
encode?(data: DataT, options?: WriterOptionsT): Promise<ArrayBuffer>;
|
|
28
|
+
encodeText?(table: DataT, options?: WriterOptionsT): Promise<string> | string;
|
|
29
|
+
encodeInBatches?(data: AsyncIterable<any>, options?: WriterOptionsT): AsyncIterable<ArrayBuffer>;
|
|
30
|
+
};
|
|
31
|
+
type EncodeSync = (data: any, options?: WriterOptions) => ArrayBuffer;
|
|
32
|
+
type EncodeURLtoURL = (inputUrl: string, outputUrl: string, options?: WriterOptions) => Promise<string>;
|
|
33
|
+
/** Typescript helper to extract the writer options type from a generic writer type */
|
|
34
|
+
export type WriterOptionsType<T = Writer> = T extends Writer<unknown, unknown, infer Options> ? Options : never;
|
|
35
|
+
export {};
|
|
36
|
+
//# sourceMappingURL=writer-types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"writer-types.d.ts","sourceRoot":"","sources":["../src/writer-types.ts"],"names":[],"mappings":"AAIA,0BAA0B;AAC1B,MAAM,MAAM,aAAa,GAAG;IAC1B,wFAAwF;IACxF,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,4GAA4G;IAC5G,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,8BAA8B;IAC9B,CAAC,QAAQ,EAAE,MAAM,GAAG,GAAG,CAAC;CACzB,CAAC;AAEF;;GAEG;AAEH,MAAM,MAAM,MAAM,CAAC,KAAK,GAAG,OAAO,EAAE,MAAM,GAAG,OAAO,EAAE,cAAc,GAAG,aAAa,IAAI;IACtF,IAAI,EAAE,MAAM,CAAC;IAEb,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAG1B,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf,OAAO,EAAE,cAAc,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAI3C,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACrE,UAAU,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;IAC9E,eAAe,CAAC,CAAC,IAAI,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,aAAa,CAAC,WAAW,CAAC,CAAC;CAClG,CAAC;AAGF,KAAK,UAAU,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,aAAa,KAAK,WAAW,CAAC;AAItE,KAAK,cAAc,GAAG,CACpB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,aAAa,KACpB,OAAO,CAAC,MAAM,CAAC,CAAC;AAErB,sFAAsF;AACtF,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,MAAM,IAAI,CAAC,SAAS,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC,GACzF,OAAO,GACP,KAAK,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@loaders.gl/loader-utils",
|
|
3
|
-
"version": "4.0.0-alpha.
|
|
3
|
+
"version": "4.0.0-alpha.22",
|
|
4
4
|
"description": "Framework-independent loaders for 3D graphics formats",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"publishConfig": {
|
|
@@ -38,8 +38,8 @@
|
|
|
38
38
|
"scripts": {},
|
|
39
39
|
"dependencies": {
|
|
40
40
|
"@babel/runtime": "^7.3.1",
|
|
41
|
-
"@loaders.gl/worker-utils": "4.0.0-alpha.
|
|
41
|
+
"@loaders.gl/worker-utils": "4.0.0-alpha.22",
|
|
42
42
|
"@probe.gl/stats": "^4.0.2"
|
|
43
43
|
},
|
|
44
|
-
"gitHead": "
|
|
44
|
+
"gitHead": "0da838c506d1275383f2fd3d244d9c72b25397d2"
|
|
45
45
|
}
|
package/src/index.ts
CHANGED
|
@@ -1,17 +1,8 @@
|
|
|
1
|
+
// loaders.gl, MIT license
|
|
2
|
+
|
|
1
3
|
// TYPES
|
|
4
|
+
|
|
2
5
|
export type {
|
|
3
|
-
// loaders
|
|
4
|
-
Loader,
|
|
5
|
-
LoaderWithParser,
|
|
6
|
-
LoaderContext,
|
|
7
|
-
LoaderOptions,
|
|
8
|
-
LoaderOptionsType,
|
|
9
|
-
LoaderReturnType,
|
|
10
|
-
LoaderBatchType,
|
|
11
|
-
// writers
|
|
12
|
-
Writer,
|
|
13
|
-
WriterOptions,
|
|
14
|
-
WriterOptionsType,
|
|
15
6
|
// misc
|
|
16
7
|
DataType,
|
|
17
8
|
SyncDataType,
|
|
@@ -24,9 +15,29 @@ export type {
|
|
|
24
15
|
TypedArrayConstructor,
|
|
25
16
|
BigTypedArrayConstructor,
|
|
26
17
|
NumberArray,
|
|
27
|
-
NumericArray
|
|
18
|
+
NumericArray,
|
|
19
|
+
// fetch
|
|
20
|
+
FetchLike
|
|
28
21
|
} from './types';
|
|
29
22
|
|
|
23
|
+
// loaders
|
|
24
|
+
|
|
25
|
+
export type {
|
|
26
|
+
Loader,
|
|
27
|
+
LoaderWithParser,
|
|
28
|
+
LoaderContext,
|
|
29
|
+
LoaderOptions,
|
|
30
|
+
LoaderOptionsType,
|
|
31
|
+
LoaderReturnType,
|
|
32
|
+
LoaderBatchType
|
|
33
|
+
} from './loader-types';
|
|
34
|
+
|
|
35
|
+
export {parseFromContext, parseSyncFromContext, parseInBatchesFromContext} from './loader-types';
|
|
36
|
+
|
|
37
|
+
// writers
|
|
38
|
+
|
|
39
|
+
export type {Writer, WriterOptions, WriterOptionsType} from './writer-types';
|
|
40
|
+
|
|
30
41
|
// GENERAL UTILS
|
|
31
42
|
export {assert} from './lib/env-utils/assert';
|
|
32
43
|
export {
|
package/src/json-loader.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/* eslint-disable no-restricted-globals */
|
|
2
|
-
import type {LoaderWithParser} from '../../types';
|
|
2
|
+
import type {LoaderWithParser, LoaderOptions, LoaderContext} from '../../loader-types';
|
|
3
3
|
import {WorkerBody} from '@loaders.gl/worker-utils';
|
|
4
4
|
// import {validateLoaderVersion} from './validate-loader-version';
|
|
5
5
|
|
|
@@ -27,9 +27,10 @@ export function createLoaderWorker(loader: LoaderWithParser) {
|
|
|
27
27
|
loader,
|
|
28
28
|
arrayBuffer: input,
|
|
29
29
|
options,
|
|
30
|
+
// @ts-expect-error fetch missing
|
|
30
31
|
context: {
|
|
31
32
|
...context,
|
|
32
|
-
|
|
33
|
+
_parse: parseOnMainThread
|
|
33
34
|
}
|
|
34
35
|
});
|
|
35
36
|
WorkerBody.postMessage('done', {result});
|
|
@@ -43,7 +44,12 @@ export function createLoaderWorker(loader: LoaderWithParser) {
|
|
|
43
44
|
};
|
|
44
45
|
}
|
|
45
46
|
|
|
46
|
-
function parseOnMainThread(
|
|
47
|
+
function parseOnMainThread(
|
|
48
|
+
arrayBuffer: ArrayBuffer,
|
|
49
|
+
loader: any,
|
|
50
|
+
options?: LoaderOptions,
|
|
51
|
+
context?: LoaderContext
|
|
52
|
+
): Promise<void> {
|
|
47
53
|
return new Promise((resolve, reject) => {
|
|
48
54
|
const id = requestId++;
|
|
49
55
|
|
|
@@ -83,7 +89,17 @@ function parseOnMainThread(arrayBuffer: ArrayBuffer, options: {[key: string]: an
|
|
|
83
89
|
// TODO - Why not support async loader.parse* funcs here?
|
|
84
90
|
// TODO - Why not reuse a common function instead of reimplementing loader.parse* selection logic? Keeping loader small?
|
|
85
91
|
// TODO - Lack of appropriate parser functions can be detected when we create worker, no need to wait until parse
|
|
86
|
-
async function parseData({
|
|
92
|
+
async function parseData({
|
|
93
|
+
loader,
|
|
94
|
+
arrayBuffer,
|
|
95
|
+
options,
|
|
96
|
+
context
|
|
97
|
+
}: {
|
|
98
|
+
loader: LoaderWithParser;
|
|
99
|
+
arrayBuffer: ArrayBuffer;
|
|
100
|
+
options: LoaderOptions;
|
|
101
|
+
context: LoaderContext;
|
|
102
|
+
}) {
|
|
87
103
|
let data;
|
|
88
104
|
let parser;
|
|
89
105
|
if (loader.parseSync || loader.parse) {
|
|
@@ -4,7 +4,7 @@ import {
|
|
|
4
4
|
WorkerMessagePayload,
|
|
5
5
|
isBrowser
|
|
6
6
|
} from '@loaders.gl/worker-utils';
|
|
7
|
-
import type {Loader, LoaderOptions, LoaderContext} from '../../types';
|
|
7
|
+
import type {Loader, LoaderOptions, LoaderContext} from '../../loader-types';
|
|
8
8
|
import {WorkerFarm, getWorkerURL} from '@loaders.gl/worker-utils';
|
|
9
9
|
|
|
10
10
|
/**
|
|
@@ -34,7 +34,7 @@ export async function parseWithWorker(
|
|
|
34
34
|
data: any,
|
|
35
35
|
options?: LoaderOptions,
|
|
36
36
|
context?: LoaderContext,
|
|
37
|
-
parseOnMainThread?: (arrayBuffer: ArrayBuffer, options: {[key: string]: any}) => Promise<
|
|
37
|
+
parseOnMainThread?: (arrayBuffer: ArrayBuffer, options: {[key: string]: any}) => Promise<unknown>
|
|
38
38
|
) {
|
|
39
39
|
const name = loader.id; // TODO
|
|
40
40
|
const url = getWorkerURL(loader, options);
|