Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@uppy/core: various type fixes #4995

Merged
merged 6 commits into from
Mar 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/@uppy/core/src/BasePlugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import type {
OptionalPluralizeLocale,
} from '@uppy/utils/lib/Translator'
import type { Body, Meta } from '@uppy/utils/lib/UppyFile'
import type { State, Uppy } from './Uppy'
import type { State, UnknownPlugin, Uppy } from './Uppy'

export type PluginOpts = {
locale?: Locale
Expand Down Expand Up @@ -111,7 +111,7 @@ export default class BasePlugin<
*/

// eslint-disable-next-line @typescript-eslint/no-unused-vars
addTarget(plugin: unknown): HTMLElement {
addTarget(plugin: UnknownPlugin<M, B>): HTMLElement | null {
throw new Error(
"Extend the addTarget method to add your plugin to another plugin's target",
)
Expand Down
4 changes: 2 additions & 2 deletions packages/@uppy/core/src/UIPlugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ class UIPlugin<

this.onMount()

return this.el
return this.el!
}

const targetPlugin = this.getTargetPlugin(target)
Expand All @@ -148,7 +148,7 @@ class UIPlugin<
this.el = targetPlugin.addTarget(plugin)

this.onMount()
return this.el
return this.el!
}

this.uppy.log(`Not installing ${callerPluginName}`)
Expand Down
13 changes: 8 additions & 5 deletions packages/@uppy/core/src/Uppy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ export type UnknownSearchProviderPlugin<
provider: CompanionClientSearchProvider
}

interface UploadResult<M extends Meta, B extends Body> {
export interface UploadResult<M extends Meta, B extends Body> {
successful?: UppyFile<M, B>[]
failed?: UppyFile<M, B>[]
uploadID?: string
Expand All @@ -156,10 +156,12 @@ export interface State<M extends Meta, B extends Body>
uploadProgress: boolean
individualCancellation: boolean
resumableUploads: boolean
isMobileDevice?: boolean
darkMode?: boolean
}
currentUploads: Record<string, CurrentUpload<M, B>>
allowNewUpload: boolean
recoveredState: null | State<M, B>
recoveredState: null | Required<Pick<State<M, B>, 'files' | 'currentUploads'>>
error: string | null
files: {
[key: string]: UppyFile<M, B>
Expand Down Expand Up @@ -317,8 +319,9 @@ export interface _UppyEventMap<M extends Meta, B extends Body> {
'preprocess-progress': PreProcessProgressCallback<M, B>
progress: ProgressCallback
'reset-progress': GenericEventCallback
restored: GenericEventCallback
restored: (pluginData: any) => void
'restore-confirmed': GenericEventCallback
'restore-canceled': GenericEventCallback
'restriction-failed': RestrictionFailedCallback<M, B>
'resume-all': GenericEventCallback
'retry-all': RetryAllCallback
Expand Down Expand Up @@ -635,7 +638,7 @@ export class Uppy<M extends Meta, B extends Body> {

// @todo next major: rename to `clear()`, make it also cancel ongoing uploads
// or throw and say you need to cancel manually
protected clearUploadedFiles(): void {
clearUploadedFiles(): void {
this.setState({ ...defaultUploadState, files: {} })
}

Expand Down Expand Up @@ -1713,7 +1716,7 @@ export class Uppy<M extends Meta, B extends Body> {

#updateOnlineStatus = this.updateOnlineStatus.bind(this)

getID(): UppyOptions<M, B>['id'] {
getID(): string {
return this.opts.id
}

Expand Down
3 changes: 2 additions & 1 deletion packages/@uppy/core/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
export { default } from './Uppy.ts'
export {
default as Uppy,
type UppyEventMap,
type State,
type UnknownPlugin,
type UnknownProviderPlugin,
type UnknownSearchProviderPlugin,
type UploadResult,
type UppyEventMap,
} from './Uppy.ts'
export { default as UIPlugin } from './UIPlugin.ts'
export { default as BasePlugin } from './BasePlugin.ts'
Expand Down
Loading