@manyrows/appkit-react 0.1.6 → 0.1.7

package/dist/index.d.ts

@@ -15,7 +15,47 @@ type ManyRowsAppKitReady = {
     baseURL: string;
     version: string;
 };
-type ManyRowsAppKitSnapshot = any;
+type AppKitAccount = {
+    email: string;
+    name: string;
+};
+type AppKitProjectAccess = {
+    name: string;
+    roles: string[];
+    permissions: string[];
+};
+type AppKitFeatureFlag = {
+    key: string;
+    enabled: boolean;
+};
+type AppKitConfigValue = {
+    key: string;
+    type: string;
+    value?: any;
+};
+type AppKitAppData = {
+    account?: AppKitAccount;
+    workspaceSlug: string;
+    workspaceName: string;
+    projectAccess: boolean;
+    project?: AppKitProjectAccess;
+    featureFlags?: AppKitFeatureFlag[];
+    config?: AppKitConfigValue[];
+};
+type ManyRowsAppKitSnapshot = {
+    status: "checking" | "authenticated" | "unauthenticated";
+    jwtToken: string | null;
+    appData: AppKitAppData | null;
+    workspaceBaseURL: string;
+    appId: string;
+    app: {
+        id: string;
+        name: string;
+        workspaceSlug: string;
+        workspaceName: string;
+        allowRegistration: boolean;
+    } | null;
+};
 type ManyRowsAppKitHandle = {
     version: string;
     info(): ManyRowsAppKitReady | null;
@@ -26,6 +66,101 @@ type ManyRowsAppKitHandle = {
     setToken(tok: string | null): void;
     destroy(): void;
 };
+type ImageVariant = {
+    id: string;
+    variant: string;
+    s3Key: string;
+    content_type: string;
+    format: string;
+    size_bytes: number;
+    sha256_hex: string;
+    ext: string;
+    width: number;
+    height: number;
+    etag: string;
+    versionId: string;
+    objectURL: string;
+    expiresAt: string;
+};
+type ImageResource = {
+    imageId: string;
+    title: string;
+    description: string;
+    originalName: string;
+    uploadedAt: string;
+    uploadedBy?: string;
+    refType?: string;
+    refId?: string;
+    variants: ImageVariant[];
+};
+type ImageListResponse = {
+    images: ImageResource[];
+    page: number;
+    pageSize: number;
+    total: number;
+    pageCount: number;
+};
+type ImageUploadOptions = {
+    file: File;
+    title: string;
+    description?: string;
+    variants?: string;
+    refType?: string;
+    refId?: string;
+};
+type ImageUpdateOptions = {
+    title: string;
+    description?: string;
+    refType?: string;
+    refId?: string;
+};
+type UploadProgress = {
+    status: "idle" | "uploading" | "success" | "conflict" | "error";
+    progress: number;
+    bytesUploaded: number;
+    bytesTotal: number;
+    error: string | null;
+    /** Set when status is "conflict" — the ID of the existing image with identical content. */
+    existingImageId?: string;
+    /** Set when status is "conflict" — the ID of the existing file with identical content. */
+    existingFileId?: string;
+};
+type FileResource = {
+    fileId: string;
+    title: string;
+    description: string;
+    originalName: string;
+    contentType: string;
+    format: string;
+    sizeBytes: number;
+    ext: string;
+    objectURL: string;
+    expiresAt: string;
+    uploadedAt: string;
+    uploadedBy?: string;
+    refType?: string;
+    refId?: string;
+};
+type FileListResponse = {
+    files: FileResource[];
+    page: number;
+    pageSize: number;
+    total: number;
+    pageCount: number;
+};
+type FileUploadOptions = {
+    file: File;
+    title: string;
+    description?: string;
+    refType?: string;
+    refId?: string;
+};
+type FileUpdateOptions = {
+    title: string;
+    description?: string;
+    refType?: string;
+    refId?: string;
+};
 
 type AppKitContextValue = {
     status: "idle" | "loading" | "mounted" | "error";
@@ -59,8 +194,16 @@ type AppKitTheme = {
 type AppKitProps = {
     workspace: string;
     appId: string;
+    /**
+     * Base URL of the ManyRows service.
+     * Defaults to "https://app.manyrows.com".
+     */
     baseURL?: string;
     theme?: AppKitTheme;
+    /**
+     * URL of the AppKit runtime script.
+     * Defaults to `{baseURL}/appkit/assets/appkit.js`.
+     */
     src?: string;
     timeoutMs?: number;
     silent?: boolean;
@@ -96,4 +239,294 @@ interface UserButtonProps {
 }
 declare function UserButton({ size }: UserButtonProps): react_jsx_runtime.JSX.Element;
 
-export { AppKit, AppKitAuthed, type AppKitTheme, type ManyRowsAppKitError, type ManyRowsAppKitErrorCode, type ManyRowsAppKitHandle, type ManyRowsAppKitReady, type ManyRowsAppKitSnapshot, UserButton, type UserButtonProps, useAppKit };
+/**
+ * Returns the authenticated user's account, or null if not authenticated.
+ *
+ * ```tsx
+ * const user = useUser();
+ * if (!user) return <p>Not logged in</p>;
+ * return <p>Hello, {user.name || user.email}</p>;
+ * ```
+ */
+declare function useUser(): AppKitAccount | null;
+/**
+ * Returns the current project access info (name, roles, permissions), or null.
+ */
+declare function useProject(): AppKitProjectAccess | null;
+/**
+ * Returns the user's roles in the current project.
+ *
+ * ```tsx
+ * const roles = useRoles(); // ["admin", "editor"]
+ * ```
+ */
+declare function useRoles(): string[];
+/**
+ * Returns the user's permissions in the current project.
+ *
+ * ```tsx
+ * const permissions = usePermissions(); // ["read", "write", "delete"]
+ * ```
+ */
+declare function usePermissions(): string[];
+/**
+ * Returns true if the user has the given permission.
+ *
+ * ```tsx
+ * const canEdit = usePermission("edit"); // true
+ * ```
+ */
+declare function usePermission(permission: string): boolean;
+/**
+ * Returns true if the user has the given role.
+ *
+ * ```tsx
+ * const isAdmin = useRole("admin"); // true
+ * ```
+ */
+declare function useRole(role: string): boolean;
+/**
+ * Returns all feature flags for the current app/environment.
+ *
+ * ```tsx
+ * const flags = useFeatureFlags(); // [{ key: "dark-mode", enabled: true }]
+ * ```
+ */
+declare function useFeatureFlags(): AppKitFeatureFlag[];
+/**
+ * Returns whether a specific feature flag is enabled.
+ *
+ * ```tsx
+ * const darkMode = useFeatureFlag("dark-mode"); // true
+ * ```
+ */
+declare function useFeatureFlag(key: string): boolean;
+/**
+ * Returns all config values for the current app/environment.
+ *
+ * ```tsx
+ * const config = useConfig(); // [{ key: "api-url", type: "string", value: "https://..." }]
+ * ```
+ */
+declare function useConfig(): AppKitConfigValue[];
+/**
+ * Returns a specific config value by key, or the fallback if not found.
+ *
+ * ```tsx
+ * const apiUrl = useConfigValue("api-url"); // "https://api.example.com"
+ * const limit = useConfigValue("max-items", 100); // 100 if not set
+ * ```
+ */
+declare function useConfigValue<T = any>(key: string, fallback?: T): T | undefined;
+/**
+ * Returns the JWT token for making authenticated API calls.
+ *
+ * ```tsx
+ * const token = useToken();
+ * fetch("/api/data", { headers: { Authorization: `Bearer ${token}` } });
+ * ```
+ */
+declare function useToken(): string | null;
+
+type UseImagesOptions = {
+    page?: number;
+    pageSize?: number;
+    q?: string;
+    refType?: string;
+    refId?: string;
+    enabled?: boolean;
+};
+type UseImagesReturn = {
+    images: ImageResource[];
+    page: number;
+    pageSize: number;
+    total: number;
+    pageCount: number;
+    loading: boolean;
+    error: string | null;
+    refetch: () => void;
+    setPage: (page: number) => void;
+    setQuery: (q: string) => void;
+    available: boolean;
+    removeImage: (imageId: string) => Promise<void>;
+    updateImage: (imageId: string, opts: ImageUpdateOptions) => Promise<void>;
+};
+declare function useImages(opts?: UseImagesOptions): UseImagesReturn;
+
+type UseImageUploadReturn = {
+    upload: (opts: ImageUploadOptions) => Promise<void>;
+    cancel: () => void;
+    progress: UploadProgress;
+    reset: () => void;
+    available: boolean;
+};
+declare function useImageUpload(): UseImageUploadReturn;
+
+type UseImageOptions = {
+    enabled?: boolean;
+};
+type UseImageReturn = {
+    image: ImageResource | null;
+    loading: boolean;
+    error: string | null;
+    refetch: () => void;
+    available: boolean;
+};
+declare function useImage(imageId: string | null | undefined, opts?: UseImageOptions): UseImageReturn;
+
+interface ImageUploaderProps {
+    onUpload?: () => void;
+    onError?: (error: string) => void;
+    defaultTitle?: string;
+    defaultDescription?: string;
+    variants?: string;
+    showFields?: boolean;
+    showVariantPicker?: boolean;
+    accept?: string;
+    maxSize?: number;
+    refType?: string;
+    refId?: string;
+    className?: string;
+    style?: React.CSSProperties;
+    label?: string;
+    disabled?: boolean;
+}
+declare function ImageUploader({ onUpload, onError, defaultTitle, defaultDescription, variants: variantsProp, showFields, showVariantPicker, accept, maxSize, refType, refId, className, style, label, disabled, }: ImageUploaderProps): react_jsx_runtime.JSX.Element | null;
+
+interface ImagePickerProps {
+    onSelect?: (image: ImageResource) => void;
+    onClose?: () => void;
+    mode?: "modal" | "inline";
+    pageSize?: number;
+    showSearch?: boolean;
+    searchPlaceholder?: string;
+    selectedImageId?: string;
+    columns?: number;
+    showActions?: boolean;
+    refType?: string;
+    refId?: string;
+    /** Increment to trigger a refetch (e.g. after an upload). */
+    refreshSignal?: number;
+    className?: string;
+    style?: React.CSSProperties;
+}
+declare function ImagePicker({ onSelect, onClose, mode, pageSize, showSearch, searchPlaceholder, selectedImageId, columns, showActions, refType, refId, refreshSignal, className, style, }: ImagePickerProps): react_jsx_runtime.JSX.Element | null;
+
+interface ImageDetailsProps {
+    image: ImageResource;
+    onClose: () => void;
+    onEdit?: (image: ImageResource) => void;
+    onDelete?: (image: ImageResource) => void;
+    className?: string;
+    style?: React.CSSProperties;
+}
+declare function ImageDetails({ image, onClose, onEdit, onDelete, className, style, }: ImageDetailsProps): react_jsx_runtime.JSX.Element;
+
+interface MrImageProps {
+    image: ImageResource;
+    width?: number;
+    height?: number;
+    variant?: string;
+    alt?: string;
+    className?: string;
+    style?: React.CSSProperties;
+    loading?: "lazy" | "eager";
+    objectFit?: React.CSSProperties["objectFit"];
+    sizes?: string;
+    onLoad?: () => void;
+    onError?: () => void;
+}
+declare function MrImage({ image, width, height, variant: variantName, alt, className, style, loading, objectFit, sizes, onLoad, onError, }: MrImageProps): react_jsx_runtime.JSX.Element;
+
+type UseFilesOptions = {
+    page?: number;
+    pageSize?: number;
+    q?: string;
+    refType?: string;
+    refId?: string;
+    enabled?: boolean;
+};
+type UseFilesReturn = {
+    files: FileResource[];
+    page: number;
+    pageSize: number;
+    total: number;
+    pageCount: number;
+    loading: boolean;
+    error: string | null;
+    refetch: () => void;
+    setPage: (page: number) => void;
+    setQuery: (q: string) => void;
+    available: boolean;
+    removeFile: (fileId: string) => Promise<void>;
+    updateFile: (fileId: string, opts: FileUpdateOptions) => Promise<void>;
+};
+declare function useFiles(opts?: UseFilesOptions): UseFilesReturn;
+
+type UseFileOptions = {
+    enabled?: boolean;
+};
+type UseFileReturn = {
+    file: FileResource | null;
+    loading: boolean;
+    error: string | null;
+    refetch: () => void;
+    available: boolean;
+};
+declare function useFile(fileId: string | null | undefined, opts?: UseFileOptions): UseFileReturn;
+
+type UseFileUploadReturn = {
+    upload: (opts: FileUploadOptions) => Promise<void>;
+    cancel: () => void;
+    progress: UploadProgress;
+    reset: () => void;
+    available: boolean;
+};
+declare function useFileUpload(): UseFileUploadReturn;
+
+interface FileUploaderProps {
+    onUpload?: () => void;
+    onError?: (error: string) => void;
+    defaultTitle?: string;
+    defaultDescription?: string;
+    showFields?: boolean;
+    accept?: string;
+    maxSize?: number;
+    refType?: string;
+    refId?: string;
+    className?: string;
+    style?: React.CSSProperties;
+    label?: string;
+    disabled?: boolean;
+}
+declare function FileUploader({ onUpload, onError, defaultTitle, defaultDescription, showFields, accept, maxSize, refType, refId, className, style, label, disabled, }: FileUploaderProps): react_jsx_runtime.JSX.Element | null;
+
+interface FilePickerProps {
+    onSelect?: (file: FileResource) => void;
+    onClose?: () => void;
+    mode?: "modal" | "inline";
+    pageSize?: number;
+    showSearch?: boolean;
+    searchPlaceholder?: string;
+    selectedFileId?: string;
+    showActions?: boolean;
+    refType?: string;
+    refId?: string;
+    /** Increment to trigger a refetch (e.g. after an upload). */
+    refreshSignal?: number;
+    className?: string;
+    style?: React.CSSProperties;
+}
+declare function FilePicker({ onSelect, onClose, mode, pageSize, showSearch, searchPlaceholder, selectedFileId, showActions, refType, refId, refreshSignal, className, style, }: FilePickerProps): react_jsx_runtime.JSX.Element | null;
+
+interface FileDetailsProps {
+    file: FileResource;
+    onClose: () => void;
+    onEdit?: (file: FileResource) => void;
+    onDelete?: (file: FileResource) => void;
+    className?: string;
+    style?: React.CSSProperties;
+}
+declare function FileDetails({ file, onClose, onEdit, onDelete, className, style, }: FileDetailsProps): react_jsx_runtime.JSX.Element;
+
+export { AppKit, type AppKitAccount, type AppKitAppData, AppKitAuthed, type AppKitConfigValue, type AppKitFeatureFlag, type AppKitProjectAccess, type AppKitTheme, FileDetails, type FileDetailsProps, type FileListResponse, FilePicker, type FilePickerProps, type FileResource, type FileUpdateOptions, type FileUploadOptions, FileUploader, type FileUploaderProps, ImageDetails, type ImageDetailsProps, type ImageListResponse, ImagePicker, type ImagePickerProps, type ImageResource, type ImageUpdateOptions, type ImageUploadOptions, ImageUploader, type ImageUploaderProps, type ImageVariant, type ManyRowsAppKitError, type ManyRowsAppKitErrorCode, type ManyRowsAppKitHandle, type ManyRowsAppKitReady, type ManyRowsAppKitSnapshot, MrImage, type MrImageProps, type UploadProgress, type UseFileOptions, type UseFileReturn, type UseFileUploadReturn, type UseFilesOptions, type UseFilesReturn, type UseImageOptions, type UseImageReturn, type UseImageUploadReturn, type UseImagesOptions, type UseImagesReturn, UserButton, type UserButtonProps, useAppKit, useConfig, useConfigValue, useFeatureFlag, useFeatureFlags, useFile, useFileUpload, useFiles, useImage, useImageUpload, useImages, usePermission, usePermissions, useProject, useRole, useRoles, useToken, useUser };