Skip to content

Releases: pingdotgg/uploadthing

@uploadthing/[email protected]

15 Jul 19:19
c4c2db2
Compare
Choose a tag to compare

Patch Changes

@uploadthing/[email protected]

15 Jul 19:19
c4c2db2
Compare
Choose a tag to compare

Minor Changes

Patch Changes

@uploadthing/[email protected]

15 Jul 19:19
c4c2db2
Compare
Choose a tag to compare

Minor Changes

Patch Changes

[email protected]

27 Jun 06:34
7a0d3a6
Compare
Choose a tag to compare

Minor Changes

Patch Changes

@uploadthing/[email protected]

27 Jun 06:34
7a0d3a6
Compare
Choose a tag to compare

Minor Changes

Patch Changes

@uploadthing/[email protected]

27 Jun 06:34
7a0d3a6
Compare
Choose a tag to compare

Patch Changes

@uploadthing/[email protected]

27 Jun 06:34
7a0d3a6
Compare
Choose a tag to compare

Minor Changes

Patch Changes

[email protected]

20 Jun 06:19
1ac0f1b
Compare
Choose a tag to compare

Major Changes

  • #157
    5652869
    Thanks @juliusmarminge! - feat!: allow
    client side metadata to be passed along with the files

    Summary

    You can now pass input along with the files when uploading.

    In your file route:

      withInput: f(["image"])
        .input(
          z.object({
            foo: z.string(),
          }),
        )
        .middleware((opts) => {
          console.log("input", opts.input);
          // input is typed as { foo: string }
          return {};
        })
        .onUploadComplete((data) => {
          console.log("upload completed", data);
        }),

    Then, when uploading, attach the input to the component or the startUpload
    function:

    const { useUploadThing } = generateReactHelpers<typeof OurFileRouter>();
    
    function MyComponent() {
      // Vanilla way
      const { startUpload } = useUploadthing("withInput");
      async function onSubmit(files: File[]) {
        await startUpload(files, { foo: "bar" });
      }
    
      // Component way
      return (
        <UploadButton<OurFileRouter>
          endpoint="withInput"
          input={{ foo: "bar" }} // or use some state to be dynamic
        />
      );
    }

    The input is validated on your server and only leaves your server if you
    pass it along from the .middleware to the .onUploadComplete. If you only
    use the input in the middleware without returning it, the Uploadthing server
    won't have any knowledge of it.

    Breaking changes

    • Options passed in the middleware now comes as an object.

      // before
      route: f(["image"])
        // res only for Next.js pages
        .middleware((req, res) => {
          return {};
        });
      
      // after
      route: f(["image"])
        // res only for Next.js pages
        .middleware((opts) => {
          opts.req; // Request, NextRequest, NextApiRequest depending on runtime
          opts.res; // NextApiResponse for Next.js pages
          opts.input; // typesafe, validated input
          return {};
        });
    • The endpoint option in the useUploadthing hook has been moved out to a
      separate positional argument.

      // before
      useUploadthing({
        endpoint: "withInput"
        onUploadComplete: ...
      })
      
      // after
      useUploadthing("withInput", {
        onUploadComplete: ...
      })
    • The signature for uploadFiles has changed to object syntax.

      // before
      const { uploadFiles } = generateReactHelpers<OurFileRouter>();
      uploadFiles(files, endpoint, { url: "" })
      
      // after
      const { uploadFiles } = generateReactHelpers<OurFileRouter>();
      uploadFiles({
        files,
        endpoint,
        input, // <-- new option
        url,
      })

@uploadthing/[email protected]

20 Jun 06:19
1ac0f1b
Compare
Choose a tag to compare

