Merge pull request #3 from cursorinsight/denes/workflows

chore: Add GitHub workflows

.eslintignore

@@ -1,2 +1,3 @@
 build
 dist
+example

.github/workflows/release.yaml

@@ -0,0 +1,29 @@
+name: Publish Package to npmjs
+
+permissions:
+  contents: write
+  id-token: write
+
+on:
+  push:
+    tags:
+      - '?.?.?'
+
+env:
+  NODE_VERSION: 18
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/test.yaml

@@ -0,0 +1,54 @@
+name: test
+permissions:
+  contents: read
+on:
+  push:
+    branches: [main]
+  pull_request:
+# Spend CI time only on latest ref
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+env:
+  NODE_VERSION: 18
+  JAVA_VERSION: 17
+
+jobs:
+  verify:
+    name: Verify
+    runs-on: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: Set up Java ${{ env.JAVA_VERSION }}
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'zulu'
+          java-version: ${{ env.JAVA_VERSION }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Build iOS
+        run: npm run verify:ios
+      - name: Build Android
+        run: npm run verify:android
+      - name: Build Web
+        run: npm run verify:web
+  lint:
+    name: Lint
+    runs-on: macos-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Set up Node.js ${{ env.NODE_VERSION }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ env.NODE_VERSION }}
+      - name: Install dependencies
+        run: npm ci
+      - name: Run Lint script
+        run: npm run lint

.prettierignore

@@ -1,2 +1,3 @@
 build
 dist
+example

src/config.ts

@@ -4,9 +4,9 @@ import type { TrapConfigurationType } from './definitions';
 import { CollectorTypes } from './definitions';
 
 const reporterConfig = {
-  apiKeyName: "graboxy-api-key",
+  apiKeyName: 'graboxy-api-key',
 
-  apiKeyValue: "api-key-value",
+  apiKeyValue: 'api-key-value',
 
   cachedTransport: true,
 
@@ -18,7 +18,7 @@ const reporterConfig = {
 
   maxFileCacheSize: 5_000_000,
 
-  url: "https://trap.graboxy.com/api/1/submit/{sessionId}/{streamId}",
+  url: 'https://trap.graboxy.com/api/1/submit/{sessionId}/{streamId}',
 
   readTimeout: 500,
 
@@ -105,11 +105,10 @@ const reducedCollector = {
 
   metadataSubmissionInterval: 60_000,
 
-  useGestureRecognizer: true
+  useGestureRecognizer: true,
 };
 
-export class TrapConfig implements TrapConfigurationType
-{
+export class TrapConfig implements TrapConfigurationType {
   defaultDataCollection = defaultCollector;
 
   lowBatteryDataCollection = reducedCollector;

src/definitions.ts

@@ -7,14 +7,15 @@ export interface CapacitorTrapPlugin {
   /**
    * Add custom metadata
    */
-  addCustomMetadata(options: { key: string, value: any }): Promise<void>;
+  addCustomMetadata(options: { key: string; value: any }): Promise<void>;
 
   /**
    * Checks permission for the specific collector. Returns true if the collector
    * has the required permission.
    */
-  checkPermission(options: { collector: CollectorTypes })
-    : Promise<PermissionResult>;
+  checkPermission(options: {
+    collector: CollectorTypes;
+  }): Promise<PermissionResult>;
 
   /**
    * Initialize the plugin
@@ -34,7 +35,7 @@ export interface CapacitorTrapPlugin {
   /**
    * Request permission for the specific collector.
    */
-  requestPermission(options: { collector: CollectorTypes }) : Promise<void>;
+  requestPermission(options: { collector: CollectorTypes }): Promise<void>;
 
   /**
    * Start data collection

src/index.ts

@@ -8,4 +8,4 @@ const CapacitorTrap = registerPlugin<CapacitorTrapPlugin>('CapacitorTrap', {
 
 export * from './definitions';
 export { TrapConfig } from './config';
-export { CapacitorTrap };
+export { CapacitorTrap };

src/web.ts

@@ -1,6 +1,11 @@
 import { WebPlugin } from '@capacitor/core';
 
-import type { CapacitorTrapPlugin, CollectorTypes, PermissionResult, TrapConfigurationType } from './definitions';
+import type {
+  CapacitorTrapPlugin,
+  CollectorTypes,
+  PermissionResult,
+  TrapConfigurationType,
+} from './definitions';
 
 export class CapacitorTrapWeb extends WebPlugin implements CapacitorTrapPlugin {
   // eslint-disable-next-line
@@ -9,13 +14,14 @@ export class CapacitorTrapWeb extends WebPlugin implements CapacitorTrapPlugin {
   }
 
   // eslint-disable-next-line
-  addCustomMetadata(options : {key: string, value: any }): Promise<void> {
+  addCustomMetadata(options: { key: string; value: any }): Promise<void> {
     throw new Error('Method not implemented.');
   }
 
   // eslint-disable-next-line
-  checkPermission(options: { collector: CollectorTypes; })
-    : Promise<PermissionResult> {
+  checkPermission(options: {
+    collector: CollectorTypes;
+  }): Promise<PermissionResult> {
     throw new Error('Method not implemented.');
   }
 
@@ -24,17 +30,17 @@ export class CapacitorTrapWeb extends WebPlugin implements CapacitorTrapPlugin {
   }
 
   // eslint-disable-next-line
-  configure(options: { config: TrapConfigurationType } ): Promise<void> {
+  configure(options: { config: TrapConfigurationType }): Promise<void> {
     throw new Error('Method not implemented.');
   }
 
   // eslint-disable-next-line
-  removeCustomMetadata(options : { key: string }): Promise<void> {
+  removeCustomMetadata(options: { key: string }): Promise<void> {
     throw new Error('Method not implemented.');
   }
 
   // eslint-disable-next-line
-  requestPermission(options: { collector: CollectorTypes; }) : Promise<void> {
+  requestPermission(options: { collector: CollectorTypes }): Promise<void> {
     throw new Error('Method not implemented.');
   }