@doordeck/headless-react-native-sdk 0.83.0

package/package.json

@@ -0,0 +1,203 @@
+{
+  "name": "@doordeck/headless-react-native-sdk",
+  "version": "0.83.0",
+  "description": "Doordeck React Native headless SDK",
+  "source": "./src/index.tsx",
+  "main": "./lib/commonjs/index.js",
+  "module": "./lib/module/index.js",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/typescript/module/src/index.d.ts",
+        "default": "./lib/module/index.js"
+      },
+      "require": {
+        "types": "./lib/typescript/commonjs/src/index.d.ts",
+        "default": "./lib/commonjs/index.js"
+      }
+    }
+  },
+  "files": [
+    "src",
+    "lib",
+    "android",
+    "ios",
+    "cpp",
+    "*.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 @doordeck/headless-react-native-sdk-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",
+    "release": "release-it"
+  },
+  "keywords": [
+    "react-native",
+    "ios",
+    "android"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/doordeck/doordeck-headless-sdk.git"
+  },
+  "author": "Doordeck <developers@doordeck.com> (https://doordeck.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/doordeck/doordeck-headless-sdk/issues"
+  },
+  "homepage": "https://github.com/doordeck/doordeck-headless-sdk#readme",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/"
+  },
+  "devDependencies": {
+    "@commitlint/config-conventional": "^17.0.2",
+    "@evilmartians/lefthook": "^1.5.0",
+    "@react-native-community/cli": "15.0.1",
+    "@react-native/eslint-config": "^0.73.1",
+    "@release-it/conventional-changelog": "^9.0.2",
+    "@types/jest": "^29.5.5",
+    "@types/react": "^18.2.44",
+    "commitlint": "^17.0.2",
+    "del-cli": "^5.1.0",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-prettier": "^5.0.1",
+    "jest": "^29.7.0",
+    "prettier": "^3.0.3",
+    "react": "18.3.1",
+    "react-native": "0.77.1",
+    "react-native-builder-bob": "^0.37.0",
+    "release-it": "^17.10.0",
+    "turbo": "^1.10.7",
+    "typescript": "^5.2.2"
+  },
+  "resolutions": {
+    "@types/react": "^18.2.44"
+  },
+  "peerDependencies": {
+    "react": "*",
+    "react-native": "*"
+  },
+  "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": "angular"
+      }
+    }
+  },
+  "eslintConfig": {
+    "root": true,
+    "extends": [
+      "@react-native",
+      "prettier"
+    ],
+    "rules": {
+      "react/react-in-jsx-scope": "off",
+      "prettier/prettier": [
+        "error",
+        {
+          "quoteProps": "consistent",
+          "singleQuote": true,
+          "tabWidth": 2,
+          "trailingComma": "es5",
+          "useTabs": false
+        }
+      ]
+    }
+  },
+  "eslintIgnore": [
+    "node_modules/",
+    "lib/"
+  ],
+  "prettier": {
+    "quoteProps": "consistent",
+    "singleQuote": true,
+    "tabWidth": 2,
+    "trailingComma": "es5",
+    "useTabs": false
+  },
+  "react-native-builder-bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "codegen",
+      [
+        "commonjs",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "module",
+        {
+          "esm": true
+        }
+      ],
+      [
+        "typescript",
+        {
+          "project": "tsconfig.build.json",
+          "esm": true
+        }
+      ]
+    ]
+  },
+  "codegenConfig": {
+    "name": "RNHeadlessReactNativeSdkSpec",
+    "type": "modules",
+    "jsSrcsDir": "src",
+    "outputDir": {
+      "ios": "ios/generated",
+      "android": "android/generated"
+    },
+    "android": {
+      "javaPackageName": "com.doordeck.headlessreactnativesdk"
+    },
+    "includesGeneratedCode": true
+  },
+  "create-react-native-library": {
+    "type": "turbo-module",
+    "languages": "kotlin-objc",
+    "version": "0.48.1"
+  }
+}

package/react-native.config.js

@@ -0,0 +1,12 @@
+/**
+ * @type {import('@react-native-community/cli-types').UserDependencyConfig}
+ */
+module.exports = {
+  dependency: {
+    platforms: {
+      android: {
+        cmakeListsPath: 'generated/jni/CMakeLists.txt',
+      },
+    },
+  },
+};

