react-native-timer-picker 2.1.0 → 2.2.0

package/dist/typescript/components/TimerPickerModal/types.d.ts

@@ -1,18 +1,20 @@
-import type { MutableRefObject } from "react";
+import type { RefObject } from "react";
 import type { View, TouchableOpacity, Text } from "react-native";
 import type Modal from "../Modal";
 import type { TimerPickerProps } from "../TimerPicker/types";
 import type { CustomTimerPickerModalStyles } from "./styles";
 export interface TimerPickerModalRef {
     latestDuration: {
-        hours: MutableRefObject<number> | undefined;
-        minutes: MutableRefObject<number> | undefined;
-        seconds: MutableRefObject<number> | undefined;
+        days: RefObject<number> | undefined;
+        hours: RefObject<number> | undefined;
+        minutes: RefObject<number> | undefined;
+        seconds: RefObject<number> | undefined;
     };
     reset: (options?: {
         animated?: boolean;
     }) => void;
     setValue: (value: {
+        days: number;
         hours: number;
         minutes: number;
         seconds: number;
@@ -33,7 +35,8 @@ export interface TimerPickerModalProps extends TimerPickerProps {
     modalTitle?: string;
     modalTitleProps?: React.ComponentProps<typeof Text>;
     onCancel?: () => void;
-    onConfirm: ({ hours, minutes, seconds, }: {
+    onConfirm: ({ days, hours, minutes, seconds, }: {
+        days: number;
         hours: number;
         minutes: number;
         seconds: number;

package/dist/typescript/index.d.ts

@@ -1,6 +1,2 @@
-export { default as TimerPickerModal } from "./components/TimerPickerModal";
-export { TimerPickerModalProps, TimerPickerModalRef, } from "./components/TimerPickerModal/types";
-export { CustomTimerPickerModalStyles } from "./components/TimerPickerModal/styles";
-export { default as TimerPicker } from "./components/TimerPicker";
-export { TimerPickerProps, TimerPickerRef, } from "./components/TimerPicker/types";
-export { CustomTimerPickerStyles } from "./components/TimerPicker/styles";
+export { default as TimerPickerModal, TimerPickerModalProps, TimerPickerModalRef, CustomTimerPickerModalStyles, } from "./components/TimerPickerModal";
+export { default as TimerPicker, TimerPickerProps, TimerPickerRef, CustomTimerPickerStyles, } from "./components/TimerPicker";

package/dist/typescript/utils/colorToRgba.d.ts

@@ -1,3 +1,37 @@
+/**
+ * Converts various color formats to RGBA string representation.
+ * This function is specifically required for expo-linear-gradient on iOS to handle transparent colors correctly.
+ * It supports named colors, RGB, and hex color formats.
+ *
+ * @param {Object} variables - The input variables object
+ * @param {string} variables.color - The color to convert. Can be:
+ *   - Named color (e.g., 'transparent', 'black', 'white', 'blue', 'green', 'gray', 'red')
+ *   - RGB format (e.g., 'rgb(255, 0, 0)')
+ *   - Hex format (e.g., '#FF0000' or '#F00')
+ * @param {number} [variables.opacity=1] - The opacity value between 0 and 1
+ *
+ * @returns {string} The color in RGBA format (e.g., 'rgba(255, 0, 0, 0.5)')
+ *
+ * @example
+ * // Using named color
+ * colorToRgba({ color: 'transparent' })
+ * // Returns: 'rgba(0, 0, 0, 0)'
+ *
+ * @example
+ * // Using RGB with custom opacity
+ * colorToRgba({ color: 'rgb(255, 0, 0)', opacity: 0.5 })
+ * // Returns: 'rgba(255, 0, 0, 0.5)'
+ *
+ * @example
+ * // Using hex color
+ * colorToRgba({ color: '#FF0000' })
+ * // Returns: 'rgba(255, 0, 0, 1)'
+ *
+ * @example
+ * // Using short hex color
+ * colorToRgba({ color: '#F00' })
+ * // Returns: 'rgba(255, 0, 0, 1)'
+ */
 export declare const colorToRgba: (variables: {
     color: string;
     opacity?: number;

package/dist/typescript/utils/generateNumbers.d.ts

@@ -1,3 +1,37 @@
+/**
+ * Generates an array of formatted numbers for a number picker, with support for infinite scroll,
+ * padding, and number repetition.
+ *
+ * @param {number} numberOfItems - Total number of items to generate
+ * @param {Object} options - Configuration options for number generation
+ * @param {boolean} [options.disableInfiniteScroll] - Whether to disable infinite scroll
+ * @param {number} options.interval - The interval between consecutive numbers
+ * @param {boolean} [options.padNumbersWithZero] - Whether to pad single-digit numbers with leading zeros
+ * @param {number} options.padWithNItems - Number of empty items to pad with
+ * @param {number} options.repeatNTimes - How many times to repeat the number sequence
+ *
+ * @returns {string[]} Array of formatted number strings
+ *
+ * @example
+ * // Generate numbers 0-9 with padding
+ * generateNumbers(10, {
+ *   interval: 1,
+ *   padWithNItems: 2,
+ *   repeatNTimes: 1,
+ *   padNumbersWithZero: true
+ * })
+ * // Returns: ['', '', '00', '01', '02', '03', '04', '05', '06', '07', '08', '09', '', '']
+ *
+ * @example
+ * // Generate even numbers with infinite scroll
+ * generateNumbers(5, {
+ *   interval: 2,
+ *   padWithNItems: 2,
+ *   repeatNTimes: 3,
+ *   disableInfiniteScroll: false
+ * })
+ * // Returns: ['0', '2', '4', '6', '8', '0', '2', '4', '6', '8', '0', '2', '4', '6', '8']
+ */
 export declare const generateNumbers: (numberOfItems: number, options: {
     disableInfiniteScroll?: boolean;
     interval: number;
@@ -5,6 +39,38 @@ export declare const generateNumbers: (numberOfItems: number, options: {
     padWithNItems: number;
     repeatNTimes: number;
 }) => string[];
+/**
+ * Generates an array of formatted 12-hour time strings (AM/PM) for a time picker.
+ * Supports infinite scroll, padding, and number repetition.
+ *
+ * @param {Object} options - Configuration options for time generation
+ * @param {boolean} [options.disableInfiniteScroll] - Whether to disable infinite scroll
+ * @param {number} options.interval - The interval between hours (must be a divisor of 12)
+ * @param {boolean} [options.padNumbersWithZero] - Whether to pad single-digit hours with leading zeros
+ * @param {number} options.padWithNItems - Number of empty items to pad with
+ * @param {number} [options.repeatNTimes] - How many times to repeat the time sequence (defaults to 1)
+ *
+ * @returns {string[]} Array of formatted 12-hour time strings
+ *
+ * @example
+ * // Generate hours with 1-hour interval
+ * generate12HourNumbers({
+ *   interval: 1,
+ *   padWithNItems: 2,
+ *   padNumbersWithZero: true
+ * })
+ * // Returns: ['', '', '12 AM', '01 AM', '02 AM', ..., '11 PM', '', '']
+ *
+ * @example
+ * // Generate hours with 2-hour interval and infinite scroll
+ * generate12HourNumbers({
+ *   interval: 2,
+ *   padWithNItems: 2,
+ *   repeatNTimes: 2,
+ *   disableInfiniteScroll: false
+ * })
+ * // Returns: ['12 AM', '2 AM', '4 AM', ..., '10 PM', '12 AM', '2 AM', ...]
+ */
 export declare const generate12HourNumbers: (options: {
     disableInfiniteScroll?: boolean;
     interval: number;

package/dist/typescript/utils/getAdjustedLimit.d.ts

@@ -1,5 +1,30 @@
-import type { LimitType } from "../components/DurationScroll/types";
-export declare const getAdjustedLimit: (limit: LimitType | undefined, numberOfItems: number, interval: number) => {
+import type { Limit } from "../components/DurationScroll/types";
+/**
+ * Adjusts and validates the min/max limits for a scrollable number picker.
+ * Ensures limits are within valid bounds and handles edge cases.
+ *
+ * @param {Limit | undefined} limit - The input limit object containing optional min and max values
+ * @param {number} numberOfItems - Total number of items in the picker
+ * @param {number} interval - The interval between consecutive numbers
+ *
+ * @returns {{ max: number; min: number }} An object containing the adjusted min and max limits
+ *
+ * @example
+ * // With valid limits
+ * getAdjustedLimit({ min: 5, max: 15 }, 20, 1)
+ * // Returns: { max: 15, min: 5 }
+ *
+ * @example
+ * // With out-of-bounds limits
+ * getAdjustedLimit({ min: -5, max: 25 }, 20, 1)
+ * // Returns: { max: 19, min: 0 }
+ *
+ * @example
+ * // With invalid limits (max < min)
+ * getAdjustedLimit({ min: 15, max: 5 }, 20, 1)
+ * // Returns: { max: 19, min: 0 }
+ */
+export declare const getAdjustedLimit: (limit: Limit | undefined, numberOfItems: number, interval: number) => {
     max: number;
     min: number;
 };

package/dist/typescript/utils/getDurationAndIndexFromScrollOffset.d.ts

@@ -1,3 +1,41 @@
+/**
+ * Calculates the duration value and index from a scroll offset in a number picker.
+ * Handles both infinite and non-infinite scroll modes, taking into account padding and item height.
+ *
+ * @param {Object} variables - Configuration object for scroll offset calculation
+ * @param {boolean} variables.disableInfiniteScroll - Whether infinite scroll is disabled
+ * @param {number} variables.interval - The interval between consecutive numbers
+ * @param {number} variables.itemHeight - Height of each item in the picker
+ * @param {number} variables.numberOfItems - Total number of items in the picker
+ * @param {number} variables.padWithNItems - Number of empty items to pad with
+ * @param {number} variables.yContentOffset - The vertical scroll offset
+ *
+ * @returns {{ duration: number; index: number }} Object containing the calculated duration and index
+ *
+ * @example
+ * // With infinite scroll enabled
+ * getDurationAndIndexFromScrollOffset({
+ *   disableInfiniteScroll: false,
+ *   interval: 1,
+ *   itemHeight: 50,
+ *   numberOfItems: 24,
+ *   padWithNItems: 2,
+ *   yContentOffset: 100
+ * })
+ * // Returns: { duration: 2, index: 2 }
+ *
+ * @example
+ * // With infinite scroll disabled
+ * getDurationAndIndexFromScrollOffset({
+ *   disableInfiniteScroll: true,
+ *   interval: 1,
+ *   itemHeight: 50,
+ *   numberOfItems: 24,
+ *   padWithNItems: 2,
+ *   yContentOffset: 100
+ * })
+ * // Returns: { duration: 2, index: 2 }
+ */
 export declare const getDurationAndIndexFromScrollOffset: (variables: {
     disableInfiniteScroll: boolean;
     interval: number;

package/dist/typescript/utils/getInitialScrollIndex.d.ts

@@ -1,3 +1,41 @@
+/**
+ * Calculates the initial scroll index for a number picker based on the desired value and configuration.
+ * Handles both infinite and non-infinite scroll modes, taking into account padding and repetition.
+ *
+ * @param {Object} variables - Configuration object for scroll index calculation
+ * @param {boolean} variables.disableInfiniteScroll - Whether infinite scroll is disabled
+ * @param {number} variables.interval - The interval between consecutive numbers
+ * @param {number} variables.numberOfItems - Total number of items in the picker
+ * @param {number} variables.padWithNItems - Number of empty items to pad with
+ * @param {number} variables.repeatNumbersNTimes - How many times to repeat the number sequence
+ * @param {number} variables.value - The desired initial value
+ *
+ * @returns {number} The calculated initial scroll index
+ *
+ * @example
+ * // With infinite scroll enabled
+ * getInitialScrollIndex({
+ *   disableInfiniteScroll: false,
+ *   interval: 1,
+ *   numberOfItems: 24,
+ *   padWithNItems: 2,
+ *   repeatNumbersNTimes: 3,
+ *   value: 12
+ * })
+ * // Returns: 38
+ *
+ * @example
+ * // With infinite scroll disabled
+ * getInitialScrollIndex({
+ *   disableInfiniteScroll: true,
+ *   interval: 1,
+ *   numberOfItems: 24,
+ *   padWithNItems: 2,
+ *   repeatNumbersNTimes: 1,
+ *   value: 12
+ * })
+ * // Returns: 12
+ */
 export declare const getInitialScrollIndex: (variables: {
     disableInfiniteScroll: boolean;
     interval: number;

package/dist/typescript/utils/getSafeInitialValue.d.ts

@@ -1,8 +1,37 @@
+/**
+ * Safely extracts and validates initial duration values, ensuring all values are valid numbers.
+ * Returns a duration object with safe default values (0) for any invalid or missing inputs.
+ *
+ * @param {Object} [initialValue] - Optional initial duration values
+ * @param {number} [initialValue.days] - Initial days value
+ * @param {number} [initialValue.hours] - Initial hours value
+ * @param {number} [initialValue.minutes] - Initial minutes value
+ * @param {number} [initialValue.seconds] - Initial seconds value
+ *
+ * @returns {{ days: number; hours: number; minutes: number; seconds: number }} An object containing safe duration values
+ *
+ * @example
+ * // With valid values
+ * getSafeInitialValue({ days: 1, hours: 2, minutes: 30, seconds: 45 })
+ * // Returns: { days: 1, hours: 2, minutes: 30, seconds: 45 }
+ *
+ * @example
+ * // With invalid values
+ * getSafeInitialValue({ days: NaN, hours: 'invalid', minutes: undefined })
+ * // Returns: { days: 0, hours: 0, minutes: 0, seconds: 0 }
+ *
+ * @example
+ * // With undefined input
+ * getSafeInitialValue(undefined)
+ * // Returns: { days: 0, hours: 0, minutes: 0, seconds: 0 }
+ */
 export declare const getSafeInitialValue: (initialValue: {
+    days?: number;
     hours?: number;
     minutes?: number;
     seconds?: number;
 } | undefined) => {
+    days: number;
     hours: number;
     minutes: number;
     seconds: number;

package/dist/typescript/utils/padNumber.d.ts

@@ -1,3 +1,28 @@
+/**
+ * Formats a number by optionally padding it with a leading zero or space.
+ * Numbers less than 10 are padded based on the options provided.
+ *
+ * @param {number} value - The number to format
+ * @param {Object} [options] - Optional formatting options
+ * @param {boolean} [options.padWithZero] - Whether to pad with zero (true) or space (false)
+ *
+ * @returns {string} The formatted number string
+ *
+ * @example
+ * // Pad with zero
+ * padNumber(5, { padWithZero: true })
+ * // Returns: '05'
+ *
+ * @example
+ * // Pad with space
+ * padNumber(5, { padWithZero: false })
+ * // Returns: ' 5'
+ *
+ * @example
+ * // No padding needed
+ * padNumber(15)
+ * // Returns: '15'
+ */
 export declare const padNumber: (value: number, options?: {
     padWithZero?: boolean;
 }) => string;

package/package.json

@@ -6,12 +6,12 @@
         "url": "https://github.com/troberts-28"
     },
     "license": "MIT",
-    "version": "2.1.0",
+    "version": "2.2.0",
     "main": "dist/commonjs/index.js",
     "module": "dist/module/index.js",
     "types": "dist/typescript/index.d.ts",
     "typings": "dist/typescript/index.d.ts",
-    "packageManager": "yarn@3.6.4",
+    "packageManager": "yarn@4.9.1",
     "workspaces": {
         "packages": [
             "examples/*"
@@ -21,12 +21,13 @@
         "setup": "yarn install",
         "start": " yarn workspace example-expo start",
         "start-bare:android": "yarn workspace example-bare android && yarn workspace example-bare start",
-        "start-bare:ios": "yarn workspace example-bare android && yarn workspace example-bare start",
+        "start-bare:ios": "yarn workspace example-bare ios && yarn workspace example-bare start",
         "test": "jest --forceExit --silent",
         "build": "bob build",
         "clean": "rm yarn.lock && rm -rf ./node_modules && yarn install",
         "lint": "eslint --ext .ts,.tsx .",
         "lint:fix": "eslint --ext .ts,.tsx . --fix",
+        "ts": "tsc --noEmit",
         "prepare": "yarn build"
     },
     "homepage": "https://github.com/troberts-28/react-native-timer-picker",
@@ -87,36 +88,17 @@
     "engines": {
         "node": ">=16.0.0"
     },
-    "jest": {
-        "preset": "react-native",
-        "moduleFileExtensions": [
-            "ts",
-            "tsx",
-            "js",
-            "jsx",
-            "json",
-            "node"
-        ],
-        "testEnvironment": "node",
-        "modulePathIgnorePatterns": [
-            "<rootDir>/dist/",
-            "<rootDir>/examples/"
-        ],
-        "transformIgnorePatterns": []
-    },
     "peerDependencies": {
         "react": ">=18.2.0",
         "react-native": ">=0.72.0"
     },
     "devDependencies": {
         "@babel/core": "^7.20.0",
-        "@babel/plugin-transform-class-properties": "^7.22.5",
-        "@babel/plugin-transform-flow-strip-types": "^7.22.5",
-        "@babel/plugin-transform-private-methods": "^7.22.5",
         "@testing-library/react-native": "^12.0.0",
         "@types/jest": "^29.0.0",
-        "@types/react": "^18.0.27",
-        "@types/react-native": "^0.70.6",
+        "@types/react": ">=18.2.0",
+        "@types/react-native": "0.72.0",
+        "@types/react-test-renderer": ">=18.2.0",
         "@typescript-eslint/eslint-plugin": "^5.49.0",
         "@typescript-eslint/parser": "^5.49.0",
         "babel-jest": "^29.6.2",
@@ -125,11 +107,12 @@
         "eslint-plugin-react": "^7.33.1",
         "eslint-plugin-react-hooks": "^4.6.0",
         "eslint-plugin-sort-destructure-keys": "^1.5.0",
-        "eslint-plugin-typescript-sort-keys": "^3.1.0",
+        "eslint-plugin-typescript-sort-keys": "^2.3.0",
         "jest": "^29.0.0",
         "metro-react-native-babel-preset": "^0.71.1",
+        "prettier": "2.8.8",
         "react-native-builder-bob": "^0.18.3",
-        "react-test-renderer": "^18.0.0",
+        "react-test-renderer": "18.2.0",
         "typescript": "^4.7.4"
     },
     "react-native-builder-bob": {