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/transloadit: migrate to TS #4987

Merged
merged 9 commits into from
Mar 18, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 4 additions & 3 deletions packages/@uppy/core/src/Uppy.ts
Original file line number Diff line number Diff line change
Expand Up @@ -267,13 +267,13 @@ type UploadCompleteCallback<M extends Meta, B extends Body> = (
result: UploadResult<M, B>,
) => void
type ErrorCallback<M extends Meta, B extends Body> = (
error: { message?: string; details?: string },
error: { name: string; message: string; details?: string },
file?: UppyFile<M, B>,
response?: UppyFile<M, B>['response'],
) => void
type UploadErrorCallback<M extends Meta, B extends Body> = (
file: UppyFile<M, B> | undefined,
error: { message: string; details?: string },
error: { name: string; message: string; details?: string },
response?:
| Omit<NonNullable<UppyFile<M, B>['response']>, 'uploadURL'>
| undefined,
Expand Down Expand Up @@ -317,7 +317,7 @@ 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
'restriction-failed': RestrictionFailedCallback<M, B>
'resume-all': GenericEventCallback
Expand Down Expand Up @@ -786,6 +786,7 @@ export class Uppy<M extends Meta, B extends Body> {

#informAndEmit(
errors: {
name: string
message: string
isUserFacing?: boolean
details?: string
Expand Down
1 change: 1 addition & 0 deletions packages/@uppy/transloadit/.npmignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
tsconfig.*
127 changes: 67 additions & 60 deletions packages/@uppy/transloadit/src/Assembly.test.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
import { describe, expect, it, vi } from 'vitest'
import { RateLimitedQueue } from '@uppy/utils/lib/RateLimitedQueue'
import Assembly from './Assembly.js'
import Assembly from './Assembly.ts'

describe('Transloadit/Assembly', () => {
describe('status diffing', () => {
function attemptDiff (prev, next) {
function attemptDiff(prev, next) {
const assembly = new Assembly(prev, new RateLimitedQueue())
const events = []
assembly.emit = vi.fn((name, ...args) => {
Expand All @@ -17,77 +17,92 @@ describe('Transloadit/Assembly', () => {
}

it('ASSEMBLY_UPLOADING → ASSEMBLY_EXECUTING', () => {
const result = attemptDiff({
ok: 'ASSEMBLY_UPLOADING',
uploads: {},
results: {},
}, {
ok: 'ASSEMBLY_EXECUTING',
uploads: {},
results: {},
})
const result = attemptDiff(
{
ok: 'ASSEMBLY_UPLOADING',
uploads: {},
results: {},
},
{
ok: 'ASSEMBLY_EXECUTING',
uploads: {},
results: {},
},
)

expect(result[0]).toEqual(['executing'])
})

it('ASSEMBLY_EXECUTING → ASSEMBLY_COMPLETED', () => {
const result = attemptDiff({
ok: 'ASSEMBLY_EXECUTING',
uploads: {},
results: {},
}, {
ok: 'ASSEMBLY_COMPLETED',
uploads: {},
results: {},
})
const result = attemptDiff(
{
ok: 'ASSEMBLY_EXECUTING',
uploads: {},
results: {},
},
{
ok: 'ASSEMBLY_COMPLETED',
uploads: {},
results: {},
},
)

expect(result[0]).toEqual(['finished'])
})

it('ASSEMBLY_UPLOADING → ASSEMBLY_COMPLETED', () => {
const result = attemptDiff({
ok: 'ASSEMBLY_UPLOADING',
uploads: {},
results: {},
}, {
ok: 'ASSEMBLY_COMPLETED',
uploads: {},
results: {},
})
const result = attemptDiff(
{
ok: 'ASSEMBLY_UPLOADING',
uploads: {},
results: {},
},
{
ok: 'ASSEMBLY_COMPLETED',
uploads: {},
results: {},
},
)

expect(result[0]).toEqual(['executing'])
expect(result[1]).toEqual(['metadata'])
expect(result[2]).toEqual(['finished'])
})

it('emits events for new files', () => {
const result = attemptDiff({
ok: 'ASSEMBLY_UPLOADING',
uploads: {},
results: {},
}, {
ok: 'ASSEMBLY_UPLOADING',
uploads: {
some_id: { id: 'some_id' },
const result = attemptDiff(
{
ok: 'ASSEMBLY_UPLOADING',
uploads: {},
results: {},
},
results: {},
})
{
ok: 'ASSEMBLY_UPLOADING',
uploads: {
some_id: { id: 'some_id' },
},
results: {},
},
)

expect(result[0]).toEqual(['upload', { id: 'some_id' }])
})

it('emits executing, then upload, on new files + status change', () => {
const result = attemptDiff({
ok: 'ASSEMBLY_UPLOADING',
uploads: {},
results: {},
}, {
ok: 'ASSEMBLY_EXECUTING',
uploads: {
some_id: { id: 'some_id' },
const result = attemptDiff(
{
ok: 'ASSEMBLY_UPLOADING',
uploads: {},
results: {},
},
results: {},
})
{
ok: 'ASSEMBLY_EXECUTING',
uploads: {
some_id: { id: 'some_id' },
},
results: {},
},
)

expect(result[0]).toEqual(['executing'])
expect(result[1]).toEqual(['upload', { id: 'some_id' }])
Expand All @@ -108,11 +123,7 @@ describe('Transloadit/Assembly', () => {
cool_video: { id: 'cool_video' },
},
results: {
step_one: [
{ id: 'thumb1' },
{ id: 'thumb2' },
{ id: 'thumb3' },
],
step_one: [{ id: 'thumb1' }, { id: 'thumb2' }, { id: 'thumb3' }],
},
}
const three = {
Expand All @@ -127,9 +138,7 @@ describe('Transloadit/Assembly', () => {
{ id: 'thumb3' },
{ id: 'thumb4' },
],
step_two: [
{ id: 'transcript' },
],
step_two: [{ id: 'transcript' }],
},
}

Expand Down Expand Up @@ -162,9 +171,7 @@ describe('Transloadit/Assembly', () => {
{ id: 'thumb3' },
{ id: 'thumb4' },
],
step_two: [
{ id: 'transcript' },
],
step_two: [{ id: 'transcript' }],
},
}

Expand Down