react-native-bikram-sambat 0.1.1 → 0.1.2

package/README.md

@@ -1,33 +1,19 @@
 # react-native-bikram-sambat
 
-A production-grade Bikram Sambat (BS) calendar engine and React Native date picker for React Native.
+A TypeScript-first Bikram Sambat calendar toolkit for React Native.
 
-TypeScript-first helpers for BS/AD conversion, formatting, parsing, and calendar grid generation, plus ready-to-use React Native UI components with theming, dark mode, and accessibility.
+`react-native-bikram-sambat` provides BS date conversion utilities and ready-to-use React Native components for Nepali calendar UIs. It includes date pickers, range pickers, formatting and parsing helpers, locale support, numeral conversion, theming, dark mode support, and accessibility-friendly calendar interactions.
 
-## Installation
+## How to Use
 
-```sh
-npm install react-native-bikram-sambat
-```
-
-or
-
-```sh
-yarn add react-native-bikram-sambat
-```
-
-## Quick Start
-
-### Date Picker
-
-The simplest way to let users pick a BS date:
+### Date picker
 
 ```tsx
 import React, { useState } from 'react';
 import { SafeAreaView } from 'react-native';
 import {
   NepaliDatePicker,
-  type BSDateValue
+  type BSDateValue,
 } from 'react-native-bikram-sambat';
 
 export default function App() {
@@ -47,69 +33,35 @@ export default function App() {
 }
 ```
 
-### Calendar Component
-
-For inline calendar display:
+### Calendar
 
 ```tsx
 import React, { useState } from 'react';
 import { SafeAreaView } from 'react-native';
-import { NepaliCalendar, type BSDateValue } from 'react-native-bikram-sambat';
-
-export default function App() {
-  const [date, setDate] = useState<BSDateValue | null>(null);
-
-  return (
-    <SafeAreaView style={{ flex: 1 }}>
-      <NepaliCalendar value={date} onChange={setDate} />
-    </SafeAreaView>
-  );
-}
-```
-
-### Date Picker Modal
-
-For custom modal control:
-
-```tsx
-import React, { useState } from 'react';
-import { Button, SafeAreaView } from 'react-native';
 import {
-  DatePickerModal,
-  type BSDateValue
+  NepaliCalendar,
+  type BSDateValue,
 } from 'react-native-bikram-sambat';
 
 export default function App() {
-  const [visible, setVisible] = useState(false);
   const [date, setDate] = useState<BSDateValue | null>(null);
 
   return (
-    <SafeAreaView style={{ flex: 1, padding: 16 }}>
-      <Button title="Open date picker" onPress={() => setVisible(true)} />
-
-      <DatePickerModal
-        visible={visible}
-        value={date}
-        onChange={setDate}
-        onClose={() => setVisible(false)}
-        locale="ne"
-        numerals="devanagari"
-      />
+    <SafeAreaView style={{ flex: 1 }}>
+      <NepaliCalendar value={date} onChange={setDate} />
     </SafeAreaView>
   );
 }
 ```
 
-### Range Picker
-
-For selecting a date range:
+### Range picker
 
 ```tsx
 import React, { useState } from 'react';
 import { SafeAreaView } from 'react-native';
 import {
   NepaliRangePicker,
-  type DateRangeValue
+  type DateRangeValue,
 } from 'react-native-bikram-sambat';
 
 export default function App() {
@@ -132,227 +84,28 @@ export default function App() {
 }
 ```
 
-### Range Picker Modal
+### Core utilities
 
-For custom range picker modal control:
-
-```tsx
-import React, { useState } from 'react';
-import { Button, SafeAreaView } from 'react-native';
+```ts
 import {
-  RangePickerModal,
-  type DateRangeValue
+  toBS,
+  toAD,
+  formatBS,
+  parseBS,
+  toNepaliNumerals,
+  toLatinNumerals,
 } from 'react-native-bikram-sambat';
 
-export default function App() {
-  const [visible, setVisible] = useState(false);
-  const [range, setRange] = useState<DateRangeValue>({
-    start: null,
-    end: null,
-  });
-
-  return (
-    <SafeAreaView style={{ flex: 1, padding: 16 }}>
-      <Button title="Open range picker" onPress={() => setVisible(true)} />
-
-      <RangePickerModal
-        visible={visible}
-        value={range}
-        onChange={setRange}
-        onClose={() => setVisible(false)}
-        locale="ne"
-        numerals="devanagari"
-      />
-    </SafeAreaView>
-  );
-}
-```
-
-## Core Utilities
-
-### BS ⇄ AD Conversion
-
-```ts
-import { toBS, toAD, isValidBSDate, isValidADDate } from 'react-native-bikram-sambat';
-
 const bs = toBS({ calendar: 'AD', year: 2024, month: 4, day: 13 });
 const ad = toAD({ calendar: 'BS', year: 2081, month: 1, day: 1 });
 
