Skip to content

Commit

Permalink
Merge branch 'main' into transloadit-ts
Browse files Browse the repository at this point in the history
* main:
  @uppy/utils: fix `AbortablePromise` type (#4988)
  Fix breadcrumbs (#4986)
  @uppy/drag-drop: refactor to TypeScript (#4983)
  @uppy/webcam: refactor to TypeScript (#4870)
  • Loading branch information
Murderlon committed Mar 14, 2024
2 parents 746b00c + 70ca9e6 commit 0608046
Show file tree
Hide file tree
Showing 40 changed files with 883 additions and 464 deletions.
1 change: 1 addition & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,7 @@ module.exports = {
{
files: [
'*.test.js',
'*.test.ts',
'test/endtoend/*.js',
'bin/**.js',
],
Expand Down
2 changes: 1 addition & 1 deletion packages/@uppy/core/src/Uppy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export type UnknownPlugin<
export type UnknownProviderPluginState = {
authenticated: boolean | undefined
breadcrumbs: {
requestPath: string
requestPath?: string
name?: string
id?: string
}[]
Expand Down
1 change: 1 addition & 0 deletions packages/@uppy/drag-drop/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
tsconfig.*
Original file line number Diff line number Diff line change
@@ -1,55 +1,69 @@
import { UIPlugin } from '@uppy/core'
import { UIPlugin, type Uppy } from '@uppy/core'
import type { DefinePluginOpts } from '@uppy/core/lib/BasePlugin.ts'
import type { UIPluginOptions } from '@uppy/core/lib/UIPlugin.ts'
import type { Body, Meta } from '@uppy/utils/lib/UppyFile'
import type { ChangeEvent } from 'preact/compat'
import toArray from '@uppy/utils/lib/toArray'
import isDragDropSupported from '@uppy/utils/lib/isDragDropSupported'
import getDroppedFiles from '@uppy/utils/lib/getDroppedFiles'
import { h } from 'preact'
import { h, type ComponentChild } from 'preact'

// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore We don't want TS to generate types for the package.json
import packageJson from '../package.json'
import locale from './locale.js'
import locale from './locale.ts'

interface DragDropOptions extends UIPluginOptions {
inputName?: string
allowMultipleFiles?: boolean
width?: string | number
height?: string | number
note?: string
onDragOver?: (event: DragEvent) => void
onDragLeave?: (event: DragEvent) => void
onDrop?: (event: DragEvent) => void
}

// Default options, must be kept in sync with @uppy/react/src/DragDrop.js.
const defaultOptions = {
inputName: 'files[]',
width: '100%',
height: '100%',
} satisfies Partial<DragDropOptions>

/**
* Drag & Drop plugin
*
*/
export default class DragDrop extends UIPlugin {
export default class DragDrop<M extends Meta, B extends Body> extends UIPlugin<
DefinePluginOpts<DragDropOptions, keyof typeof defaultOptions>,
M,
B
> {
static VERSION = packageJson.version

constructor (uppy, opts) {
super(uppy, opts)
// Check for browser dragDrop support
private isDragDropSupported = isDragDropSupported()

private removeDragOverClassTimeout: ReturnType<typeof setTimeout>

private fileInputRef: HTMLInputElement

constructor(uppy: Uppy<M, B>, opts?: DragDropOptions) {
super(uppy, {
...defaultOptions,
...opts,
})
this.type = 'acquirer'
this.id = this.opts.id || 'DragDrop'
this.title = 'Drag & Drop'

this.defaultLocale = locale

// Default options, must be kept in sync with @uppy/react/src/DragDrop.js.
const defaultOpts = {
target: null,
inputName: 'files[]',
width: '100%',
height: '100%',
note: null,
}

// Merge default options with the ones set by user
this.opts = { ...defaultOpts, ...opts }

this.i18nInit()

// Check for browser dragDrop support
this.isDragDropSupported = isDragDropSupported()
this.removeDragOverClassTimeout = null

// Bind `this` to class methods
this.onInputChange = this.onInputChange.bind(this)
this.handleDragOver = this.handleDragOver.bind(this)
this.handleDragLeave = this.handleDragLeave.bind(this)
this.handleDrop = this.handleDrop.bind(this)
this.addFiles = this.addFiles.bind(this)
this.render = this.render.bind(this)
}

addFiles (files) {
private addFiles = (files: File[]) => {
const descriptors = files.map((file) => ({
source: this.id,
name: file.name,
Expand All @@ -58,8 +72,8 @@ export default class DragDrop extends UIPlugin {
meta: {
// path of the file relative to the ancestor directory the user selected.
// e.g. 'docs/Old Prague/airbnb.pdf'
relativePath: file.relativePath || null,
},
relativePath: (file as any).relativePath || null,
} as any as M,
}))

try {
Expand All @@ -69,8 +83,8 @@ export default class DragDrop extends UIPlugin {
}
}

onInputChange (event) {
const files = toArray(event.target.files)
private onInputChange = (event: ChangeEvent) => {
const files = toArray((event.target as HTMLInputElement).files!)
if (files.length > 0) {
this.uppy.log('[DragDrop] Files selected through input')
this.addFiles(files)
Expand All @@ -82,21 +96,22 @@ export default class DragDrop extends UIPlugin {
// ___Why not use value="" on <input/> instead?
// Because if we use that method of clearing the input,
// Chrome will not trigger change if we drop the same file twice (Issue #768).
// @ts-expect-error TS freaks out, but this is fine
// eslint-disable-next-line no-param-reassign
event.target.value = null
}

handleDragOver (event) {
private handleDragOver = (event: DragEvent) => {
event.preventDefault()
event.stopPropagation()

// Check if the "type" of the datatransfer object includes files. If not, deny drop.
const { types } = event.dataTransfer
const hasFiles = types.some(type => type === 'Files')
const { types } = event.dataTransfer!
const hasFiles = types.some((type) => type === 'Files')
const { allowNewUpload } = this.uppy.getState()
if (!hasFiles || !allowNewUpload) {
// eslint-disable-next-line no-param-reassign
event.dataTransfer.dropEffect = 'none'
event.dataTransfer!.dropEffect = 'none'
clearTimeout(this.removeDragOverClassTimeout)
return
}
Expand All @@ -106,15 +121,15 @@ export default class DragDrop extends UIPlugin {
// https://github.com/transloadit/uppy/issues/1978)
//
// eslint-disable-next-line no-param-reassign
event.dataTransfer.dropEffect = 'copy'
event.dataTransfer!.dropEffect = 'copy'

clearTimeout(this.removeDragOverClassTimeout)
this.setPluginState({ isDraggingOver: true })

this.opts.onDragOver?.(event)
}

handleDragLeave (event) {
private handleDragLeave = (event: DragEvent) => {
event.preventDefault()
event.stopPropagation()

Expand All @@ -128,20 +143,20 @@ export default class DragDrop extends UIPlugin {
this.opts.onDragLeave?.(event)
}

handleDrop = async (event) => {
private handleDrop = async (event: DragEvent) => {
event.preventDefault()
event.stopPropagation()
clearTimeout(this.removeDragOverClassTimeout)

// Remove dragover class
this.setPluginState({ isDraggingOver: false })

const logDropError = (error) => {
const logDropError = (error: any) => {
this.uppy.log(error, 'error')
}

// Add all dropped files
const files = await getDroppedFiles(event.dataTransfer, { logDropError })
const files = await getDroppedFiles(event.dataTransfer!, { logDropError })
if (files.length > 0) {
this.uppy.log('[DragDrop] Files dropped')
this.addFiles(files)
Expand All @@ -150,47 +165,57 @@ export default class DragDrop extends UIPlugin {
this.opts.onDrop?.(event)
}

renderHiddenFileInput () {
private renderHiddenFileInput() {
const { restrictions } = this.uppy.opts
return (
<input
className="uppy-DragDrop-input"
type="file"
hidden
ref={(ref) => { this.fileInputRef = ref }}
ref={(ref) => {
this.fileInputRef = ref!
}}
name={this.opts.inputName}
multiple={restrictions.maxNumberOfFiles !== 1}
// @ts-expect-error We actually want to coerce the array to a string (or keep it as null/undefined)
accept={restrictions.allowedFileTypes}
onChange={this.onInputChange}
/>
)
}

static renderArrowSvg () {
private static renderArrowSvg() {
return (
<svg aria-hidden="true" focusable="false" className="uppy-c-icon uppy-DragDrop-arrow" width="16" height="16" viewBox="0 0 16 16">
<svg
aria-hidden="true"
focusable="false"
className="uppy-c-icon uppy-DragDrop-arrow"
width="16"
height="16"
viewBox="0 0 16 16"
>
<path d="M11 10V0H5v10H2l6 6 6-6h-3zm0 0" fillRule="evenodd" />
</svg>
)
}

renderLabel () {
private renderLabel() {
return (
<div className="uppy-DragDrop-label">
{this.i18nArray('dropHereOr', {
browse: <span className="uppy-DragDrop-browse">{this.i18n('browse')}</span>,
browse: (
<span className="uppy-DragDrop-browse">{this.i18n('browse')}</span>
) as any,
})}
</div>
)
}

renderNote () {
return (
<span className="uppy-DragDrop-note">{this.opts.note}</span>
)
private renderNote() {
return <span className="uppy-DragDrop-note">{this.opts.note}</span>
}

render () {
render(): ComponentChild {
const dragDropClass = `uppy-u-reset
uppy-DragDrop-container
${this.isDragDropSupported ? 'uppy-DragDrop--isDragDropSupported' : ''}
Expand Down Expand Up @@ -222,7 +247,7 @@ export default class DragDrop extends UIPlugin {
)
}

install () {
install(): void {
const { target } = this.opts

this.setPluginState({
Expand All @@ -234,7 +259,7 @@ export default class DragDrop extends UIPlugin {
}
}

uninstall () {
uninstall(): void {
this.unmount()
}
}
1 change: 0 additions & 1 deletion packages/@uppy/drag-drop/src/index.js

This file was deleted.

1 change: 1 addition & 0 deletions packages/@uppy/drag-drop/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export { default } from './DragDrop.tsx'
File renamed without changes.
25 changes: 25 additions & 0 deletions packages/@uppy/drag-drop/tsconfig.build.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"extends": "../../../tsconfig.shared",
"compilerOptions": {
"noImplicitAny": false,
"outDir": "./lib",
"paths": {
"@uppy/utils/lib/*": ["../utils/src/*"],
"@uppy/core": ["../core/src/index.js"],
"@uppy/core/lib/*": ["../core/src/*"]
},
"resolveJsonModule": false,
"rootDir": "./src",
"skipLibCheck": true
},
"include": ["./src/**/*.*"],
"exclude": ["./src/**/*.test.ts"],
"references": [
{
"path": "../utils/tsconfig.build.json"
},
{
"path": "../core/tsconfig.build.json"
}
]
}
21 changes: 21 additions & 0 deletions packages/@uppy/drag-drop/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"extends": "../../../tsconfig.shared",
"compilerOptions": {
"emitDeclarationOnly": false,
"noEmit": true,
"paths": {
"@uppy/utils/lib/*": ["../utils/src/*"],
"@uppy/core": ["../core/src/index.js"],
"@uppy/core/lib/*": ["../core/src/*"],
},
},
"include": ["./package.json", "./src/**/*.*"],
"references": [
{
"path": "../utils/tsconfig.build.json",
},
{
"path": "../core/tsconfig.build.json",
},
],
}
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ export default class ProviderView<M extends Meta, B extends Body> extends View<
if (index !== -1) {
// means we navigated back to a known directory (already in the stack), so cut the stack off there
breadcrumbs = breadcrumbs.slice(0, index + 1)
} else if (requestPath) {
} else {
// we have navigated into a new (unknown) folder, add it to the stack
breadcrumbs = [...breadcrumbs, { requestPath, name }]
}
Expand Down
2 changes: 2 additions & 0 deletions packages/@uppy/tus/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ type RestTusUploadOptions = Omit<
'onShouldRetry' | 'onBeforeRequest' | 'headers'
>

export type TusDetailedError = tus.DetailedError

export interface TusOpts<M extends Meta, B extends Body>
extends PluginOpts,
RestTusUploadOptions {
Expand Down
4 changes: 2 additions & 2 deletions packages/@uppy/utils/src/RateLimitedQueue.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ type QueueOptions = {

export interface AbortablePromise<T> extends Promise<T> {
abort(cause?: unknown): void
abortOn: typeof abortOn
abortOn: (...args: Parameters<typeof abortOn>) => AbortablePromise<T>
}

export type WrapPromiseFunctionType<T extends (...args: any[]) => any> = (
Expand Down Expand Up @@ -227,7 +227,7 @@ export class RateLimitedQueue {
outerPromise.abort = (cause) => {
queuedRequest.abort(cause)
}
outerPromise.abortOn = abortOn
outerPromise.abortOn = abortOn as any

return outerPromise
}
Expand Down
9 changes: 0 additions & 9 deletions packages/@uppy/webcam/src/CameraIcon.jsx

This file was deleted.

Loading

0 comments on commit 0608046

Please sign in to comment.