next-cloudinary 6.0.0-beta.6 → 6.0.0-beta.8
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/index.d.mts +16 -225
- package/dist/index.d.ts +16 -225
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2 -2
- package/dist/index.mjs.map +1 -1
- package/package.json +2 -1
package/dist/index.d.mts
CHANGED
|
@@ -2,6 +2,8 @@ import * as _cloudinary_util_url_loader_dist_schema_UX7RRFIR from '@cloudinary-u
|
|
|
2
2
|
import React, { MutableRefObject } from 'react';
|
|
3
3
|
import { ImageProps } from 'next/image';
|
|
4
4
|
import { ImageOptions, ConfigOptions, AnalyticsOptions, VideoOptions } from '@cloudinary-util/url-loader';
|
|
5
|
+
import { CloudinaryUploadWidgetOptions, CloudinaryUploadWidgetError, CloudinaryUploadWidgetResults, CloudinaryUploadWidgetInstanceMethods, CloudinaryVideoPlayerOptions, CloudinaryVideoPlayer, CloudinaryVideoPlayerOptionsLogo } from '@cloudinary-util/types';
|
|
6
|
+
export { CloudinaryUploadWidgetError, CloudinaryUploadWidgetInfo, CloudinaryUploadWidgetInstanceMethodCloseOptions, CloudinaryUploadWidgetInstanceMethodDestroyOptions, CloudinaryUploadWidgetInstanceMethodOpenOptions, CloudinaryUploadWidgetInstanceMethodUpdateOptions, CloudinaryUploadWidgetInstanceMethods, CloudinaryUploadWidgetOptions, CloudinaryUploadWidgetResults, CloudinaryUploadWidgetSources, CloudinaryVideoPlayer, CloudinaryVideoPlayerOptions, CloudinaryVideoPlayerOptionsColors, CloudinaryVideoPlayerOptionsLogo } from '@cloudinary-util/types';
|
|
5
7
|
|
|
6
8
|
type CldImageProps = Omit<ImageProps, 'src'> & ImageOptions & {
|
|
7
9
|
config?: ConfigOptions;
|
|
@@ -255,80 +257,17 @@ declare const CldOgImage: ({ excludeTags, twitterTitle, keys, ...props }: CldOgI
|
|
|
255
257
|
|
|
256
258
|
type CldUploadWidgetCloudinaryInstance = any;
|
|
257
259
|
type CldUploadWidgetWidgetInstance = any;
|
|
258
|
-
type CustomURL = `https://${string}.${string}`;
|
|
259
|
-
interface CldUploadWidgetResults {
|
|
260
|
-
event?: string;
|
|
261
|
-
info?: string | CldUploadWidgetInfo;
|
|
262
|
-
}
|
|
263
|
-
interface CldUploadWidgetInfo {
|
|
264
|
-
access_mode: 'public' | 'authenticated';
|
|
265
|
-
api_key: string;
|
|
266
|
-
asset_id: string;
|
|
267
|
-
batchId: string;
|
|
268
|
-
bytes: number;
|
|
269
|
-
context: Record<string, Record<string, string>>;
|
|
270
|
-
created_at: string;
|
|
271
|
-
etag: string;
|
|
272
|
-
folder: string;
|
|
273
|
-
format: string;
|
|
274
|
-
height: number;
|
|
275
|
-
hook_execution: Record<string, unknown>;
|
|
276
|
-
id: string;
|
|
277
|
-
info: Record<string, unknown>;
|
|
278
|
-
original_filename: string;
|
|
279
|
-
pages: number;
|
|
280
|
-
path: string;
|
|
281
|
-
placeholder: boolean;
|
|
282
|
-
public_id: string;
|
|
283
|
-
resource_type: 'image' | 'raw' | 'video' | 'auto';
|
|
284
|
-
secure_url: string;
|
|
285
|
-
signature: string;
|
|
286
|
-
tags: string[];
|
|
287
|
-
thumbnail_url: string;
|
|
288
|
-
type: 'upload' | 'private' | 'authenticated';
|
|
289
|
-
url: string;
|
|
290
|
-
version: number;
|
|
291
|
-
width: number;
|
|
292
|
-
[key: string]: unknown;
|
|
293
|
-
}
|
|
294
|
-
type CldUploadWidgetDestroyInstanceMethodOptions = {
|
|
295
|
-
removeThumbnails: boolean;
|
|
296
|
-
};
|
|
297
|
-
type CldUploadWidgetCloseInstanceMethodOptions = {
|
|
298
|
-
quiet: boolean;
|
|
299
|
-
};
|
|
300
|
-
type CldUploadWidgetOpenInstanceMethodOptions = {
|
|
301
|
-
files: CustomURL[];
|
|
302
|
-
};
|
|
303
|
-
type CldUploadWidgetOpenWidgetSources = 'local' | 'url' | 'camera' | 'image_search' | 'google_drive' | 'dropbox' | 'facebook' | 'instagram' | 'shutterstock' | 'getty' | 'istock' | 'unsplash' | null;
|
|
304
|
-
type CldUploadWidgetUpdateInstanceMethodOptions = Omit<CldUploadWidgetPropsOptions, "secure" | "uploadSignature" | "getTags" | "preBatch" | "inlineContainer" | "fieldName"> & {
|
|
305
|
-
cloudName: string;
|
|
306
|
-
uploadPreset: string;
|
|
307
|
-
};
|
|
308
|
-
interface CldUploadWidgetInstanceMethods {
|
|
309
|
-
close: (options?: CldUploadWidgetCloseInstanceMethodOptions) => void;
|
|
310
|
-
destroy: (options?: CldUploadWidgetDestroyInstanceMethodOptions) => Promise<void>;
|
|
311
|
-
hide: () => void;
|
|
312
|
-
isDestroyed: () => boolean;
|
|
313
|
-
isMinimized: () => boolean;
|
|
314
|
-
isShowing: () => boolean;
|
|
315
|
-
minimize: () => void;
|
|
316
|
-
open: (widgetSource?: CldUploadWidgetOpenWidgetSources, options?: CldUploadWidgetOpenInstanceMethodOptions) => void;
|
|
317
|
-
show: () => void;
|
|
318
|
-
update: (options: CldUploadWidgetUpdateInstanceMethodOptions) => void;
|
|
319
|
-
}
|
|
320
|
-
type CldUploadWidgetError = {
|
|
321
|
-
status: string;
|
|
322
|
-
statusText: string;
|
|
323
|
-
} | string | null;
|
|
324
260
|
interface CldUploadWidgetProps {
|
|
325
261
|
children?: ({ cloudinary, widget, open, results, error }: CldUploadWidgetPropsChildren) => JSX.Element;
|
|
326
262
|
onError?: CldUploadEventCallbackError;
|
|
327
263
|
onOpen?: CldUploadEventCallbackWidgetOnly;
|
|
264
|
+
/**
|
|
265
|
+
* @deprecated use onSuccess instead
|
|
266
|
+
*/
|
|
328
267
|
onUpload?: CldUploadEventCallbackNoOptions;
|
|
329
268
|
onAbort?: CldUploadEventCallback;
|
|
330
269
|
onBatchCancelled?: CldUploadEventCallback;
|
|
331
|
-
onClose?:
|
|
270
|
+
onClose?: CldUploadEventCallback;
|
|
332
271
|
onDisplayChanged?: CldUploadEventCallback;
|
|
333
272
|
onPublicId?: CldUploadEventCallback;
|
|
334
273
|
onQueuesEnd?: CldUploadEventCallback;
|
|
@@ -339,94 +278,26 @@ interface CldUploadWidgetProps {
|
|
|
339
278
|
onSuccess?: CldUploadEventCallback;
|
|
340
279
|
onTags?: CldUploadEventCallback;
|
|
341
280
|
onUploadAdded?: CldUploadEventCallback;
|
|
342
|
-
options?:
|
|
281
|
+
options?: CloudinaryUploadWidgetOptions;
|
|
343
282
|
signatureEndpoint?: URL | RequestInfo;
|
|
344
283
|
uploadPreset?: string;
|
|
345
284
|
}
|
|
346
285
|
type CldUploadWidgetPropsChildren = {
|
|
347
286
|
cloudinary: CldUploadWidgetCloudinaryInstance;
|
|
348
287
|
widget: CldUploadWidgetWidgetInstance;
|
|
349
|
-
error?:
|
|
288
|
+
error?: CloudinaryUploadWidgetError;
|
|
350
289
|
isLoading?: boolean;
|
|
351
|
-
results?:
|
|
352
|
-
} &
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
key: string;
|
|
356
|
-
iv: string;
|
|
357
|
-
};
|
|
358
|
-
defaultSource?: string;
|
|
359
|
-
maxFiles?: number;
|
|
360
|
-
multiple?: boolean;
|
|
361
|
-
sources?: Array<"camera" | "dropbox" | "facebook" | "gettyimages" | "google_drive" | "image_search" | "instagram" | "istock" | "local" | "shutterstock" | "unsplash" | "url">;
|
|
362
|
-
cropping?: boolean;
|
|
363
|
-
croppingAspectRatio?: number;
|
|
364
|
-
croppingCoordinatesMode?: string;
|
|
365
|
-
croppingDefaultSelectionRatio?: number;
|
|
366
|
-
croppingShowBackButton?: boolean;
|
|
367
|
-
croppingShowDimensions?: boolean;
|
|
368
|
-
showSkipCropButton?: boolean;
|
|
369
|
-
dropboxAppKey?: string;
|
|
370
|
-
facebookAppId?: string;
|
|
371
|
-
googleApiKey?: string;
|
|
372
|
-
googleDriveClientId?: string;
|
|
373
|
-
instagramClientId?: string;
|
|
374
|
-
searchByRights?: boolean;
|
|
375
|
-
searchBySites?: Array<string>;
|
|
376
|
-
context?: object;
|
|
377
|
-
folder?: string;
|
|
378
|
-
publicId?: string;
|
|
379
|
-
resourceType?: string;
|
|
380
|
-
tags?: Array<string>;
|
|
381
|
-
uploadSignature?: string | Function;
|
|
382
|
-
uploadSignatureTimestamp?: number;
|
|
383
|
-
clientAllowedFormats?: Array<string>;
|
|
384
|
-
croppingValidateDimensions?: boolean;
|
|
385
|
-
maxChunkSize?: number;
|
|
386
|
-
maxImageFileSize?: number;
|
|
387
|
-
maxImageHeight?: number;
|
|
388
|
-
maxImageWidth?: number;
|
|
389
|
-
maxFileSize?: number;
|
|
390
|
-
maxRawFileSize?: number;
|
|
391
|
-
maxVideoFileSize?: number;
|
|
392
|
-
minImageHeight?: number;
|
|
393
|
-
minImageWidth?: number;
|
|
394
|
-
validateMaxWidthHeight?: boolean;
|
|
395
|
-
fieldName?: string;
|
|
396
|
-
form?: string;
|
|
397
|
-
thumbnails?: string;
|
|
398
|
-
thumbnailTransformation?: string | Array<object>;
|
|
399
|
-
buttonCaption?: string;
|
|
400
|
-
buttonClass?: string;
|
|
401
|
-
text?: object;
|
|
402
|
-
theme?: string;
|
|
403
|
-
styles?: object;
|
|
404
|
-
autoMinimize?: boolean;
|
|
405
|
-
getTags?: Function;
|
|
406
|
-
getUploadPresets?: Function;
|
|
407
|
-
inlineContainer?: any;
|
|
408
|
-
language?: string;
|
|
409
|
-
preBatch?: Function;
|
|
410
|
-
prepareUploadParams?: Function;
|
|
411
|
-
queueViewPosition?: string;
|
|
412
|
-
showAdvancedOptions?: boolean;
|
|
413
|
-
showCompletedButton?: boolean;
|
|
414
|
-
showInsecurePreview?: boolean;
|
|
415
|
-
showPoweredBy?: boolean;
|
|
416
|
-
showUploadMoreButton?: boolean;
|
|
417
|
-
singleUploadAutoClose?: boolean;
|
|
418
|
-
detection?: string;
|
|
419
|
-
on_success?: string;
|
|
420
|
-
}
|
|
421
|
-
type CldUploadEventCallback = (results: CldUploadWidgetResults, widget: CldUploadEventCallbackWidget) => void;
|
|
422
|
-
type CldUploadEventCallbackNoOptions = (results: CldUploadWidgetResults, widget: CldUploadWidgetWidgetInstance) => void;
|
|
290
|
+
results?: CloudinaryUploadWidgetResults;
|
|
291
|
+
} & CloudinaryUploadWidgetInstanceMethods;
|
|
292
|
+
type CldUploadEventCallback = (results: CloudinaryUploadWidgetResults, widget: CldUploadEventCallbackWidget) => void;
|
|
293
|
+
type CldUploadEventCallbackNoOptions = (results: CloudinaryUploadWidgetResults, widget: CldUploadWidgetWidgetInstance) => void;
|
|
423
294
|
type CldUploadEventCallbackWidgetOnly = (widget: CldUploadWidgetWidgetInstance) => void;
|
|
424
|
-
type CldUploadEventCallbackError = (error:
|
|
295
|
+
type CldUploadEventCallbackError = (error: CloudinaryUploadWidgetError, widget: CldUploadEventCallbackWidget) => void;
|
|
425
296
|
type CldUploadEventCallbackWidget = {
|
|
426
297
|
widget: CldUploadWidgetWidgetInstance;
|
|
427
|
-
} &
|
|
298
|
+
} & CloudinaryUploadWidgetInstanceMethods;
|
|
428
299
|
|
|
429
|
-
declare const CldUploadWidget: ({ children,
|
|
300
|
+
declare const CldUploadWidget: ({ children, onError, onOpen, onUpload, options, signatureEndpoint, uploadPreset, ...props }: CldUploadWidgetProps) => React.JSX.Element;
|
|
430
301
|
|
|
431
302
|
interface CldUploadButtonProps extends Omit<CldUploadWidgetProps, 'children'> {
|
|
432
303
|
className?: string;
|
|
@@ -435,84 +306,6 @@ interface CldUploadButtonProps extends Omit<CldUploadWidgetProps, 'children'> {
|
|
|
435
306
|
}
|
|
436
307
|
declare const CldUploadButton: ({ className, children, onClick, onError, onOpen, onUpload, onAbort, onBatchCancelled, onClose, onDisplayChanged, onPublicId, onQueuesEnd, onQueuesStart, onRetry, onShowCompleted, onSourceChanged, onSuccess, onTags, onUploadAdded, options, signatureEndpoint, uploadPreset, ...props }: CldUploadButtonProps) => React.JSX.Element;
|
|
437
308
|
|
|
438
|
-
interface CloudinaryVideoPlayer {
|
|
439
|
-
on: Function;
|
|
440
|
-
}
|
|
441
|
-
interface CloudinaryVideoPlayerOptionsLogo {
|
|
442
|
-
logoImageUrl?: string;
|
|
443
|
-
logoOnclickUrl?: string;
|
|
444
|
-
showLogo?: boolean;
|
|
445
|
-
}
|
|
446
|
-
interface CloudinaryVideoPlayerOptions extends CloudinaryVideoPlayerOptionsLogo {
|
|
447
|
-
aiHighlightsGraph?: boolean;
|
|
448
|
-
bigPlayButton?: boolean | string;
|
|
449
|
-
colors?: CloudinaryVideoPlayerOptionsColors;
|
|
450
|
-
controlBar?: {
|
|
451
|
-
pictureInPictureToggle?: boolean;
|
|
452
|
-
chaptersButton?: boolean;
|
|
453
|
-
};
|
|
454
|
-
controls?: boolean;
|
|
455
|
-
floatingWhenNotVisible?: string;
|
|
456
|
-
fluid?: boolean;
|
|
457
|
-
fontFace?: string;
|
|
458
|
-
hideContextMenu?: boolean;
|
|
459
|
-
interactionAreas?: any;
|
|
460
|
-
playbackRates?: Array<any>;
|
|
461
|
-
playlistWidget?: {
|
|
462
|
-
direction?: string;
|
|
463
|
-
total?: string;
|
|
464
|
-
};
|
|
465
|
-
posterOptions?: CloudinaryVideoPlayerOptionPosterOptions;
|
|
466
|
-
showJumpControls?: boolean;
|
|
467
|
-
seekThumbnails?: boolean;
|
|
468
|
-
videoJS?: object;
|
|
469
|
-
autoPlay?: string | boolean | undefined;
|
|
470
|
-
autoplay?: string | boolean | undefined;
|
|
471
|
-
autoplayMode?: string;
|
|
472
|
-
autoShowRecommendations?: boolean;
|
|
473
|
-
loop?: boolean;
|
|
474
|
-
maxTries?: Number;
|
|
475
|
-
muted?: boolean;
|
|
476
|
-
playedEventPercents?: number[];
|
|
477
|
-
playedEventTimes?: null | Array<any>;
|
|
478
|
-
playsinline?: boolean;
|
|
479
|
-
videoTimeout?: number;
|
|
480
|
-
withCredentials?: boolean;
|
|
481
|
-
chapters?: object;
|
|
482
|
-
preload?: string;
|
|
483
|
-
publicId?: string;
|
|
484
|
-
sourceTransformation?: object;
|
|
485
|
-
sourceTypes?: Array<string>;
|
|
486
|
-
transformation?: Array<object> | object;
|
|
487
|
-
ads?: {
|
|
488
|
-
adTagUrl?: string;
|
|
489
|
-
adsInPlaylist?: string;
|
|
490
|
-
showCountdown?: boolean;
|
|
491
|
-
adLabel?: string;
|
|
492
|
-
locale?: string;
|
|
493
|
-
prerollTimeout?: number;
|
|
494
|
-
postrollTimeout?: number;
|
|
495
|
-
};
|
|
496
|
-
analytics?: boolean;
|
|
497
|
-
allowUsageReport?: Boolean;
|
|
498
|
-
cloud_name?: string;
|
|
499
|
-
cname?: string;
|
|
500
|
-
privateCdn?: boolean;
|
|
501
|
-
queryParams?: Record<string, string | number | boolean> | string;
|
|
502
|
-
secure?: boolean;
|
|
503
|
-
secureDistribution?: string;
|
|
504
|
-
language?: string;
|
|
505
|
-
languages?: Record<string, object>;
|
|
506
|
-
}
|
|
507
|
-
interface CloudinaryVideoPlayerOptionsColors {
|
|
508
|
-
accent?: string;
|
|
509
|
-
base?: string;
|
|
510
|
-
text?: string;
|
|
511
|
-
}
|
|
512
|
-
interface CloudinaryVideoPlayerOptionPosterOptions {
|
|
513
|
-
publicId: string;
|
|
514
|
-
}
|
|
515
|
-
|
|
516
309
|
/**
|
|
517
310
|
* getCldImageUrl
|
|
518
311
|
*/
|
|
@@ -547,8 +340,6 @@ type CldVideoPlayerProps = Omit<CloudinaryVideoPlayerOptions, "cloud_name" | "au
|
|
|
547
340
|
quality?: string | number;
|
|
548
341
|
width: string | number;
|
|
549
342
|
};
|
|
550
|
-
interface CldVideoPlayerPropsColors extends CloudinaryVideoPlayerOptionsColors {
|
|
551
|
-
}
|
|
552
343
|
interface CldVideoPlayerPropsLogo {
|
|
553
344
|
imageUrl?: CloudinaryVideoPlayerOptionsLogo['logoImageUrl'];
|
|
554
345
|
logo?: boolean;
|
|
@@ -578,4 +369,4 @@ declare function cloudinaryLoader({ loaderOptions, imageProps, cldOptions, cldCo
|
|
|
578
369
|
type GetCldOgImageUrlOptions = GetCldImageUrlOptions;
|
|
579
370
|
declare function getCldOgImageUrl(options: GetCldOgImageUrlOptions): string;
|
|
580
371
|
|
|
581
|
-
export { CldImage, type CldImageProps, CldOgImage, type CldOgImageProps, CldUploadButton, type CldUploadButtonProps, CldUploadWidget, type
|
|
372
|
+
export { CldImage, type CldImageProps, CldOgImage, type CldOgImageProps, CldUploadButton, type CldUploadButtonProps, CldUploadWidget, type CldUploadWidgetProps, type CldUploadWidgetPropsChildren, CldVideoPlayer, type CldVideoPlayerProps, type CldVideoPlayerPropsLogo, type CloudinaryLoader, type CloudinaryLoaderCldOptions, type CloudinaryLoaderLoaderOptions, type GetCldImageUrlAnalytics, type GetCldImageUrlConfig, type GetCldImageUrlOptions, type GetCldOgImageUrlOptions, type GetCldVideoUrlAnalytics, type GetCldVideoUrlConfig, type GetCldVideoUrlOptions, cloudinaryLoader, getCldImageUrl, getCldOgImageUrl, getCldVideoUrl };
|
package/dist/index.d.ts
CHANGED
|
@@ -2,6 +2,8 @@ import * as _cloudinary_util_url_loader_dist_schema_UX7RRFIR from '@cloudinary-u
|
|
|
2
2
|
import React, { MutableRefObject } from 'react';
|
|
3
3
|
import { ImageProps } from 'next/image';
|
|
4
4
|
import { ImageOptions, ConfigOptions, AnalyticsOptions, VideoOptions } from '@cloudinary-util/url-loader';
|
|
5
|
+
import { CloudinaryUploadWidgetOptions, CloudinaryUploadWidgetError, CloudinaryUploadWidgetResults, CloudinaryUploadWidgetInstanceMethods, CloudinaryVideoPlayerOptions, CloudinaryVideoPlayer, CloudinaryVideoPlayerOptionsLogo } from '@cloudinary-util/types';
|
|
6
|
+
export { CloudinaryUploadWidgetError, CloudinaryUploadWidgetInfo, CloudinaryUploadWidgetInstanceMethodCloseOptions, CloudinaryUploadWidgetInstanceMethodDestroyOptions, CloudinaryUploadWidgetInstanceMethodOpenOptions, CloudinaryUploadWidgetInstanceMethodUpdateOptions, CloudinaryUploadWidgetInstanceMethods, CloudinaryUploadWidgetOptions, CloudinaryUploadWidgetResults, CloudinaryUploadWidgetSources, CloudinaryVideoPlayer, CloudinaryVideoPlayerOptions, CloudinaryVideoPlayerOptionsColors, CloudinaryVideoPlayerOptionsLogo } from '@cloudinary-util/types';
|
|
5
7
|
|
|
6
8
|
type CldImageProps = Omit<ImageProps, 'src'> & ImageOptions & {
|
|
7
9
|
config?: ConfigOptions;
|
|
@@ -255,80 +257,17 @@ declare const CldOgImage: ({ excludeTags, twitterTitle, keys, ...props }: CldOgI
|
|
|
255
257
|
|
|
256
258
|
type CldUploadWidgetCloudinaryInstance = any;
|
|
257
259
|
type CldUploadWidgetWidgetInstance = any;
|
|
258
|
-
type CustomURL = `https://${string}.${string}`;
|
|
259
|
-
interface CldUploadWidgetResults {
|
|
260
|
-
event?: string;
|
|
261
|
-
info?: string | CldUploadWidgetInfo;
|
|
262
|
-
}
|
|
263
|
-
interface CldUploadWidgetInfo {
|
|
264
|
-
access_mode: 'public' | 'authenticated';
|
|
265
|
-
api_key: string;
|
|
266
|
-
asset_id: string;
|
|
267
|
-
batchId: string;
|
|
268
|
-
bytes: number;
|
|
269
|
-
context: Record<string, Record<string, string>>;
|
|
270
|
-
created_at: string;
|
|
271
|
-
etag: string;
|
|
272
|
-
folder: string;
|
|
273
|
-
format: string;
|
|
274
|
-
height: number;
|
|
275
|
-
hook_execution: Record<string, unknown>;
|
|
276
|
-
id: string;
|
|
277
|
-
info: Record<string, unknown>;
|
|
278
|
-
original_filename: string;
|
|
279
|
-
pages: number;
|
|
280
|
-
path: string;
|
|
281
|
-
placeholder: boolean;
|
|
282
|
-
public_id: string;
|
|
283
|
-
resource_type: 'image' | 'raw' | 'video' | 'auto';
|
|
284
|
-
secure_url: string;
|
|
285
|
-
signature: string;
|
|
286
|
-
tags: string[];
|
|
287
|
-
thumbnail_url: string;
|
|
288
|
-
type: 'upload' | 'private' | 'authenticated';
|
|
289
|
-
url: string;
|
|
290
|
-
version: number;
|
|
291
|
-
width: number;
|
|
292
|
-
[key: string]: unknown;
|
|
293
|
-
}
|
|
294
|
-
type CldUploadWidgetDestroyInstanceMethodOptions = {
|
|
295
|
-
removeThumbnails: boolean;
|
|
296
|
-
};
|
|
297
|
-
type CldUploadWidgetCloseInstanceMethodOptions = {
|
|
298
|
-
quiet: boolean;
|
|
299
|
-
};
|
|
300
|
-
type CldUploadWidgetOpenInstanceMethodOptions = {
|
|
301
|
-
files: CustomURL[];
|
|
302
|
-
};
|
|
303
|
-
type CldUploadWidgetOpenWidgetSources = 'local' | 'url' | 'camera' | 'image_search' | 'google_drive' | 'dropbox' | 'facebook' | 'instagram' | 'shutterstock' | 'getty' | 'istock' | 'unsplash' | null;
|
|
304
|
-
type CldUploadWidgetUpdateInstanceMethodOptions = Omit<CldUploadWidgetPropsOptions, "secure" | "uploadSignature" | "getTags" | "preBatch" | "inlineContainer" | "fieldName"> & {
|
|
305
|
-
cloudName: string;
|
|
306
|
-
uploadPreset: string;
|
|
307
|
-
};
|
|
308
|
-
interface CldUploadWidgetInstanceMethods {
|
|
309
|
-
close: (options?: CldUploadWidgetCloseInstanceMethodOptions) => void;
|
|
310
|
-
destroy: (options?: CldUploadWidgetDestroyInstanceMethodOptions) => Promise<void>;
|
|
311
|
-
hide: () => void;
|
|
312
|
-
isDestroyed: () => boolean;
|
|
313
|
-
isMinimized: () => boolean;
|
|
314
|
-
isShowing: () => boolean;
|
|
315
|
-
minimize: () => void;
|
|
316
|
-
open: (widgetSource?: CldUploadWidgetOpenWidgetSources, options?: CldUploadWidgetOpenInstanceMethodOptions) => void;
|
|
317
|
-
show: () => void;
|
|
318
|
-
update: (options: CldUploadWidgetUpdateInstanceMethodOptions) => void;
|
|
319
|
-
}
|
|
320
|
-
type CldUploadWidgetError = {
|
|
321
|
-
status: string;
|
|
322
|
-
statusText: string;
|
|
323
|
-
} | string | null;
|
|
324
260
|
interface CldUploadWidgetProps {
|
|
325
261
|
children?: ({ cloudinary, widget, open, results, error }: CldUploadWidgetPropsChildren) => JSX.Element;
|
|
326
262
|
onError?: CldUploadEventCallbackError;
|
|
327
263
|
onOpen?: CldUploadEventCallbackWidgetOnly;
|
|
264
|
+
/**
|
|
265
|
+
* @deprecated use onSuccess instead
|
|
266
|
+
*/
|
|
328
267
|
onUpload?: CldUploadEventCallbackNoOptions;
|
|
329
268
|
onAbort?: CldUploadEventCallback;
|
|
330
269
|
onBatchCancelled?: CldUploadEventCallback;
|
|
331
|
-
onClose?:
|
|
270
|
+
onClose?: CldUploadEventCallback;
|
|
332
271
|
onDisplayChanged?: CldUploadEventCallback;
|
|
333
272
|
onPublicId?: CldUploadEventCallback;
|
|
334
273
|
onQueuesEnd?: CldUploadEventCallback;
|
|
@@ -339,94 +278,26 @@ interface CldUploadWidgetProps {
|
|
|
339
278
|
onSuccess?: CldUploadEventCallback;
|
|
340
279
|
onTags?: CldUploadEventCallback;
|
|
341
280
|
onUploadAdded?: CldUploadEventCallback;
|
|
342
|
-
options?:
|
|
281
|
+
options?: CloudinaryUploadWidgetOptions;
|
|
343
282
|
signatureEndpoint?: URL | RequestInfo;
|
|
344
283
|
uploadPreset?: string;
|
|
345
284
|
}
|
|
346
285
|
type CldUploadWidgetPropsChildren = {
|
|
347
286
|
cloudinary: CldUploadWidgetCloudinaryInstance;
|
|
348
287
|
widget: CldUploadWidgetWidgetInstance;
|
|
349
|
-
error?:
|
|
288
|
+
error?: CloudinaryUploadWidgetError;
|
|
350
289
|
isLoading?: boolean;
|
|
351
|
-
results?:
|
|
352
|
-
} &
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
key: string;
|
|
356
|
-
iv: string;
|
|
357
|
-
};
|
|
358
|
-
defaultSource?: string;
|
|
359
|
-
maxFiles?: number;
|
|
360
|
-
multiple?: boolean;
|
|
361
|
-
sources?: Array<"camera" | "dropbox" | "facebook" | "gettyimages" | "google_drive" | "image_search" | "instagram" | "istock" | "local" | "shutterstock" | "unsplash" | "url">;
|
|
362
|
-
cropping?: boolean;
|
|
363
|
-
croppingAspectRatio?: number;
|
|
364
|
-
croppingCoordinatesMode?: string;
|
|
365
|
-
croppingDefaultSelectionRatio?: number;
|
|
366
|
-
croppingShowBackButton?: boolean;
|
|
367
|
-
croppingShowDimensions?: boolean;
|
|
368
|
-
showSkipCropButton?: boolean;
|
|
369
|
-
dropboxAppKey?: string;
|
|
370
|
-
facebookAppId?: string;
|
|
371
|
-
googleApiKey?: string;
|
|
372
|
-
googleDriveClientId?: string;
|
|
373
|
-
instagramClientId?: string;
|
|
374
|
-
searchByRights?: boolean;
|
|
375
|
-
searchBySites?: Array<string>;
|
|
376
|
-
context?: object;
|
|
377
|
-
folder?: string;
|
|
378
|
-
publicId?: string;
|
|
379
|
-
resourceType?: string;
|
|
380
|
-
tags?: Array<string>;
|
|
381
|
-
uploadSignature?: string | Function;
|
|
382
|
-
uploadSignatureTimestamp?: number;
|
|
383
|
-
clientAllowedFormats?: Array<string>;
|
|
384
|
-
croppingValidateDimensions?: boolean;
|
|
385
|
-
maxChunkSize?: number;
|
|
386
|
-
maxImageFileSize?: number;
|
|
387
|
-
maxImageHeight?: number;
|
|
388
|
-
maxImageWidth?: number;
|
|
389
|
-
maxFileSize?: number;
|
|
390
|
-
maxRawFileSize?: number;
|
|
391
|
-
maxVideoFileSize?: number;
|
|
392
|
-
minImageHeight?: number;
|
|
393
|
-
minImageWidth?: number;
|
|
394
|
-
validateMaxWidthHeight?: boolean;
|
|
395
|
-
fieldName?: string;
|
|
396
|
-
form?: string;
|
|
397
|
-
thumbnails?: string;
|
|
398
|
-
thumbnailTransformation?: string | Array<object>;
|
|
399
|
-
buttonCaption?: string;
|
|
400
|
-
buttonClass?: string;
|
|
401
|
-
text?: object;
|
|
402
|
-
theme?: string;
|
|
403
|
-
styles?: object;
|
|
404
|
-
autoMinimize?: boolean;
|
|
405
|
-
getTags?: Function;
|
|
406
|
-
getUploadPresets?: Function;
|
|
407
|
-
inlineContainer?: any;
|
|
408
|
-
language?: string;
|
|
409
|
-
preBatch?: Function;
|
|
410
|
-
prepareUploadParams?: Function;
|
|
411
|
-
queueViewPosition?: string;
|
|
412
|
-
showAdvancedOptions?: boolean;
|
|
413
|
-
showCompletedButton?: boolean;
|
|
414
|
-
showInsecurePreview?: boolean;
|
|
415
|
-
showPoweredBy?: boolean;
|
|
416
|
-
showUploadMoreButton?: boolean;
|
|
417
|
-
singleUploadAutoClose?: boolean;
|
|
418
|
-
detection?: string;
|
|
419
|
-
on_success?: string;
|
|
420
|
-
}
|
|
421
|
-
type CldUploadEventCallback = (results: CldUploadWidgetResults, widget: CldUploadEventCallbackWidget) => void;
|
|
422
|
-
type CldUploadEventCallbackNoOptions = (results: CldUploadWidgetResults, widget: CldUploadWidgetWidgetInstance) => void;
|
|
290
|
+
results?: CloudinaryUploadWidgetResults;
|
|
291
|
+
} & CloudinaryUploadWidgetInstanceMethods;
|
|
292
|
+
type CldUploadEventCallback = (results: CloudinaryUploadWidgetResults, widget: CldUploadEventCallbackWidget) => void;
|
|
293
|
+
type CldUploadEventCallbackNoOptions = (results: CloudinaryUploadWidgetResults, widget: CldUploadWidgetWidgetInstance) => void;
|
|
423
294
|
type CldUploadEventCallbackWidgetOnly = (widget: CldUploadWidgetWidgetInstance) => void;
|
|
424
|
-
type CldUploadEventCallbackError = (error:
|
|
295
|
+
type CldUploadEventCallbackError = (error: CloudinaryUploadWidgetError, widget: CldUploadEventCallbackWidget) => void;
|
|
425
296
|
type CldUploadEventCallbackWidget = {
|
|
426
297
|
widget: CldUploadWidgetWidgetInstance;
|
|
427
|
-
} &
|
|
298
|
+
} & CloudinaryUploadWidgetInstanceMethods;
|
|
428
299
|
|
|
429
|
-
declare const CldUploadWidget: ({ children,
|
|
300
|
+
declare const CldUploadWidget: ({ children, onError, onOpen, onUpload, options, signatureEndpoint, uploadPreset, ...props }: CldUploadWidgetProps) => React.JSX.Element;
|
|
430
301
|
|
|
431
302
|
interface CldUploadButtonProps extends Omit<CldUploadWidgetProps, 'children'> {
|
|
432
303
|
className?: string;
|
|
@@ -435,84 +306,6 @@ interface CldUploadButtonProps extends Omit<CldUploadWidgetProps, 'children'> {
|
|
|
435
306
|
}
|
|
436
307
|
declare const CldUploadButton: ({ className, children, onClick, onError, onOpen, onUpload, onAbort, onBatchCancelled, onClose, onDisplayChanged, onPublicId, onQueuesEnd, onQueuesStart, onRetry, onShowCompleted, onSourceChanged, onSuccess, onTags, onUploadAdded, options, signatureEndpoint, uploadPreset, ...props }: CldUploadButtonProps) => React.JSX.Element;
|
|
437
308
|
|
|
438
|
-
interface CloudinaryVideoPlayer {
|
|
439
|
-
on: Function;
|
|
440
|
-
}
|
|
441
|
-
interface CloudinaryVideoPlayerOptionsLogo {
|
|
442
|
-
logoImageUrl?: string;
|
|
443
|
-
logoOnclickUrl?: string;
|
|
444
|
-
showLogo?: boolean;
|
|
445
|
-
}
|
|
446
|
-
interface CloudinaryVideoPlayerOptions extends CloudinaryVideoPlayerOptionsLogo {
|
|
447
|
-
aiHighlightsGraph?: boolean;
|
|
448
|
-
bigPlayButton?: boolean | string;
|
|
449
|
-
colors?: CloudinaryVideoPlayerOptionsColors;
|
|
450
|
-
controlBar?: {
|
|
451
|
-
pictureInPictureToggle?: boolean;
|
|
452
|
-
chaptersButton?: boolean;
|
|
453
|
-
};
|
|
454
|
-
controls?: boolean;
|
|
455
|
-
floatingWhenNotVisible?: string;
|
|
456
|
-
fluid?: boolean;
|
|
457
|
-
fontFace?: string;
|
|
458
|
-
hideContextMenu?: boolean;
|
|
459
|
-
interactionAreas?: any;
|
|
460
|
-
playbackRates?: Array<any>;
|
|
461
|
-
playlistWidget?: {
|
|
462
|
-
direction?: string;
|
|
463
|
-
total?: string;
|
|
464
|
-
};
|
|
465
|
-
posterOptions?: CloudinaryVideoPlayerOptionPosterOptions;
|
|
466
|
-
showJumpControls?: boolean;
|
|
467
|
-
seekThumbnails?: boolean;
|
|
468
|
-
videoJS?: object;
|
|
469
|
-
autoPlay?: string | boolean | undefined;
|
|
470
|
-
autoplay?: string | boolean | undefined;
|
|
471
|
-
autoplayMode?: string;
|
|
472
|
-
autoShowRecommendations?: boolean;
|
|
473
|
-
loop?: boolean;
|
|
474
|
-
maxTries?: Number;
|
|
475
|
-
muted?: boolean;
|
|
476
|
-
playedEventPercents?: number[];
|
|
477
|
-
playedEventTimes?: null | Array<any>;
|
|
478
|
-
playsinline?: boolean;
|
|
479
|
-
videoTimeout?: number;
|
|
480
|
-
withCredentials?: boolean;
|
|
481
|
-
chapters?: object;
|
|
482
|
-
preload?: string;
|
|
483
|
-
publicId?: string;
|
|
484
|
-
sourceTransformation?: object;
|
|
485
|
-
sourceTypes?: Array<string>;
|
|
486
|
-
transformation?: Array<object> | object;
|
|
487
|
-
ads?: {
|
|
488
|
-
adTagUrl?: string;
|
|
489
|
-
adsInPlaylist?: string;
|
|
490
|
-
showCountdown?: boolean;
|
|
491
|
-
adLabel?: string;
|
|
492
|
-
locale?: string;
|
|
493
|
-
prerollTimeout?: number;
|
|
494
|
-
postrollTimeout?: number;
|
|
495
|
-
};
|
|
496
|
-
analytics?: boolean;
|
|
497
|
-
allowUsageReport?: Boolean;
|
|
498
|
-
cloud_name?: string;
|
|
499
|
-
cname?: string;
|
|
500
|
-
privateCdn?: boolean;
|
|
501
|
-
queryParams?: Record<string, string | number | boolean> | string;
|
|
502
|
-
secure?: boolean;
|
|
503
|
-
secureDistribution?: string;
|
|
504
|
-
language?: string;
|
|
505
|
-
languages?: Record<string, object>;
|
|
506
|
-
}
|
|
507
|
-
interface CloudinaryVideoPlayerOptionsColors {
|
|
508
|
-
accent?: string;
|
|
509
|
-
base?: string;
|
|
510
|
-
text?: string;
|
|
511
|
-
}
|
|
512
|
-
interface CloudinaryVideoPlayerOptionPosterOptions {
|
|
513
|
-
publicId: string;
|
|
514
|
-
}
|
|
515
|
-
|
|
516
309
|
/**
|
|
517
310
|
* getCldImageUrl
|
|
518
311
|
*/
|
|
@@ -547,8 +340,6 @@ type CldVideoPlayerProps = Omit<CloudinaryVideoPlayerOptions, "cloud_name" | "au
|
|
|
547
340
|
quality?: string | number;
|
|
548
341
|
width: string | number;
|
|
549
342
|
};
|
|
550
|
-
interface CldVideoPlayerPropsColors extends CloudinaryVideoPlayerOptionsColors {
|
|
551
|
-
}
|
|
552
343
|
interface CldVideoPlayerPropsLogo {
|
|
553
344
|
imageUrl?: CloudinaryVideoPlayerOptionsLogo['logoImageUrl'];
|
|
554
345
|
logo?: boolean;
|
|
@@ -578,4 +369,4 @@ declare function cloudinaryLoader({ loaderOptions, imageProps, cldOptions, cldCo
|
|
|
578
369
|
type GetCldOgImageUrlOptions = GetCldImageUrlOptions;
|
|
579
370
|
declare function getCldOgImageUrl(options: GetCldOgImageUrlOptions): string;
|
|
580
371
|
|
|
581
|
-
export { CldImage, type CldImageProps, CldOgImage, type CldOgImageProps, CldUploadButton, type CldUploadButtonProps, CldUploadWidget, type
|
|
372
|
+
export { CldImage, type CldImageProps, CldOgImage, type CldOgImageProps, CldUploadButton, type CldUploadButtonProps, CldUploadWidget, type CldUploadWidgetProps, type CldUploadWidgetPropsChildren, CldVideoPlayer, type CldVideoPlayerProps, type CldVideoPlayerPropsLogo, type CloudinaryLoader, type CloudinaryLoaderCldOptions, type CloudinaryLoaderLoaderOptions, type GetCldImageUrlAnalytics, type GetCldImageUrlConfig, type GetCldImageUrlOptions, type GetCldOgImageUrlOptions, type GetCldVideoUrlAnalytics, type GetCldVideoUrlConfig, type GetCldVideoUrlOptions, cloudinaryLoader, getCldImageUrl, getCldOgImageUrl, getCldVideoUrl };
|