@sqlrooms/dropzone 0.0.1 → 0.0.3

package/dist/file-dropzone.d.ts

@@ -1,11 +1,48 @@
 import { FC } from 'react';
-export type Props = {
+/**
+ * A customizable file dropzone component that handles file uploads through drag-and-drop or click interactions.
+ *
+ * @component
+ * @example
+ * ```tsx
+ * // Basic usage
+ * <FileDropzone
+ *   onDrop={async (files) => {
+ *     console.log('Dropped files:', files);
+ *     // Handle file upload
+ *   }}
+ * />
+ *
+ * // With file type restrictions and single file upload
+ * <FileDropzone
+ *   multiple={false}
+ *   acceptedFormats={{
+ *     'text/csv': ['.csv'],
+ *     'application/json': ['.json']
+ *   }}
+ *   onDrop={async (files) => {
+ *     const file = files[0];
+ *     // Handle single file upload
+ *   }}
+ * >
+ *   <p>Custom dropzone content</p>
+ * </FileDropzone>
+ * ```
+ *
+ * @param props - Component props
+ * @param props.className - Optional CSS class name for styling
+ * @param props.isInvalid - Optional flag to indicate validation error state
+ * @param props.onDrop - Async callback function called when files are dropped or selected
+ * @param props.multiple - Optional flag to allow multiple file selection (default: true)
+ * @param props.acceptedFormats - Optional object defining accepted MIME types and their extensions
+ * @param props.children - Optional React nodes to render inside the dropzone
+ */
+export declare const FileDropzone: FC<{
     className?: string;
     isInvalid?: boolean;
     onDrop: (files: File[]) => Promise<void>;
     multiple?: boolean;
     acceptedFormats?: Record<string, string[]>;
     children?: React.ReactNode;
-};
-export declare const FileDropzone: FC<Props>;
+}>;
 //# sourceMappingURL=file-dropzone.d.ts.map

package/dist/file-dropzone.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"file-dropzone.d.ts","sourceRoot":"","sources":["../src/file-dropzone.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,EAAE,EAAW,MAAM,OAAO,CAAC;AAKnC,MAAM,MAAM,KAAK,GAAG;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3C,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,EAAE,CAAC,KAAK,CAsElC,CAAC"}
+{"version":3,"file":"file-dropzone.d.ts","sourceRoot":"","sources":["../src/file-dropzone.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAC,EAAE,EAAW,MAAM,OAAO,CAAC;AAKnC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,eAAO,MAAM,YAAY,EAAE,EAAE,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACzC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3C,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;CAC5B,CAsEA,CAAC"}

package/dist/file-dropzone.js

@@ -3,6 +3,44 @@ import { useState } from 'react';
 import { useDropzone } from 'react-dropzone';
 import { Plus } from 'lucide-react';
 import { cn, Spinner } from '@sqlrooms/ui';
+/**
+ * A customizable file dropzone component that handles file uploads through drag-and-drop or click interactions.
+ *
+ * @component
+ * @example
+ * ```tsx
+ * // Basic usage
+ * <FileDropzone
+ *   onDrop={async (files) => {
+ *     console.log('Dropped files:', files);
+ *     // Handle file upload
+ *   }}
+ * />
+ *
+ * // With file type restrictions and single file upload
+ * <FileDropzone
+ *   multiple={false}
+ *   acceptedFormats={{
+ *     'text/csv': ['.csv'],
+ *     'application/json': ['.json']
+ *   }}
+ *   onDrop={async (files) => {
+ *     const file = files[0];
+ *     // Handle single file upload
+ *   }}
+ * >
+ *   <p>Custom dropzone content</p>
+ * </FileDropzone>
+ * ```
+ *
+ * @param props - Component props
+ * @param props.className - Optional CSS class name for styling
+ * @param props.isInvalid - Optional flag to indicate validation error state
+ * @param props.onDrop - Async callback function called when files are dropped or selected
+ * @param props.multiple - Optional flag to allow multiple file selection (default: true)
+ * @param props.acceptedFormats - Optional object defining accepted MIME types and their extensions
+ * @param props.children - Optional React nodes to render inside the dropzone
+ */
 export const FileDropzone = (props) => {
     const { isInvalid, onDrop, multiple = true, className, acceptedFormats, children, } = props;
     const [isAddingDropped, setIsAddingDropped] = useState(false);

package/package.json

@@ -1,8 +1,17 @@
 {
   "name": "@sqlrooms/dropzone",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "type": "module",
   "private": false,
+  "author": "Ilya Boyandin <ilya@boyandin.me>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sqlrooms/sqlrooms.git"
+  },
+  "files": [
+    "dist"
+  ],
   "publishConfig": {
     "access": "public"
   },
@@ -19,12 +28,13 @@
   "scripts": {
     "dev": "tsc -w",
     "build": "tsc",
-    "lint": "eslint ."
+    "lint": "eslint .",
+    "typedoc": "typedoc"
   },
   "dependencies": {
-    "@sqlrooms/ui": "0.0.1",
+    "@sqlrooms/ui": "0.0.3",
     "lucide-react": "^0.473.0",
     "react-dropzone": "^14.3.5"
   },
-  "gitHead": "5d8893a604a91d109dc5b5f80b4a3e937b4cf520"
+  "gitHead": "4269a3efdb5a903cb2498c126e9c36683b3bbae0"
 }

package/CHANGELOG.md

@@ -1,14 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [0.0.1](https://github.com/ilyabo/sqlrooms/compare/v0.0.1-alpha.0...v0.0.1) (2025-01-30)
-
-**Note:** Version bump only for package @sqlrooms/dropzone
-
-## 0.0.1-alpha.0 (2025-01-30)
-
-**Note:** Version bump only for package @sqlrooms/dropzone
-
-**Note:** Version bump only for package @sqlrooms/dropzone