Merge pull request #1 from cobuildlab/feature/main/first-version-hook

React Native Auth0 hook

Author: kikeztw

.eslintrc.js

@@ -0,0 +1,27 @@
+module.exports = {
+  parser: '@typescript-eslint/parser', // Specifies the ESLint parser
+  plugins: ['jsdoc', '@typescript-eslint'],
+  extends: [
+    'eslint:recommended',
+    'prettier',
+    'plugin:jsdoc/recommended',
+    'plugin:react-hooks/recommended',
+    'plugin:@typescript-eslint/recommended',
+  ],
+  ignorePatterns: ['lib/**/*.js.', 'lib/*.js'],
+  env: {
+    node: true,
+    es6: true,
+  },
+  parserOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module',
+  },
+  rules: {
+    indent: ['error', 2],
+    semi: [2, 'always'],
+    'no-console': ['error', { allow: ['warn', 'error', 'log'] }],
+    'jsdoc/require-description-complete-sentence': 1,
+    'jsdoc/require-hyphen-before-param-description': 1,
+  },
+};

.github/workflows/build.yml

@@ -0,0 +1,15 @@
+name: Build Node.js Package
+
+on: pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+      - run: npm ci
+      # - run: npm run test
+      - run: npm run build

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,50 @@
+name: "Code scanning - action"
+
+on:
+  pull_request:
+  schedule:
+    - cron: '0 15 * * 4'
+
+jobs:
+  CodeQL-Build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+      with:
+        # We must fetch at least the immediate parents so that if this is
+        # a pull request then we can checkout the head.
+        fetch-depth: 2
+
+    # If this run was triggered by a pull request event, then checkout
+    # the head of the pull request instead of the merge commit.
+    - run: git checkout HEAD^2
+      if: ${{ github.event_name == 'pull_request' }}
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      # Override language selection by uncommenting this and choosing your languages
+      # with:
+      #   languages: go, javascript, csharp, python, cpp, java
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/npmpublish.yml

@@ -0,0 +1,22 @@
+name: Publish Package
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish-npm:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.npm_token}}
+

.gitignore

@@ -0,0 +1,7 @@
+.idea/
+
+node_modules/
+.c9
+.DS_Store
+coverage/
+lib/

.npmignore

@@ -0,0 +1,4 @@
+src
+tsconfig.json
+tslint.json
+.prettierrc

.prettierrc

@@ -0,0 +1,12 @@
+{
+  "printWidth": 80,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "jsxSingleQuote": false,
+  "bracketSpacing": true,
+  "jsxBracketSameLine": true,
+  "arrowParens": "always",
+  "trailingComma": "all"
+}

README.md

@@ -1 +1,60 @@
-# TODO 
+# TODO 
+  
+  - Documentation
+  - Refresh Token
+  - Auth0 Params
+  - Clean Code
+
+
+Basic use: 
+
+```tsx
+import React from 'react';
+import { View, Button, Text } from 'react-native';
+import { useAuth, AuthProviderConfig, AuthProvider } from '@cobuildlab/react-native-auth0';
+import { Credentials } from 'react-native-auth0';
+import AsyncStorage from '@react-native-async-storage/async-storage';
+
+import { auth0 } from './src/shared/auth0/client';
+
+const App: React.FC = () => {
+  const { login, logout, isLoading, isAuthenticated } = useAuth();
+  console.log('---- isAuthenticated --- ', isAuthenticated);
+  console.log('---- isLoading --- ', isLoading);
+
+  return (
+    <View>
+      <Text>{isAuthenticated ? 'Im On' : 'Im Off'}</Text>
+      <Button onPress={login} title="login" />
+      <Button onPress={logout} title="logout" />
+    </View>
+  );
+};
+
+const Conifg: AuthProviderConfig = {
+  auth0,
+  eichBaseToken: '8base-token',
+  eichBaseAuthProfileId: 'my-profile-id',
+  eichBaseEndpoint: '8base-environemnt-branch',
+  removeCredentials: async () => {
+    await AsyncStorage.removeItem('credentials_store');
+  },
+  saveCredentials: async (credentials) => {
+    const value = JSON.stringify(credentials);
+    await AsyncStorage.setItem('credentials_store', value);
+  },
+  getCredentials: async (): Promise<Credentials | null> => {
+    const value = await AsyncStorage.getItem('credentials_store');
+    return value != null ? JSON.parse(value) : null;
+  },
+};
+
+export const App = () => {
+  return (
+    <AuthProvider config={Conifg}>
+      <App />
+    </AuthProvider>
+  );
+};
+```
+

babel.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  presets: [
+    [
+      '@babel/preset-env',
+      {
+        targets: {
+          node: 'current',
+        },
+      },
+    ],
+    '@babel/preset-react',
+    '@babel/preset-typescript',
+  ],
+};

jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  roots: ['<rootDir>/src'],
+  transform: {
+    '^.+\\.ts?$': 'ts-jest',
+  },
+  testRegex: '(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$',
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+};