@octane-xplat/files 0.0.1 → 0.10.0

package/src/props.ts

@@ -0,0 +1,52 @@
+import type { Octane } from 'octane/jsx-runtime'
+
+import type { FieldControlProps, FieldStatus, FieldStatusType } from '@octane-xplat/ui'
+import type { FileRef } from './types'
+
+/** A portable selected file. The browser File is only present on web. */
+export interface FileInputFile extends FileRef {
+	size?: number
+	mimeType?: string
+	file?: any
+}
+
+export type FileInputStatus = FieldStatus
+export type FileInputStatusType = FieldStatusType
+
+export type FileInputPick = (options: {
+	accept?: string
+	multiple?: boolean
+}) => Promise<FileInputFile[] | FileInputFile | null>
+
+export interface FileInputHandle {
+	open(): void
+	native: any
+}
+
+export interface FileInputProps extends FieldControlProps {
+	className?: any
+	style?: any
+	id?: string
+	accessibilityLabel?: string
+	accessibilityHint?: string
+	/** `input` is a compact field row; `dropzone` a larger target that
+	 *  accepts drag/drop on pointer platforms. @default 'input' */
+	mode?: 'input' | 'dropzone'
+	value: FileInputFile | FileInputFile[] | null
+	onChange: (value: FileInputFile | FileInputFile[] | null) => void
+	changeAction?: (value: FileInputFile | FileInputFile[] | null) => void | Promise<void>
+	/** `accept`-style filter: `.ext`, `type/subtype`, wildcard subtype, any. */
+	accept?: string
+	/** When true, `value` and `onChange` use file arrays. */
+	isMultiple?: boolean
+	/** Max bytes per file; skipped for refs without a `size`. */
+	maxSize?: number
+	maxFiles?: number
+	placeholder?: string
+	/** Optional per-instance picker override for cloud or app-specific sources. */
+	pick?: FileInputPick
+	ref?: Octane.Ref<FileInputHandle>
+	ios?: any
+	android?: any
+	web?: any
+}

package/src/types.ts

@@ -0,0 +1,9 @@
+export interface FileRef {
+	name: string
+	/**
+	 * Opaque reference: blob/object URL on web, filesystem path on native.
+	 * `files.writeText()` downloads on web and writes where implemented.
+	 * Picked mobile files may use `content://` URIs.
+	 */
+	uri: string
+}

package/types/index.d.ts

@@ -0,0 +1,15 @@
+import type { UniversalComponent } from 'octane/universal'
+import type { FileInputProps } from '../src/props.js'
+
+export declare const FileInput: UniversalComponent<FileInputProps>
+export type {
+	FileInputFile,
+	FileInputHandle,
+	FileInputPick,
+	FileInputProps,
+	FileInputStatus,
+	FileInputStatusType,
+} from '../src/props.js'
+
+export { files } from '../src/files.js'
+export type { FileRef } from '../src/types.js'

package/types/index.macos.d.ts

@@ -0,0 +1,14 @@
+import type { FileInputProps } from '../src/props.js'
+
+export declare function FileInput(props: FileInputProps): unknown
+export type {
+	FileInputFile,
+	FileInputHandle,
+	FileInputPick,
+	FileInputProps,
+	FileInputStatus,
+	FileInputStatusType,
+} from '../src/props.js'
+
+export { files } from '../src/files.macos.js'
+export type { FileRef } from '../src/types.js'

package/index.d.ts

@@ -1 +0,0 @@
-export {}

package/index.js

@@ -1,2 +0,0 @@
-// Reservation stub; implementation will arrive in a later release.
-module.exports = {}