@zulfio/react-native-alarm-kit 1.0.0

package/package.json

@@ -0,0 +1,168 @@
+{
+  "name": "@zulfio/react-native-alarm-kit",
+  "version": "1.0.0",
+  "description": "This library provides a simple and modern interface for working with alarms in your React Native app using Apple’s latest AlarmKit framework.",
+  "main": "./lib/module/index.js",
+  "types": "./lib/typescript/src/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.tsx",
+      "types": "./lib/typescript/src/index.d.ts",
+      "default": "./lib/module/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "nitrogen",
+    "nitro.json",
+    "*.podspec",
+    "react-native.config.js",
+    "!ios/build",
+    "!android/build",
+    "!android/gradle",
+    "!android/gradlew",
+    "!android/gradlew.bat",
+    "!android/local.properties",
+    "!**/__tests__",
+    "!**/__fixtures__",
+    "!**/__mocks__",
+    "!**/.*"
+  ],
+  "scripts": {
+    "example": "yarn workspace react-native-alarm-kit-example",
+    "test": "jest",
+    "typecheck": "tsc",
+    "lint": "eslint \"**/*.{js,ts,tsx}\"",
+    "clean": "del-cli android/build example/android/build example/android/app/build example/ios/build lib",
+    "prepare": "bob build",
+    "nitrogen": "nitro-codegen",
+    "release": "release-it --only-version"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/raphckrman/react-native-alarm-kit.git"
+  },
+  "author": "raphckrman <raphckrman@proton.me> (https://github.com/raphckrman)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/raphckrman/react-native-alarm-kit/issues"
+  },
+  "homepage": "https://github.com/raphckrman/react-native-alarm-kit#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^19.6.0",
+    "@eslint/compat": "^1.2.7",
+    "@eslint/eslintrc": "^3.3.0",
+    "@eslint/js": "^9.22.0",
+    "@evilmartians/lefthook": "^1.5.0",
+    "@react-native/babel-preset": "0.79.2",
+    "@react-native/eslint-config": "^0.78.0",
+    "@release-it/conventional-changelog": "^9.0.2",
+    "@types/jest": "^29.5.5",
+    "@types/react": "^19.0.0",
+    "commitlint": "^19.6.1",
+    "del-cli": "^5.1.0",
+    "eslint": "^9.22.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-plugin-prettier": "^5.2.3",
+    "jest": "^29.7.0",
+    "nitro-codegen": "^0.26.3",
+    "prettier": "^3.0.3",
+    "react": "19.0.0",
+    "react-native": "0.79.2",
+    "react-native-builder-bob": "^0.40.12",
+    "react-native-nitro-modules": "^0.26.3",
+    "release-it": "^17.10.0",
+    "turbo": "^1.10.7",
+    "typescript": "^5.8.3"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*",
+    "react-native-nitro-modules": "^0.26.3"
+  },
+  "workspaces": [
+    "example"
+  ],
+  "packageManager": "yarn@3.6.1",
+  "jest": {
+    "preset": "react-native",
+    "modulePathIgnorePatterns": [
+      "<rootDir>/example/node_modules",
+      "<rootDir>/lib/"
+    ]
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore: release ${version}",
+      "tagName": "v${version}"
+    },
+    "npm": {
+      "publish": true
+    },
+    "github": {
+      "release": true
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "preset": {
+          "name": "angular"
+        }
+      }
+    }
+  },
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      [
+        "custom",
+        {
+          "script": "nitrogen",
+          "clean": "nitrogen/"
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json"
+        }
+      ]
+    ]
+  },
+  "create-react-native-library": {
+    "languages": "kotlin-swift",
+    "type": "nitro-module",
+    "version": "0.51.1"
+  }
+}

package/src/AlarmKit.nitro.ts