package/src/NativeHeadlessReactNativeSdk.ts

@@ -0,0 +1,87 @@
+import type {TurboModule} from 'react-native';
+import {TurboModuleRegistry} from 'react-native';
+
+export interface Spec extends TurboModule {
+  /**
+   * @param email       - email of the user
+   * @param password    - password of the user
+   *
+   * @returns needsVerification [Promise] of [boolean] being this boolean whether the user needs to verify and
+   *                            an email was sent.
+   *                            Be aware that two consecutive logins with `needVerification == true` in less
+   *                            than one minute will result into a `NEEDS_VERIFICATION_ERROR` as there is a
+   *                            60-second throttle for this operation
+   */
+  login(
+    email: string,
+    password: string,
+  ): Promise<AssistedRegisterEphemeralKeyResponse>;
+
+  /**
+   * @param authToken   - token for this user
+   *
+   * @returns needsVerification [Promise] of [boolean] being this boolean whether the user needs to verify and
+   *                            an email was sent.
+   *                            Be aware that two consecutive logins with `needVerification == true` in less
+   *                            than one minute will result into a `NEEDS_VERIFICATION_ERROR` as there is a
+   *                            60-second throttle for this operation
+   */
+  setAuthToken(
+    authToken: string,
+  ): Promise<AssistedRegisterEphemeralKeyResponse>;
+
+  /**
+   * @returns UserDetailsResponse if the user is logged in, otherwise null
+   *
+   * This method is useful to check if the user needs to verify 2fa login,
+   * or if the certificate chain or the token are about to expire.
+   */
+  getUserDetails(): Promise<UserDetailsResponse>;
+
+  /**
+   * @param code  - code sent for verification
+   */
+  verify(code: string): Promise<void>
+
+  /**
+   * Logs out the user inside the SDK.
+   * This doesn't delete any local data generated by the React Native SDK.
+   *
+   * @return a Promise when it's done.
+   */
+  logout(): Promise<void>
+
+  /**
+   * @param tileId - tile UUID usually scanned from a QR code or obtained from an NFC tag
+   *
+   * @returns TileLocksResponse where locks belonging to that tile can be found
+   */
+  getLocksBelongingToTile(tileId: string): Promise<TileLocksResponse>;
+
+  /**
+   * @param lockId - lock UUID associated to a tile
+   */
+  unlockDevice(lockId: string): Promise<void>;
+}
+
+export type TileLocksResponse = {
+  siteId: string;
+  tileId: string;
+  deviceIds: string[];
+};
+
+export type AssistedRegisterEphemeralKeyResponse = {
+  requiresVerification: boolean;
+}
+
+export type UserDetailsResponse = {
+  userId?: string;
+  publicKey: string;
+  email: string;
+  displayName?: string;
+  emailVerified: boolean;
+  certificateChainAboutToExpire: boolean;
+  tokenAboutToExpire: boolean;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('HeadlessReactNativeSdk');

package/src/index.tsx

@@ -0,0 +1,35 @@
+import HeadlessReactNativeSdk, {
+  type AssistedRegisterEphemeralKeyResponse,
+  type TileLocksResponse, type UserDetailsResponse,
+} from './NativeHeadlessReactNativeSdk';
+
+export function login(email: string, password: string): Promise<AssistedRegisterEphemeralKeyResponse> {
+  return HeadlessReactNativeSdk.login(
+    email,
+    password,
+  );
+}
+
+export function setAuthToken(authToken: string): Promise<AssistedRegisterEphemeralKeyResponse> {
+  return HeadlessReactNativeSdk.setAuthToken(authToken);
+}
+
+export function getUserDetails(): Promise<UserDetailsResponse> {
+  return HeadlessReactNativeSdk.getUserDetails();
+}
+
+export function verify(code: string): Promise<void> {
+  return HeadlessReactNativeSdk.verify(code);
+}
+
+export function logout(): Promise<void> {
+  return HeadlessReactNativeSdk.logout();
+}
+
+export function getLocksBelongingToTile(tileId: string): Promise<TileLocksResponse> {
+  return HeadlessReactNativeSdk.getLocksBelongingToTile(tileId);
+}
+
+export function unlockDevice(lockId: string): Promise<void> {
+  return HeadlessReactNativeSdk.unlockDevice(lockId);
+}