-const valid = isValidBSDate({ calendar: 'BS', year: 2081, month: 1, day: 1 });
-const validAD = isValidADDate({ calendar: 'AD', year: 2024, month: 4, day: 13 });
-```
-
-### Formatting and Parsing
-
-```ts
-import { formatBS, parseBS, toNepaliNumerals, toLatinNumerals } from 'react-native-bikram-sambat';
-
-const date = { calendar: 'BS', year: 2081, month: 1, day: 5 };
-
-formatBS(date, 'yyyy-MM-dd');           // '2081-01-05'
-formatBS(date, 'dd MMMM yyyy');         // '05 Baisakh 2081'
-formatBS(date, 'dd MMMM yyyy', { locale: 'ne', numerals: 'devanagari' }); // '०५ बैशाख २०८१'
-
-parseBS('2081-01-05', 'yyyy-MM-dd');    // { calendar: 'BS', year: 2081, month: 1, day: 5 }
-
-toNepaliNumerals('2081');               // '२०८१'
-toLatinNumerals('२०८१');               // '2081'
-```
-
-### Date Arithmetic
-
-```ts
-import { compareBS, addBSDays, subBSDays, todayBS } from 'react-native-bikram-sambat';
-
-const today = todayBS();
-const future = addBSDays(today, 30);
-const past = subBSDays(today, 30);
-const cmp = compareBS(future, past); // > 0
-```
-
-### Date Keys
-
-```ts
-import { createBSDateKey, parseBSDateKey } from 'react-native-bikram-sambat';
-
-const key = createBSDateKey({ calendar: 'BS', year: 2081, month: 1, day: 1 });
-// '2081-01-01'
-
-const parsed = parseBSDateKey('2081-01-01');
-// { calendar: 'BS', year: 2081, month: 1, day: 1 }
-```
-
-### Supported Range
-
-```ts
-import { getSupportedBSRange, isBSDateInSupportedRange } from 'react-native-bikram-sambat';
-
-const range = getSupportedBSRange(); // { start: 2081, end: 2081 }
-const inRange = isBSDateInSupportedRange({ calendar: 'BS', year: 2081, month: 1, day: 1 });
-```
-
-### Calendar Grid
-
-```ts
-import { getCalendarMonthGrid } from 'react-native-bikram-sambat';
-
-const grid = getCalendarMonthGrid({
-  year: 2081,
-  month: 1,
-  weekStartsOn: 0, // 0 = Sunday
-  minDate: { calendar: 'BS', year: 2081, month: 1, day: 1 },
-  maxDate: { calendar: 'BS', year: 2081, month: 12, day: 30 },
-});
-
-// grid.weeks is a 2D array of cells
-```
-
-## TypeScript Usage
-
-All public APIs are fully typed:
-
-```ts
-import {
-  type BSDateValue,
-  type ADDateValue,
-  type DateRangeValue,
-  type CalendarTheme,
-  type CalendarMarkedDate,
-  type NepaliCalendarProps,
-  type NepaliDatePickerProps,
-  type DatePickerModalProps,
-  type NepaliRangePickerProps,
-  type RangePickerModalProps,
-  type CalendarLocale,
-  type LocaleCode,
-  type NumeralSystem,
-} from 'react-native-bikram-sambat';
-```
-
-## Theme Customization
-
-### Light and Dark Mode
-
-```tsx
-import { NepaliCalendar } from 'react-native-bikram-sambat';
-
-// System default (auto-detects device theme)
-<NepaliCalendar colorScheme="system" />
-
-// Force dark mode
-<NepaliCalendar colorScheme="dark" />
-
-// Force light mode
-<NepaliCalendar colorScheme="light" />
-```
-
-### Custom Theme Override
-
-```tsx
-import { NepaliDatePicker, type CalendarTheme } from 'react-native-bikram-sambat';
-
-const customTheme: Partial<CalendarTheme> = {
-  colors: {
-    primary: '#7c3aed',
-    primaryText: '#ffffff',
-  },
-  radius: {
-    day: 16,
-    calendar: 16,
-  },
-};
-
-<NepaliDatePicker theme={customTheme} />
-```
-
-## Local Package Testing
+const formatted = formatBS(bs, 'yyyy-MM-dd');
+const parsed = parseBS('2081-01-05', 'yyyy-MM-dd');
 
-When developing locally, test the package before publishing:
-
-```sh
-npm run typecheck
-npm test
-npm run build
-npm pack --dry-run
-npm pack
+const devanagari = toNepaliNumerals('2081');
+const latin = toLatinNumerals('२०८१');
 ```
 
-This produces a `.tgz` file. Test it in another React Native CLI app:
-
-```sh
-cd /path/to/your/app
-npm install ../Calender/react-native-bikram-sambat-0.1.0.tgz
-```
-
-## Supported BS Range
-
-The package currently supports the verified BS date range included in its data table. Dates outside the supported range will throw or return `false` depending on the API.
-
-Core conversion functions throw `RangeError` for out-of-range dates.
-UI components handle invalid dates gracefully without crashing.
-
-## Publishing
-
-Publishing is handled by GitHub Actions when code is pushed to `main`.
-
-Before publishing, add an npm automation token in GitHub:
-
-- Repository settings → Secrets and variables → Actions
-- Add secret named `NPM_TOKEN`
-
-To publish a new version:
-
-```sh
-npm version patch
-git push origin main --follow-tags
-```
-
-The workflow publishes only if the current package version is not already on npm.
-
 ## Screenshot
 
 ![Calendar view](./docs/screenshots/iphone-15-pro-max-calendar.png)
-
-## License
-
-MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-bikram-sambat",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "A production-grade Bikram Sambat calendar engine and React Native date picker for React Native.",
   "main": "./lib/commonjs/index.js",
   "module": "./lib/module/index.js",