@@ -0,0 +1,48 @@
+import type { HybridObject } from 'react-native-nitro-modules';
+
+export interface AlarmKit
+  extends HybridObject<{ ios: 'swift'; android: 'kotlin' }> {
+  requestAlarmPermission(): Promise<boolean>;
+  scheduleFixedAlarm(
+    title: string,
+    stopBtn: CustomizableAlarmButton,
+    tintColor: string,
+    secondaryBtn?: CustomizableAlarmButton,
+    timestamp?: number,
+    countdown?: AlarmCountdown
+  ): Promise<string>;
+  scheduleRelativeAlarm(
+    title: string,
+    stopBtn: CustomizableAlarmButton,
+    tintColor: string,
+    hour: number,
+    minute: number,
+    repeats: AlarmWeekday[],
+    secondaryBtn?: CustomizableAlarmButton,
+    countdown?: AlarmCountdown
+  ): Promise<string>;
+  cancelAlarm(id: string): Promise<boolean>;
+  cancelAllAlarms(): Promise<boolean>;
+  getAlarm(id: string): Promise<string | null>;
+  getAllAlarms(): Promise<string[]>;
+}
+
+export interface CustomizableAlarmButton {
+  text: string;
+  textColor: string;
+  icon: string;
+}
+
+export interface AlarmCountdown {
+  preAlert?: number | null;
+  postAlert?: number | null;
+}
+
+export type AlarmWeekday =
+  | 'monday'
+  | 'tuesday'
+  | 'wednesday'
+  | 'thursday'
+  | 'friday'
+  | 'saturday'
+  | 'sunday';

package/src/index.tsx

@@ -0,0 +1,96 @@
+import { NitroModules } from 'react-native-nitro-modules';
+import type {
+  AlarmCountdown,
+  AlarmKit,
+  AlarmWeekday,
+  CustomizableAlarmButton,
+} from './AlarmKit.nitro';
+
+const AlarmKitHybridObject =
+  NitroModules.createHybridObject<AlarmKit>('AlarmKit');
+
+export async function requestAlarmPermission(): Promise<boolean> {
+  return AlarmKitHybridObject.requestAlarmPermission();
+}
+
+export async function scheduleFixedAlarm(
+  title: string,
+  stopBtn: CustomizableAlarmButton,
+  tintColor: string,
+  secondaryBtn?: CustomizableAlarmButton,
+  timestamp?: number,
+  countdown?: AlarmCountdown
+): Promise<string> {
+  if (!timestamp && !countdown)
+    throw new Error(
+      'You need to specify when the alarm will trigger, use countdown for a timer and timestamp for an alarm.'
+    );
+  return AlarmKitHybridObject.scheduleFixedAlarm(
+    title,
+    stopBtn,
+    tintColor,
+    secondaryBtn,
+    timestamp,
+    countdown
+  );
+}
+
+export async function scheduleRelativeAlarm(
+  title: string,
+  stopBtn: CustomizableAlarmButton,
+  tintColor: string,
+  hour: number,
+  minute: number,
+  repeats: AlarmWeekday[],
+  secondaryBtn?: CustomizableAlarmButton,
+  countdown?: AlarmCountdown
+): Promise<string> {
+  return AlarmKitHybridObject.scheduleRelativeAlarm(
+    title,
+    stopBtn,
+    tintColor,
+    hour,
+    minute,
+    repeats,
+    secondaryBtn,
+    countdown
+  );
+}
+
+export async function cancelAlarm(id: string): Promise<boolean> {
+  return AlarmKitHybridObject.cancelAlarm(id);
+}
+
+export async function cancelAllAlarms(): Promise<boolean> {
+  return AlarmKitHybridObject.cancelAllAlarms();
+}
+
+export async function getAlarm(id: string): Promise<string | null> {
+  return AlarmKitHybridObject.getAlarm(id);
+}
+
+export async function getAllAlarms(): Promise<string[]> {
+  return AlarmKitHybridObject.getAllAlarms();
+}
+
+export async function createAlarmButton(
+  text: string,
+  textColor: string,
+  icon: string
+): Promise<CustomizableAlarmButton> {
+  return {
+    text,
+    textColor,
+    icon,
+  };
+}
+
+export async function createAlarmCountdown(
+  preAlert: number | null,
+  postAlert: number | null
+): Promise<AlarmCountdown> {
+  return {
+    preAlert,
+    postAlert,
+  };
+}