react-native-permission-handler 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,146 @@
+import { Permission, PermissionStatus } from 'react-native-permissions';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+/**
+ * States of the permission flow state machine.
+ */
+type PermissionFlowState = "idle" | "checking" | "prePrompt" | "requesting" | "granted" | "denied" | "blocked" | "blockedPrompt" | "openingSettings" | "recheckingAfterSettings" | "unavailable";
+/**
+ * Events that drive state transitions.
+ */
+type PermissionFlowEvent = {
+    type: "CHECK";
+} | {
+    type: "CHECK_RESULT";
+    status: PermissionStatus;
+} | {
+    type: "PRE_PROMPT_CONFIRM";
+} | {
+    type: "PRE_PROMPT_DISMISS";
+} | {
+    type: "REQUEST_RESULT";
+    status: PermissionStatus;
+} | {
+    type: "OPEN_SETTINGS";
+} | {
+    type: "SETTINGS_RETURN";
+} | {
+    type: "RECHECK_RESULT";
+    status: PermissionStatus;
+};
+/**
+ * Configuration for the pre-prompt modal.
+ */
+interface PrePromptConfig {
+    title: string;
+    message: string;
+    confirmLabel?: string;
+    cancelLabel?: string;
+}
+/**
+ * Configuration for the blocked-prompt modal.
+ */
+interface BlockedPromptConfig {
+    title: string;
+    message: string;
+    settingsLabel?: string;
+}
+/**
+ * Callbacks for analytics and side effects.
+ */
+interface PermissionCallbacks {
+    onGrant?: () => void;
+    onDeny?: () => void;
+    onBlock?: () => void;
+    onSettingsReturn?: (granted: boolean) => void;
+}
+/**
+ * Configuration for usePermissionHandler.
+ */
+interface PermissionHandlerConfig extends PermissionCallbacks {
+    permission: Permission | "notifications";
+    prePrompt: PrePromptConfig;
+    blockedPrompt: BlockedPromptConfig;
+    autoCheck?: boolean;
+    recheckOnForeground?: boolean;
+}
+/**
+ * Return type of usePermissionHandler.
+ */
+interface PermissionHandlerResult {
+    state: PermissionFlowState;
+    nativeStatus: PermissionStatus | null;
+    isGranted: boolean;
+    isDenied: boolean;
+    isBlocked: boolean;
+    isChecking: boolean;
+    isUnavailable: boolean;
+    request: () => void;
+    check: () => void;
+    dismiss: () => void;
+    openSettings: () => void;
+}
+/**
+ * Configuration for a single permission within useMultiplePermissions.
+ */
+interface MultiPermissionEntry extends PermissionCallbacks {
+    permission: Permission | "notifications";
+    prePrompt: PrePromptConfig;
+    blockedPrompt: BlockedPromptConfig;
+}
+/**
+ * Configuration for useMultiplePermissions.
+ */
+interface MultiplePermissionsConfig {
+    permissions: MultiPermissionEntry[];
+    strategy: "sequential" | "parallel";
+    onAllGranted?: () => void;
+}
+/**
+ * Return type of useMultiplePermissions.
+ */
+interface MultiplePermissionsResult {
+    statuses: Record<string, PermissionFlowState>;
+    allGranted: boolean;
+    request: () => void;
+}
+
+declare function transition(state: PermissionFlowState, event: PermissionFlowEvent): PermissionFlowState;
+
+declare function usePermissionHandler(config: PermissionHandlerConfig): PermissionHandlerResult;
+
+declare function useMultiplePermissions(config: MultiplePermissionsConfig): MultiplePermissionsResult;
+
+interface PermissionGateProps extends PermissionCallbacks {
+    permission: Permission | "notifications";
+    prePrompt: PrePromptConfig;
+    blockedPrompt: BlockedPromptConfig;
+    children: ReactNode;
+    fallback?: ReactNode;
+    renderPrePrompt?: (props: {
+        config: PrePromptConfig;
+        onConfirm: () => void;
+        onCancel: () => void;
+    }) => ReactNode;
+    renderBlockedPrompt?: (props: {
+        config: BlockedPromptConfig;
+        onOpenSettings: () => void;
+    }) => ReactNode;
+}
+declare function PermissionGate({ permission, prePrompt, blockedPrompt, children, fallback, renderPrePrompt, renderBlockedPrompt, onGrant, onDeny, onBlock, onSettingsReturn, }: PermissionGateProps): react_jsx_runtime.JSX.Element;
+
+interface DefaultPrePromptProps extends PrePromptConfig {
+    visible: boolean;
+    onConfirm: () => void;
+    onCancel: () => void;
+}
+declare function DefaultPrePrompt({ visible, title, message, confirmLabel, cancelLabel, onConfirm, onCancel, }: DefaultPrePromptProps): react_jsx_runtime.JSX.Element;
+
+interface DefaultBlockedPromptProps extends BlockedPromptConfig {
+    visible: boolean;
+    onOpenSettings: () => void;
+}
+declare function DefaultBlockedPrompt({ visible, title, message, settingsLabel, onOpenSettings, }: DefaultBlockedPromptProps): react_jsx_runtime.JSX.Element;
+
+export { type BlockedPromptConfig, DefaultBlockedPrompt, type DefaultBlockedPromptProps, DefaultPrePrompt, type DefaultPrePromptProps, type MultiPermissionEntry, type MultiplePermissionsConfig, type MultiplePermissionsResult, type PermissionCallbacks, type PermissionFlowEvent, type PermissionFlowState, PermissionGate, type PermissionGateProps, type PermissionHandlerConfig, type PermissionHandlerResult, type PrePromptConfig, transition, useMultiplePermissions, usePermissionHandler };