Major Changes

  • #157
    5652869
    Thanks @juliusmarminge! - feat!: allow
    client side metadata to be passed along with the files

    Summary

    You can now pass input along with the files when uploading.

    In your file route:

      withInput: f(["image"])
        .input(
          z.object({
            foo: z.string(),
          }),
        )
        .middleware((opts) => {
          console.log("input", opts.input);
          // input is typed as { foo: string }
          return {};
        })
        .onUploadComplete((data) => {
          console.log("upload completed", data);
        }),

    Then, when uploading, attach the input to the component or the startUpload
    function:

    const { useUploadThing } = generateReactHelpers<typeof OurFileRouter>();
    
    function MyComponent() {
      // Vanilla way
      const { startUpload } = useUploadthing("withInput");
      async function onSubmit(files: File[]) {
        await startUpload(files, { foo: "bar" });
      }
    
      // Component way
      return (
        <UploadButton<OurFileRouter>
          endpoint="withInput"
          input={{ foo: "bar" }} // or use some state to be dynamic
        />
      );
    }

    The input is validated on your server and only leaves your server if you
    pass it along from the .middleware to the .onUploadComplete. If you only
    use the input in the middleware without returning it, the Uploadthing server
    won't have any knowledge of it.

    Breaking changes

    • Options passed in the middleware now comes as an object.

      // before
      route: f(["image"])
        // res only for Next.js pages
        .middleware((req, res) => {
          return {};
        });
      
      // after
      route: f(["image"])
        // res only for Next.js pages
        .middleware((opts) => {
          opts.req; // Request, NextRequest, NextApiRequest depending on runtime
          opts.res; // NextApiResponse for Next.js pages
          opts.input; // typesafe, validated input
          return {};
        });
    • The endpoint option in the useUploadthing hook has been moved out to a
      separate positional argument.

      // before
      useUploadthing({
        endpoint: "withInput"
        onUploadComplete: ...
      })
      
      // after
      useUploadthing("withInput", {
        onUploadComplete: ...
      })
    • The signature for uploadFiles has changed to object syntax.

      // before
      const { uploadFiles } = generateReactHelpers<OurFileRouter>();
      uploadFiles(files, endpoint, { url: "" })
      
      // after
      const { uploadFiles } = generateReactHelpers<OurFileRouter>();
      uploadFiles({
        files,
        endpoint,
        input, // <-- new option
        url,
      })

Minor Changes

  • #61
    9162cce
    Thanks @OrJDev! - feat: generateComponents
    functions for solid and react allows to pass the generic FileRouter once
    instead of for everytime the component is used

Patch Changes

@uploadthing/[email protected]

20 Jun 06:19
1ac0f1b
Compare
Choose a tag to compare

Major Changes

  • #157
    5652869
    Thanks @juliusmarminge! - feat!: allow
    client side metadata to be passed along with the files

    Summary

    You can now pass input along with the files when uploading.

    In your file route:

      withInput: f(["image"])
        .input(
          z.object({
            foo: z.string(),
          }),
        )
        .middleware((opts) => {
          console.log("input", opts.input);
          // input is typed as { foo: string }
          return {};
        })
        .onUploadComplete((data) => {
          console.log("upload completed", data);
        }),

    Then, when uploading, attach the input to the component or the startUpload
    function:

    const { useUploadThing } = generateReactHelpers<typeof OurFileRouter>();
    
    function MyComponent() {
      // Vanilla way
      const { startUpload } = useUploadthing("withInput");
      async function onSubmit(files: File[]) {
        await startUpload(files, { foo: "bar" });
      }
    
      // Component way
      return (
        <UploadButton<OurFileRouter>
          endpoint="withInput"
          input={{ foo: "bar" }} // or use some state to be dynamic
        />
      );
    }

    The input is validated on your server and only leaves your server if you
    pass it along from the .middleware to the .onUploadComplete. If you only
    use the input in the middleware without returning it, the Uploadthing server
    won't have any knowledge of it.

    Breaking changes

    • Options passed in the middleware now comes as an object.

      // before
      route: f(["image"])
        // res only for Next.js pages
        .middleware((req, res) => {
          return {};
        });
      
      // after
      route: f(["image"])
        // res only for Next.js pages
        .middleware((opts) => {
          opts.req; // Request, NextRequest, NextApiRequest depending on runtime
          opts.res; // NextApiResponse for Next.js pages
          opts.input; // typesafe, validated input
          return {};
        });
    • The endpoint option in the useUploadthing hook has been moved out to a
      separate positional argument.

      // before
      useUploadthing({
        endpoint: "withInput"
        onUploadComplete: ...
      })
      
      // after
      useUploadthing("withInput", {
        onUploadComplete: ...
      })
    • The signature for uploadFiles has changed to object syntax.

      // before
      const { uploadFiles } = generateReactHelpers<OurFileRouter>();
      uploadFiles(files, endpoint, { url: "" })
      
      // after
      const { uploadFiles } = generateReactHelpers<OurFileRouter>();
      uploadFiles({
        files,
        endpoint,
        input, // <-- new option
        url,
      })

Minor Changes

  • #61
    9162cce
    Thanks @OrJDev! - feat: generateComponents
    functions for solid and react allows to pass the generic FileRouter once
    instead of for everytime the component is used

Patch Changes