@xyo-network/image-thumbnail-plugin 2.73.4 → 2.74.0

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.
Files changed (70) hide show
  1. package/dist/Diviner/Config.d.mts +11 -0
  2. package/dist/Diviner/Config.d.mts.map +1 -0
  3. package/dist/Diviner/Config.d.ts +11 -0
  4. package/dist/Diviner/Config.d.ts.map +1 -0
  5. package/dist/Diviner/Diviner.d.mts +30 -0
  6. package/dist/Diviner/Diviner.d.mts.map +1 -0
  7. package/dist/Diviner/Diviner.d.ts +30 -0
  8. package/dist/Diviner/Diviner.d.ts.map +1 -0
  9. package/dist/Diviner/Params.d.mts +5 -0
  10. package/dist/Diviner/Params.d.mts.map +1 -0
  11. package/dist/Diviner/Params.d.ts +5 -0
  12. package/dist/Diviner/Params.d.ts.map +1 -0
  13. package/dist/Diviner/index.d.mts +4 -0
  14. package/dist/Diviner/index.d.mts.map +1 -0
  15. package/dist/Diviner/index.d.ts +4 -0
  16. package/dist/Diviner/index.d.ts.map +1 -0
  17. package/dist/Plugin.d.mts +116 -0
  18. package/dist/Plugin.d.mts.map +1 -0
  19. package/dist/Plugin.d.ts +116 -0
  20. package/dist/Plugin.d.ts.map +1 -0
  21. package/dist/Witness/Config.d.mts +16 -0
  22. package/dist/Witness/Config.d.mts.map +1 -0
  23. package/dist/Witness/Config.d.ts +16 -0
  24. package/dist/Witness/Config.d.ts.map +1 -0
  25. package/dist/Witness/Params.d.mts +7 -0
  26. package/dist/Witness/Params.d.mts.map +1 -0
  27. package/dist/Witness/Params.d.ts +7 -0
  28. package/dist/Witness/Params.d.ts.map +1 -0
  29. package/dist/Witness/Witness.d.mts +66 -0
  30. package/dist/Witness/Witness.d.mts.map +1 -0
  31. package/dist/Witness/Witness.d.ts +66 -0
  32. package/dist/Witness/Witness.d.ts.map +1 -0
  33. package/dist/Witness/ffmpeg/fluent/getVideoFrameAsImageFluent.d.mts +8 -0
  34. package/dist/Witness/ffmpeg/fluent/getVideoFrameAsImageFluent.d.mts.map +1 -0
  35. package/dist/Witness/ffmpeg/fluent/getVideoFrameAsImageFluent.d.ts +8 -0
  36. package/dist/Witness/ffmpeg/fluent/getVideoFrameAsImageFluent.d.ts.map +1 -0
  37. package/dist/Witness/ffmpeg/fluent/index.d.mts +2 -0
  38. package/dist/Witness/ffmpeg/fluent/index.d.mts.map +1 -0
  39. package/dist/Witness/ffmpeg/fluent/index.d.ts +2 -0
  40. package/dist/Witness/ffmpeg/fluent/index.d.ts.map +1 -0
  41. package/dist/Witness/ffmpeg/index.d.mts +3 -0
  42. package/dist/Witness/ffmpeg/index.d.mts.map +1 -0
  43. package/dist/Witness/ffmpeg/index.d.ts +3 -0
  44. package/dist/Witness/ffmpeg/index.d.ts.map +1 -0
  45. package/dist/Witness/ffmpeg/spawn/executeFfmpeg.d.mts +9 -0
  46. package/dist/Witness/ffmpeg/spawn/executeFfmpeg.d.mts.map +1 -0
  47. package/dist/Witness/ffmpeg/spawn/executeFfmpeg.d.ts +9 -0
  48. package/dist/Witness/ffmpeg/spawn/executeFfmpeg.d.ts.map +1 -0
  49. package/dist/Witness/ffmpeg/spawn/getVideoFrameAsImage.d.mts +8 -0
  50. package/dist/Witness/ffmpeg/spawn/getVideoFrameAsImage.d.mts.map +1 -0
  51. package/dist/Witness/ffmpeg/spawn/getVideoFrameAsImage.d.ts +8 -0
  52. package/dist/Witness/ffmpeg/spawn/getVideoFrameAsImage.d.ts.map +1 -0
  53. package/dist/Witness/ffmpeg/spawn/index.d.mts +3 -0
  54. package/dist/Witness/ffmpeg/spawn/index.d.mts.map +1 -0
  55. package/dist/Witness/ffmpeg/spawn/index.d.ts +3 -0
  56. package/dist/Witness/ffmpeg/spawn/index.d.ts.map +1 -0
  57. package/dist/Witness/index.d.mts +4 -0
  58. package/dist/Witness/index.d.mts.map +1 -0
  59. package/dist/Witness/index.d.ts +4 -0
  60. package/dist/Witness/index.d.ts.map +1 -0
  61. package/dist/index.d.mts +6 -245
  62. package/dist/index.d.mts.map +1 -0
  63. package/dist/index.d.ts +6 -245
  64. package/dist/index.d.ts.map +1 -0
  65. package/dist/index.js.map +1 -1
  66. package/dist/index.mjs.map +1 -1
  67. package/package.json +20 -26
  68. package/src/Witness/Witness.ts +1 -1
  69. package/dist/docs.json +0 -51242
  70. package/tsup.config.ts +0 -16
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Witness/ffmpeg/fluent/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAA"}
@@ -0,0 +1,2 @@
1
+ export * from './getVideoFrameAsImageFluent';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Witness/ffmpeg/fluent/index.ts"],"names":[],"mappings":"AAAA,cAAc,8BAA8B,CAAA"}
@@ -0,0 +1,3 @@
1
+ export * from './fluent';
2
+ export * from './spawn';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Witness/ffmpeg/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA"}
@@ -0,0 +1,3 @@
1
+ export * from './fluent';
2
+ export * from './spawn';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Witness/ffmpeg/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA"}
@@ -0,0 +1,9 @@
1
+ /// <reference types="node" />
2
+ /**
3
+ * Execute FFmpeg with the provided arguments.
4
+ * @param videoBuffer Input video buffer.
5
+ * @param ffmpegArgs FFmpeg arguments.
6
+ * @returns Output buffer containing the video thumbnail image.
7
+ */
8
+ export declare const executeFFmpeg: (videoBuffer: Buffer, ffmpegArgs: string[]) => Promise<Buffer>;
9
+ //# sourceMappingURL=executeFfmpeg.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"executeFfmpeg.d.ts","sourceRoot":"","sources":["../../../../src/Witness/ffmpeg/spawn/executeFfmpeg.ts"],"names":[],"mappings":";AAEA;;;;;GAKG;AACH,eAAO,MAAM,aAAa,gBAAiB,MAAM,cAAc,MAAM,EAAE,KAAG,QAAQ,MAAM,CAkBvF,CAAA"}
@@ -0,0 +1,9 @@
1
+ /// <reference types="node" />
2
+ /**
3
+ * Execute FFmpeg with the provided arguments.
4
+ * @param videoBuffer Input video buffer.
5
+ * @param ffmpegArgs FFmpeg arguments.
6
+ * @returns Output buffer containing the video thumbnail image.
7
+ */
8
+ export declare const executeFFmpeg: (videoBuffer: Buffer, ffmpegArgs: string[]) => Promise<Buffer>;
9
+ //# sourceMappingURL=executeFfmpeg.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"executeFfmpeg.d.ts","sourceRoot":"","sources":["../../../../src/Witness/ffmpeg/spawn/executeFfmpeg.ts"],"names":[],"mappings":";AAEA;;;;;GAKG;AACH,eAAO,MAAM,aAAa,gBAAiB,MAAM,cAAc,MAAM,EAAE,KAAG,QAAQ,MAAM,CAkBvF,CAAA"}
@@ -0,0 +1,8 @@
1
+ /// <reference types="node" />
2
+ /**
3
+ * Execute FFmpeg with provided input buffer and return video thumbnail image.
4
+ * @param videoBuffer Input video buffer.
5
+ * @returns Output buffer containing the video thumbnail image.
6
+ */
7
+ export declare const getVideoFrameAsImage: (videoBuffer: Buffer) => Promise<Buffer>;
8
+ //# sourceMappingURL=getVideoFrameAsImage.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getVideoFrameAsImage.d.ts","sourceRoot":"","sources":["../../../../src/Witness/ffmpeg/spawn/getVideoFrameAsImage.ts"],"names":[],"mappings":";AAEA;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,gBAAuB,MAAM,oBAG7D,CAAA"}
@@ -0,0 +1,8 @@
1
+ /// <reference types="node" />
2
+ /**
3
+ * Execute FFmpeg with provided input buffer and return video thumbnail image.
4
+ * @param videoBuffer Input video buffer.
5
+ * @returns Output buffer containing the video thumbnail image.
6
+ */
7
+ export declare const getVideoFrameAsImage: (videoBuffer: Buffer) => Promise<Buffer>;
8
+ //# sourceMappingURL=getVideoFrameAsImage.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"getVideoFrameAsImage.d.ts","sourceRoot":"","sources":["../../../../src/Witness/ffmpeg/spawn/getVideoFrameAsImage.ts"],"names":[],"mappings":";AAEA;;;;GAIG;AACH,eAAO,MAAM,oBAAoB,gBAAuB,MAAM,oBAG7D,CAAA"}
@@ -0,0 +1,3 @@
1
+ export * from './executeFfmpeg';
2
+ export * from './getVideoFrameAsImage';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Witness/ffmpeg/spawn/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAA"}
@@ -0,0 +1,3 @@
1
+ export * from './executeFfmpeg';
2
+ export * from './getVideoFrameAsImage';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/Witness/ffmpeg/spawn/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAA"}
@@ -0,0 +1,4 @@
1
+ export * from './Config';
2
+ export * from './Params';
3
+ export * from './Witness';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Witness/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA"}
@@ -0,0 +1,4 @@
1
+ export * from './Config';
2
+ export * from './Params';
3
+ export * from './Witness';
4
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/Witness/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,cAAc,WAAW,CAAA"}
package/dist/index.d.mts CHANGED
@@ -1,245 +1,6 @@
1
- import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
2
- import * as _xyo_network_wallet_model from '@xyo-network/wallet-model';
3
- import { WitnessConfig, WitnessParams, AbstractWitness } from '@xyo-network/witness';
4
- import * as _xyo_network_payload_model from '@xyo-network/payload-model';
5
- import { ImageThumbnail } from '@xyo-network/image-thumbnail-payload-plugin';
6
- import { UrlPayload } from '@xyo-network/url-payload-plugin';
7
- import { LRUCache } from 'lru-cache';
8
- import { AnyConfigSchema } from '@xyo-network/module';
9
- import * as _xyo_network_module_model from '@xyo-network/module-model';
10
- import * as _xyo_network_account_model from '@xyo-network/account-model';
11
- import * as _xyo_network_core from '@xyo-network/core';
12
- import { AbstractDiviner } from '@xyo-network/abstract-diviner';
13
- import { ArchivistInstance } from '@xyo-network/archivist-model';
14
- import { DivinerConfig, DivinerParams, DivinerInstance } from '@xyo-network/diviner-model';
15
-
16
- declare const ImageThumbnailWitnessConfigSchema: "network.xyo.image.thumbnail.witness.config";
17
- type ImageThumbnailWitnessConfigSchema = typeof ImageThumbnailWitnessConfigSchema;
18
- type ImageThumbnailEncoding = 'PNG' | 'JPG' | 'GIF';
19
- type ImageThumbnailWitnessConfig = WitnessConfig<{
20
- encoding?: ImageThumbnailEncoding;
21
- height?: number;
22
- ipfsGateway?: string;
23
- maxAsyncProcesses?: number;
24
- maxCacheBytes?: number;
25
- maxCacheEntries?: number;
26
- quality?: number;
27
- schema: ImageThumbnailWitnessConfigSchema;
28
- width?: number;
29
- }>;
30
-
31
- type ImageThumbnailWitnessParams = WitnessParams<AnyConfigSchema<ImageThumbnailWitnessConfig>, {
32
- loaders?: string[];
33
- }>;
34
-
35
- interface ImageThumbnailWitnessError extends Error {
36
- name: 'ImageThumbnailWitnessError';
37
- url: string;
38
- }
39
- interface DnsError extends Error {
40
- code: string;
41
- }
42
- declare class ImageThumbnailWitness<TParams extends ImageThumbnailWitnessParams = ImageThumbnailWitnessParams> extends AbstractWitness<TParams> {
43
- static configSchemas: "network.xyo.image.thumbnail.witness.config"[];
44
- private _cache?;
45
- private _semaphore;
46
- get cache(): LRUCache<string, _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
47
- http?: {
48
- dnsError?: string | undefined;
49
- ipAddress?: string | undefined;
50
- status?: number | undefined;
51
- } | undefined;
52
- mime?: {
53
- detected?: {
54
- ext?: string | undefined;
55
- mime?: string | undefined;
56
- } | undefined;
57
- invalid?: boolean | undefined;
58
- returned?: string | undefined;
59
- type?: string | undefined;
60
- } | undefined;
61
- sourceHash?: string | undefined;
62
- sourceUrl: string;
63
- url?: string | undefined;
64
- } & {
65
- schema: "network.xyo.image.thumbnail";
66
- }, unknown>;
67
- get encoding(): ImageThumbnailEncoding;
68
- get height(): number;
69
- get ipfGateway(): string;
70
- get maxAsyncProcesses(): number;
71
- get maxCacheBytes(): number;
72
- get maxCacheEntries(): number;
73
- get quality(): number;
74
- get width(): number;
75
- private static binaryToSha256;
76
- private static bufferFromDataUrl;
77
- /**
78
- * Returns the equivalent IPFS gateway URL for the supplied URL.
79
- * @param urlToCheck The URL to check
80
- * @returns If the supplied URL is an IPFS URL, it converts the URL to the
81
- * equivalent IPFS gateway URL. Otherwise, returns the original URL.
82
- */
83
- checkIpfsUrl(urlToCheck: string): string;
84
- protected observeHandler(payloads?: UrlPayload[]): Promise<ImageThumbnail[]>;
85
- private createThumbnailDataUrl;
86
- /**
87
- * Creates an image thumbnail from a video.
88
- * @param videoBuffer The input video buffer.
89
- * @returns An buffer containing an image thumbnail for the video.
90
- */
91
- private createThumbnailFromVideo;
92
- private fromHttp;
93
- }
94
-
95
- declare const ImageThumbnailDivinerConfigSchema: "network.xyo.image.thumbnail.diviner.config";
96
- type ImageThumbnailDivinerConfigSchema = typeof ImageThumbnailDivinerConfigSchema;
97
- type ImageThumbnailDivinerConfig = DivinerConfig<{
98
- archivist?: string;
99
- payloadDiviner?: string;
100
- payloadDivinerLimit?: number;
101
- pollFrequency?: number;
102
- schema: ImageThumbnailDivinerConfigSchema;
103
- }>;
104
-
105
- type ImageThumbnailDivinerParams = DivinerParams<AnyConfigSchema<ImageThumbnailDivinerConfig>>;
106
-
107
- declare class ImageThumbnailDiviner<TParams extends ImageThumbnailDivinerParams = ImageThumbnailDivinerParams> extends AbstractDiviner<TParams> {
108
- static configSchemas: ("network.xyo.image.thumbnail.diviner.config" | "network.xyo.diviner.config")[];
109
- private _archivistInstance;
110
- private _initializeArchivistConnectionIfNeededPromise;
111
- private _map;
112
- private _payloadDivinerInstance;
113
- private _pollId?;
114
- get archivist(): (_xyo_network_module_model.ArchivistModuleConfig & (_xyo_network_module_model.ArchivistModuleConfig & string)) | undefined;
115
- get payloadDiviner(): string | undefined;
116
- get payloadDivinerLimit(): number;
117
- get pollFrequency(): number | undefined;
118
- getArchivistInstance(): Promise<ArchivistInstance>;
119
- getPayloadDivinerInstance(): Promise<DivinerInstance | undefined>;
120
- protected divineHandler(payloads?: UrlPayload[]): Promise<ImageThumbnail[]>;
121
- protected initializeArchivistConnectionIfNeeded(): Promise<void>;
122
- protected loadMap(): Promise<void>;
123
- protected loadMapWithAll(): Promise<void>;
124
- protected loadMapWithPayloadDiviner(): Promise<void>;
125
- protected stopHandler(_timeout?: number | undefined): Promise<boolean>;
126
- private attachArchivistEvents;
127
- private getSafeMap;
128
- private poll;
129
- }
130
-
131
- declare const ImageThumbnailPlugin: () => _xyo_network_payloadset_plugin.PayloadSetDualPlugin<ImageThumbnailWitness<_xyo_network_core.BaseParamsFields & {
132
- account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
133
- config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
134
- accountDerivationPath?: string | undefined;
135
- readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
136
- readonly name?: string | undefined;
137
- readonly paging?: Record<string, {
138
- size?: number | undefined;
139
- }> | undefined;
140
- readonly schema: string;
141
- readonly security?: {
142
- readonly allowAnonymous?: boolean | undefined;
143
- readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
144
- readonly disallowed?: Record<string, string[]> | undefined;
145
- } | undefined;
146
- readonly sign?: boolean | undefined;
147
- readonly storeQueries?: boolean | undefined;
148
- readonly timestamp?: boolean | undefined;
149
- } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
150
- accountDerivationPath?: string | undefined;
151
- readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
152
- readonly name?: string | undefined;
153
- readonly paging?: Record<string, {
154
- size?: number | undefined;
155
- }> | undefined;
156
- readonly schema: "network.xyo.image.thumbnail.witness.config";
157
- readonly security?: {
158
- readonly allowAnonymous?: boolean | undefined;
159
- readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
160
- readonly disallowed?: Record<string, string[]> | undefined;
161
- } | undefined;
162
- readonly sign?: boolean | undefined;
163
- readonly storeQueries?: boolean | undefined;
164
- readonly timestamp?: boolean | undefined;
165
- } & Omit<{
166
- archivist?: string | undefined;
167
- schema: "network.xyo.image.thumbnail.witness.config";
168
- targetSet?: (_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_payload_model.PayloadSet & {
169
- schema: "network.xyo.payload.set";
170
- }) | undefined;
171
- } & {
172
- encoding?: ImageThumbnailEncoding | undefined;
173
- height?: number | undefined;
174
- ipfsGateway?: string | undefined;
175
- maxAsyncProcesses?: number | undefined;
176
- maxCacheBytes?: number | undefined;
177
- maxCacheEntries?: number | undefined;
178
- quality?: number | undefined;
179
- schema: "network.xyo.image.thumbnail.witness.config";
180
- width?: number | undefined;
181
- }, "schema"> & {
182
- schema: "network.xyo.image.thumbnail.witness.config";
183
- }, "schema"> & {
184
- schema: string;
185
- }, "schema"> & {
186
- schema: string;
187
- };
188
- ephemeralQueryAccountEnabled?: boolean | undefined;
189
- wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
190
- } & {
191
- loaders?: string[] | undefined;
192
- }>, ImageThumbnailDiviner<_xyo_network_core.BaseParamsFields & {
193
- account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
194
- config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
195
- accountDerivationPath?: string | undefined;
196
- readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
197
- readonly name?: string | undefined;
198
- readonly paging?: Record<string, {
199
- size?: number | undefined;
200
- }> | undefined;
201
- readonly schema: string;
202
- readonly security?: {
203
- readonly allowAnonymous?: boolean | undefined;
204
- readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
205
- readonly disallowed?: Record<string, string[]> | undefined;
206
- } | undefined;
207
- readonly sign?: boolean | undefined;
208
- readonly storeQueries?: boolean | undefined;
209
- readonly timestamp?: boolean | undefined;
210
- } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
211
- accountDerivationPath?: string | undefined;
212
- readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
213
- readonly name?: string | undefined;
214
- readonly paging?: Record<string, {
215
- size?: number | undefined;
216
- }> | undefined;
217
- readonly schema: "network.xyo.image.thumbnail.diviner.config";
218
- readonly security?: {
219
- readonly allowAnonymous?: boolean | undefined;
220
- readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
221
- readonly disallowed?: Record<string, string[]> | undefined;
222
- } | undefined;
223
- readonly sign?: boolean | undefined;
224
- readonly storeQueries?: boolean | undefined;
225
- readonly timestamp?: boolean | undefined;
226
- } & Omit<{
227
- schema: "network.xyo.image.thumbnail.diviner.config";
228
- } & Omit<{
229
- archivist?: string | undefined;
230
- payloadDiviner?: string | undefined;
231
- payloadDivinerLimit?: number | undefined;
232
- pollFrequency?: number | undefined;
233
- schema: "network.xyo.image.thumbnail.diviner.config";
234
- }, "schema">, "schema"> & {
235
- schema: "network.xyo.image.thumbnail.diviner.config";
236
- }, "schema"> & {
237
- schema: string;
238
- }, "schema"> & {
239
- schema: string;
240
- };
241
- ephemeralQueryAccountEnabled?: boolean | undefined;
242
- wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
243
- }>>;
244
-
245
- export { DnsError, ImageThumbnailDiviner, ImageThumbnailDivinerConfig, ImageThumbnailDivinerConfigSchema, ImageThumbnailDivinerParams, ImageThumbnailEncoding, ImageThumbnailPlugin, ImageThumbnailWitness, ImageThumbnailWitnessConfig, ImageThumbnailWitnessConfigSchema, ImageThumbnailWitnessError, ImageThumbnailWitnessParams, ImageThumbnailPlugin as default };
1
+ import { ImageThumbnailPlugin } from './Plugin';
2
+ export * from './Diviner';
3
+ export * from './Witness';
4
+ export { ImageThumbnailPlugin };
5
+ export default ImageThumbnailPlugin;
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,oBAAoB,EAAE,CAAA;AAG/B,eAAe,oBAAoB,CAAA"}
package/dist/index.d.ts CHANGED
@@ -1,245 +1,6 @@
1
- import * as _xyo_network_payloadset_plugin from '@xyo-network/payloadset-plugin';
2
- import * as _xyo_network_wallet_model from '@xyo-network/wallet-model';
3
- import { WitnessConfig, WitnessParams, AbstractWitness } from '@xyo-network/witness';
4
- import * as _xyo_network_payload_model from '@xyo-network/payload-model';
5
- import { ImageThumbnail } from '@xyo-network/image-thumbnail-payload-plugin';
6
- import { UrlPayload } from '@xyo-network/url-payload-plugin';
7
- import { LRUCache } from 'lru-cache';
8
- import { AnyConfigSchema } from '@xyo-network/module';
9
- import * as _xyo_network_module_model from '@xyo-network/module-model';
10
- import * as _xyo_network_account_model from '@xyo-network/account-model';
11
- import * as _xyo_network_core from '@xyo-network/core';
12
- import { AbstractDiviner } from '@xyo-network/abstract-diviner';
13
- import { ArchivistInstance } from '@xyo-network/archivist-model';
14
- import { DivinerConfig, DivinerParams, DivinerInstance } from '@xyo-network/diviner-model';
15
-
16
- declare const ImageThumbnailWitnessConfigSchema: "network.xyo.image.thumbnail.witness.config";
17
- type ImageThumbnailWitnessConfigSchema = typeof ImageThumbnailWitnessConfigSchema;
18
- type ImageThumbnailEncoding = 'PNG' | 'JPG' | 'GIF';
19
- type ImageThumbnailWitnessConfig = WitnessConfig<{
20
- encoding?: ImageThumbnailEncoding;
21
- height?: number;
22
- ipfsGateway?: string;
23
- maxAsyncProcesses?: number;
24
- maxCacheBytes?: number;
25
- maxCacheEntries?: number;
26
- quality?: number;
27
- schema: ImageThumbnailWitnessConfigSchema;
28
- width?: number;
29
- }>;
30
-
31
- type ImageThumbnailWitnessParams = WitnessParams<AnyConfigSchema<ImageThumbnailWitnessConfig>, {
32
- loaders?: string[];
33
- }>;
34
-
35
- interface ImageThumbnailWitnessError extends Error {
36
- name: 'ImageThumbnailWitnessError';
37
- url: string;
38
- }
39
- interface DnsError extends Error {
40
- code: string;
41
- }
42
- declare class ImageThumbnailWitness<TParams extends ImageThumbnailWitnessParams = ImageThumbnailWitnessParams> extends AbstractWitness<TParams> {
43
- static configSchemas: "network.xyo.image.thumbnail.witness.config"[];
44
- private _cache?;
45
- private _semaphore;
46
- get cache(): LRUCache<string, _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
47
- http?: {
48
- dnsError?: string | undefined;
49
- ipAddress?: string | undefined;
50
- status?: number | undefined;
51
- } | undefined;
52
- mime?: {
53
- detected?: {
54
- ext?: string | undefined;
55
- mime?: string | undefined;
56
- } | undefined;
57
- invalid?: boolean | undefined;
58
- returned?: string | undefined;
59
- type?: string | undefined;
60
- } | undefined;
61
- sourceHash?: string | undefined;
62
- sourceUrl: string;
63
- url?: string | undefined;
64
- } & {
65
- schema: "network.xyo.image.thumbnail";
66
- }, unknown>;
67
- get encoding(): ImageThumbnailEncoding;
68
- get height(): number;
69
- get ipfGateway(): string;
70
- get maxAsyncProcesses(): number;
71
- get maxCacheBytes(): number;
72
- get maxCacheEntries(): number;
73
- get quality(): number;
74
- get width(): number;
75
- private static binaryToSha256;
76
- private static bufferFromDataUrl;
77
- /**
78
- * Returns the equivalent IPFS gateway URL for the supplied URL.
79
- * @param urlToCheck The URL to check
80
- * @returns If the supplied URL is an IPFS URL, it converts the URL to the
81
- * equivalent IPFS gateway URL. Otherwise, returns the original URL.
82
- */
83
- checkIpfsUrl(urlToCheck: string): string;
84
- protected observeHandler(payloads?: UrlPayload[]): Promise<ImageThumbnail[]>;
85
- private createThumbnailDataUrl;
86
- /**
87
- * Creates an image thumbnail from a video.
88
- * @param videoBuffer The input video buffer.
89
- * @returns An buffer containing an image thumbnail for the video.
90
- */
91
- private createThumbnailFromVideo;
92
- private fromHttp;
93
- }
94
-
95
- declare const ImageThumbnailDivinerConfigSchema: "network.xyo.image.thumbnail.diviner.config";
96
- type ImageThumbnailDivinerConfigSchema = typeof ImageThumbnailDivinerConfigSchema;
97
- type ImageThumbnailDivinerConfig = DivinerConfig<{
98
- archivist?: string;
99
- payloadDiviner?: string;
100
- payloadDivinerLimit?: number;
101
- pollFrequency?: number;
102
- schema: ImageThumbnailDivinerConfigSchema;
103
- }>;
104
-
105
- type ImageThumbnailDivinerParams = DivinerParams<AnyConfigSchema<ImageThumbnailDivinerConfig>>;
106
-
107
- declare class ImageThumbnailDiviner<TParams extends ImageThumbnailDivinerParams = ImageThumbnailDivinerParams> extends AbstractDiviner<TParams> {
108
- static configSchemas: ("network.xyo.image.thumbnail.diviner.config" | "network.xyo.diviner.config")[];
109
- private _archivistInstance;
110
- private _initializeArchivistConnectionIfNeededPromise;
111
- private _map;
112
- private _payloadDivinerInstance;
113
- private _pollId?;
114
- get archivist(): (_xyo_network_module_model.ArchivistModuleConfig & (_xyo_network_module_model.ArchivistModuleConfig & string)) | undefined;
115
- get payloadDiviner(): string | undefined;
116
- get payloadDivinerLimit(): number;
117
- get pollFrequency(): number | undefined;
118
- getArchivistInstance(): Promise<ArchivistInstance>;
119
- getPayloadDivinerInstance(): Promise<DivinerInstance | undefined>;
120
- protected divineHandler(payloads?: UrlPayload[]): Promise<ImageThumbnail[]>;
121
- protected initializeArchivistConnectionIfNeeded(): Promise<void>;
122
- protected loadMap(): Promise<void>;
123
- protected loadMapWithAll(): Promise<void>;
124
- protected loadMapWithPayloadDiviner(): Promise<void>;
125
- protected stopHandler(_timeout?: number | undefined): Promise<boolean>;
126
- private attachArchivistEvents;
127
- private getSafeMap;
128
- private poll;
129
- }
130
-
131
- declare const ImageThumbnailPlugin: () => _xyo_network_payloadset_plugin.PayloadSetDualPlugin<ImageThumbnailWitness<_xyo_network_core.BaseParamsFields & {
132
- account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
133
- config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
134
- accountDerivationPath?: string | undefined;
135
- readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
136
- readonly name?: string | undefined;
137
- readonly paging?: Record<string, {
138
- size?: number | undefined;
139
- }> | undefined;
140
- readonly schema: string;
141
- readonly security?: {
142
- readonly allowAnonymous?: boolean | undefined;
143
- readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
144
- readonly disallowed?: Record<string, string[]> | undefined;
145
- } | undefined;
146
- readonly sign?: boolean | undefined;
147
- readonly storeQueries?: boolean | undefined;
148
- readonly timestamp?: boolean | undefined;
149
- } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
150
- accountDerivationPath?: string | undefined;
151
- readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
152
- readonly name?: string | undefined;
153
- readonly paging?: Record<string, {
154
- size?: number | undefined;
155
- }> | undefined;
156
- readonly schema: "network.xyo.image.thumbnail.witness.config";
157
- readonly security?: {
158
- readonly allowAnonymous?: boolean | undefined;
159
- readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
160
- readonly disallowed?: Record<string, string[]> | undefined;
161
- } | undefined;
162
- readonly sign?: boolean | undefined;
163
- readonly storeQueries?: boolean | undefined;
164
- readonly timestamp?: boolean | undefined;
165
- } & Omit<{
166
- archivist?: string | undefined;
167
- schema: "network.xyo.image.thumbnail.witness.config";
168
- targetSet?: (_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & _xyo_network_payload_model.PayloadSet & {
169
- schema: "network.xyo.payload.set";
170
- }) | undefined;
171
- } & {
172
- encoding?: ImageThumbnailEncoding | undefined;
173
- height?: number | undefined;
174
- ipfsGateway?: string | undefined;
175
- maxAsyncProcesses?: number | undefined;
176
- maxCacheBytes?: number | undefined;
177
- maxCacheEntries?: number | undefined;
178
- quality?: number | undefined;
179
- schema: "network.xyo.image.thumbnail.witness.config";
180
- width?: number | undefined;
181
- }, "schema"> & {
182
- schema: "network.xyo.image.thumbnail.witness.config";
183
- }, "schema"> & {
184
- schema: string;
185
- }, "schema"> & {
186
- schema: string;
187
- };
188
- ephemeralQueryAccountEnabled?: boolean | undefined;
189
- wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
190
- } & {
191
- loaders?: string[] | undefined;
192
- }>, ImageThumbnailDiviner<_xyo_network_core.BaseParamsFields & {
193
- account?: _xyo_network_account_model.AccountInstance | "random" | undefined;
194
- config: _xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
195
- accountDerivationPath?: string | undefined;
196
- readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
197
- readonly name?: string | undefined;
198
- readonly paging?: Record<string, {
199
- size?: number | undefined;
200
- }> | undefined;
201
- readonly schema: string;
202
- readonly security?: {
203
- readonly allowAnonymous?: boolean | undefined;
204
- readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
205
- readonly disallowed?: Record<string, string[]> | undefined;
206
- } | undefined;
207
- readonly sign?: boolean | undefined;
208
- readonly storeQueries?: boolean | undefined;
209
- readonly timestamp?: boolean | undefined;
210
- } & Omit<Omit<_xyo_network_payload_model.SchemaFields & _xyo_network_payload_model.PayloadFields & {
211
- accountDerivationPath?: string | undefined;
212
- readonly archivist?: _xyo_network_module_model.ArchivistModuleConfig | undefined;
213
- readonly name?: string | undefined;
214
- readonly paging?: Record<string, {
215
- size?: number | undefined;
216
- }> | undefined;
217
- readonly schema: "network.xyo.image.thumbnail.diviner.config";
218
- readonly security?: {
219
- readonly allowAnonymous?: boolean | undefined;
220
- readonly allowed?: Record<string, (string | _xyo_network_module_model.CosigningAddressSet)[]> | undefined;
221
- readonly disallowed?: Record<string, string[]> | undefined;
222
- } | undefined;
223
- readonly sign?: boolean | undefined;
224
- readonly storeQueries?: boolean | undefined;
225
- readonly timestamp?: boolean | undefined;
226
- } & Omit<{
227
- schema: "network.xyo.image.thumbnail.diviner.config";
228
- } & Omit<{
229
- archivist?: string | undefined;
230
- payloadDiviner?: string | undefined;
231
- payloadDivinerLimit?: number | undefined;
232
- pollFrequency?: number | undefined;
233
- schema: "network.xyo.image.thumbnail.diviner.config";
234
- }, "schema">, "schema"> & {
235
- schema: "network.xyo.image.thumbnail.diviner.config";
236
- }, "schema"> & {
237
- schema: string;
238
- }, "schema"> & {
239
- schema: string;
240
- };
241
- ephemeralQueryAccountEnabled?: boolean | undefined;
242
- wallet?: _xyo_network_wallet_model.WalletInstance | undefined;
243
- }>>;
244
-
245
- export { DnsError, ImageThumbnailDiviner, ImageThumbnailDivinerConfig, ImageThumbnailDivinerConfigSchema, ImageThumbnailDivinerParams, ImageThumbnailEncoding, ImageThumbnailPlugin, ImageThumbnailWitness, ImageThumbnailWitnessConfig, ImageThumbnailWitnessConfigSchema, ImageThumbnailWitnessError, ImageThumbnailWitnessParams, ImageThumbnailPlugin as default };
1
+ import { ImageThumbnailPlugin } from './Plugin';
2
+ export * from './Diviner';
3
+ export * from './Witness';
4
+ export { ImageThumbnailPlugin };
5
+ export default ImageThumbnailPlugin;
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,oBAAoB,EAAE,CAAA;AAG/B,eAAe,oBAAoB,CAAA"}