capacitor-record360sdk 7.0.0 → 7.0.1

package/README.md

@@ -15,6 +15,7 @@ npx cap sync
 
 * [`launchRecord360(...)`](#launchrecord360)
 * [`launchReferenceCapture(...)`](#launchreferencecapture)
+* [`addListener('Record360Event', ...)`](#addlistenerrecord360event-)
 * [Interfaces](#interfaces)
 * [Type Aliases](#type-aliases)
 
@@ -49,6 +50,22 @@ launchReferenceCapture(options: { referenceNumber: string; workOrderId?: number;
 --------------------
 
 
+### addListener('Record360Event', ...)
+
+```typescript
+addListener(eventName: 'Record360Event', listenerFunc: (data: { type: 'onFailedToAuthenticate' | 'onInspectionCancelled' | 'onInspectionComplete' | 'onInspectionUploadFailed' | 'onInspectionUploadProgress' | 'onInspectionUploaded' | 'onInspectionStarted' | 'onUserAuthenticated'; referenceNumber?: string; bytesComplete?: number; bytesTotal?: number; error?: string; userId?: string; username?: string; }) => void) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                                                                                                                                                                                                                                                                                                                                                                          |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'Record360Event'</code>                                                                                                                                                                                                                                                                                                                                                                 |
+| **`listenerFunc`** | <code>(data: { type: 'onFailedToAuthenticate' \| 'onInspectionCancelled' \| 'onInspectionComplete' \| 'onInspectionUploadFailed' \| 'onInspectionUploadProgress' \| 'onInspectionUploaded' \| 'onInspectionStarted' \| 'onUserAuthenticated'; referenceNumber?: string; bytesComplete?: number; bytesTotal?: number; error?: string; userId?: string; username?: string; }) =&gt; void</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
 ### Interfaces
 
 
@@ -68,6 +85,13 @@ launchReferenceCapture(options: { referenceNumber: string; workOrderId?: number;
 | **`userToken`** | <code>string</code> |
 
 
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
 ### Type Aliases
 
 

package/dist/docs.json

@@ -40,6 +40,29 @@
           "Record360Identity"
         ],
         "slug": "launchreferencecapture"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'Record360Event', listenerFunc: (data: { type: 'onFailedToAuthenticate' | 'onInspectionCancelled' | 'onInspectionComplete' | 'onInspectionUploadFailed' | 'onInspectionUploadProgress' | 'onInspectionUploaded' | 'onInspectionStarted' | 'onUserAuthenticated'; referenceNumber?: string; bytesComplete?: number; bytesTotal?: number; error?: string; userId?: string; username?: string; }) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'Record360Event'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(data: { type: 'onFailedToAuthenticate' | 'onInspectionCancelled' | 'onInspectionComplete' | 'onInspectionUploadFailed' | 'onInspectionUploadProgress' | 'onInspectionUploaded' | 'onInspectionStarted' | 'onUserAuthenticated'; referenceNumber?: string | undefined; bytesComplete?: number | undefined; bytesTotal?: number | undefined; error?: string | undefined; userId?: string | undefined; username?: string | undefined; }) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [],
+        "docs": "",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenerrecord360event-"
       }
     ],
     "properties": []
@@ -90,6 +113,22 @@
           "type": "string"
         }
       ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
     }
   ],
   "enums": [],

package/dist/esm/definitions.d.ts

@@ -1,3 +1,4 @@
+import type { PluginListenerHandle } from "@capacitor/core";
 export declare type Record360Identity = R360PasswordIdentity | R360UserTokenIdentity;
 export interface R360PasswordIdentity {
     username: string;
@@ -15,4 +16,13 @@ export interface CapacitorRecord360SDKPlugin {
         workOrderLabel?: string;
         identity?: Record360Identity;
     }): Promise<void>;
+    addListener(eventName: 'Record360Event', listenerFunc: (data: {
+        type: 'onFailedToAuthenticate' | 'onInspectionCancelled' | 'onInspectionComplete' | 'onInspectionUploadFailed' | 'onInspectionUploadProgress' | 'onInspectionUploaded' | 'onInspectionStarted' | 'onUserAuthenticated';
+        referenceNumber?: string;
+        bytesComplete?: number;
+        bytesTotal?: number;
+        error?: string;
+        userId?: string;
+        username?: string;
+    }) => void): Promise<PluginListenerHandle>;
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export type Record360Identity = R360PasswordIdentity | R360UserTokenIdentity\n\nexport interface R360PasswordIdentity {\n  username: string,\n  password: string\n}\n\nexport interface R360UserTokenIdentity {\n  userId: string,\n  userToken: string\n}\n\nexport interface CapacitorRecord360SDKPlugin {\n  launchRecord360(identity?: Record360Identity): Promise<void>\n\n  launchReferenceCapture(options: {\n    referenceNumber: string,\n    workOrderId?: number,\n    workOrderLabel?: string,\n    identity?: Record360Identity\n  }): Promise<void>\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["import type { PluginListenerHandle } from \"@capacitor/core\"\nexport type Record360Identity = R360PasswordIdentity | R360UserTokenIdentity\n\nexport interface R360PasswordIdentity {\n  username: string,\n  password: string\n}\n\nexport interface R360UserTokenIdentity {\n  userId: string,\n  userToken: string\n}\n\nexport interface CapacitorRecord360SDKPlugin {\n  launchRecord360(identity?: Record360Identity): Promise<void>\n\n  launchReferenceCapture(options: {\n    referenceNumber: string,\n    workOrderId?: number,\n    workOrderLabel?: string,\n    identity?: Record360Identity\n  }): Promise<void>\n\n  addListener(\n    eventName: 'Record360Event',\n    listenerFunc: (\n      data: { \n        type: 'onFailedToAuthenticate' |  'onInspectionCancelled' | 'onInspectionComplete' | 'onInspectionUploadFailed' | 'onInspectionUploadProgress' | 'onInspectionUploaded' | 'onInspectionStarted' | 'onUserAuthenticated',\n        referenceNumber?: string,\n        bytesComplete?: number,\n        bytesTotal?: number,\n        error?: string,\n        userId?: string,\n        username?: string\n      }\n    ) => void,\n  ): Promise<PluginListenerHandle>;\n}\n"]}

package/dist/esm/web.d.ts

@@ -1,4 +1,4 @@
-import { WebPlugin } from '@capacitor/core';
+import { ListenerCallback, PluginListenerHandle, WebPlugin } from '@capacitor/core';
 import type { CapacitorRecord360SDKPlugin, Record360Identity } from './definitions';
 export declare class CapacitorRecord360SDKWeb extends WebPlugin implements CapacitorRecord360SDKPlugin {
     launchRecord360(_?: Record360Identity): Promise<void>;
@@ -8,4 +8,5 @@ export declare class CapacitorRecord360SDKWeb extends WebPlugin implements Capac
         workOrderLabel?: string;
         identity?: Record360Identity;
     }): Promise<void>;
+    addListener(_eventName: string, _listenerFunc: ListenerCallback): Promise<PluginListenerHandle>;
 }

package/dist/esm/web.js

@@ -6,5 +6,8 @@ export class CapacitorRecord360SDKWeb extends WebPlugin {
     launchReferenceCapture(_) {
         throw new Error("Not available on web");
     }
+    addListener(_eventName, _listenerFunc) {
+        throw new Error("Not available on web");
+    }
 }
 //# sourceMappingURL=web.js.map

package/dist/esm/web.js.map

@@ -1 +1 @@
-{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAI5C,MAAM,OAAO,wBAAyB,SAAQ,SAAS;IACrD,eAAe,CAAC,CAAqB;QACnC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;IAED,sBAAsB,CAAC,CAA4G;QAC/H,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC5C,CAAC;CAEF","sourcesContent":["import { WebPlugin } from '@capacitor/core';\n\nimport type { CapacitorRecord360SDKPlugin, Record360Identity } from './definitions';\n\nexport class CapacitorRecord360SDKWeb extends WebPlugin implements CapacitorRecord360SDKPlugin {\n  launchRecord360(_?: Record360Identity): Promise<void> {\n    throw new Error(\"Not available on web.\");\n  }\n\n  launchReferenceCapture(_: { referenceNumber: string; workOrderId?: number; workOrderLabel?: string; identity?: Record360Identity; }): Promise<void> {\n      throw new Error(\"Not available on web\");\n  }\n  \n}"]}
+{"version":3,"file":"web.js","sourceRoot":"","sources":["../../src/web.ts"],"names":[],"mappings":"AAAA,OAAO,EAA0C,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAIpF,MAAM,OAAO,wBAAyB,SAAQ,SAAS;IACrD,eAAe,CAAC,CAAqB;QACnC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;IAC3C,CAAC;IAED,sBAAsB,CAAC,CAA4G;QAC/H,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC5C,CAAC;IAED,WAAW,CAAC,UAAkB,EAAE,aAA+B;QAC3D,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;IAC5C,CAAC;CACF","sourcesContent":["import { ListenerCallback, PluginListenerHandle, WebPlugin } from '@capacitor/core';\n\nimport type { CapacitorRecord360SDKPlugin, Record360Identity } from './definitions';\n\nexport class CapacitorRecord360SDKWeb extends WebPlugin implements CapacitorRecord360SDKPlugin {\n  launchRecord360(_?: Record360Identity): Promise<void> {\n    throw new Error(\"Not available on web.\");\n  }\n\n  launchReferenceCapture(_: { referenceNumber: string; workOrderId?: number; workOrderLabel?: string; identity?: Record360Identity; }): Promise<void> {\n      throw new Error(\"Not available on web\");\n  }\n  \n  addListener(_eventName: string, _listenerFunc: ListenerCallback): Promise<PluginListenerHandle> {\n      throw new Error(\"Not available on web\");\n  }\n}"]}

package/dist/plugin.cjs.js

@@ -13,6 +13,9 @@ class CapacitorRecord360SDKWeb extends core.WebPlugin {
     launchReferenceCapture(_) {
         throw new Error("Not available on web");
     }
+    addListener(_eventName, _listenerFunc) {
+        throw new Error("Not available on web");
+    }
 }
 
 var web = /*#__PURE__*/Object.freeze({

package/dist/plugin.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst CapacitorRecord360SDK = registerPlugin('CapacitorRecord360SDK', {\n    web: () => import('./web').then(m => new m.CapacitorRecord360SDKWeb()),\n});\nexport * from './definitions';\nexport { CapacitorRecord360SDK };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class CapacitorRecord360SDKWeb extends WebPlugin {\n    launchRecord360(_) {\n        throw new Error(\"Not available on web.\");\n    }\n    launchReferenceCapture(_) {\n        throw new Error(\"Not available on web\");\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,qBAAqB,GAAGA,mBAAc,CAAC,uBAAuB,EAAE;AACtE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,wBAAwB,EAAE,CAAC;AAC1E,CAAC;;ACFM,MAAM,wBAAwB,SAASC,cAAS,CAAC;AACxD,IAAI,eAAe,CAAC,CAAC,EAAE;AACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC;AAChD;AACA,IAAI,sBAAsB,CAAC,CAAC,EAAE;AAC9B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC;AAC/C;AACA;;;;;;;;;"}
+{"version":3,"file":"plugin.cjs.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst CapacitorRecord360SDK = registerPlugin('CapacitorRecord360SDK', {\n    web: () => import('./web').then(m => new m.CapacitorRecord360SDKWeb()),\n});\nexport * from './definitions';\nexport { CapacitorRecord360SDK };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class CapacitorRecord360SDKWeb extends WebPlugin {\n    launchRecord360(_) {\n        throw new Error(\"Not available on web.\");\n    }\n    launchReferenceCapture(_) {\n        throw new Error(\"Not available on web\");\n    }\n    addListener(_eventName, _listenerFunc) {\n        throw new Error(\"Not available on web\");\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;;AACK,MAAC,qBAAqB,GAAGA,mBAAc,CAAC,uBAAuB,EAAE;AACtE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,wBAAwB,EAAE,CAAC;AAC1E,CAAC;;ACFM,MAAM,wBAAwB,SAASC,cAAS,CAAC;AACxD,IAAI,eAAe,CAAC,CAAC,EAAE;AACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC;AAChD;AACA,IAAI,sBAAsB,CAAC,CAAC,EAAE;AAC9B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC;AAC/C;AACA,IAAI,WAAW,CAAC,UAAU,EAAE,aAAa,EAAE;AAC3C,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC;AAC/C;AACA;;;;;;;;;"}

package/dist/plugin.js

@@ -12,6 +12,9 @@ var capacitorCapacitorRecord360SDK = (function (exports, core) {
         launchReferenceCapture(_) {
             throw new Error("Not available on web");
         }
+        addListener(_eventName, _listenerFunc) {
+            throw new Error("Not available on web");
+        }
     }
 
     var web = /*#__PURE__*/Object.freeze({

package/dist/plugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst CapacitorRecord360SDK = registerPlugin('CapacitorRecord360SDK', {\n    web: () => import('./web').then(m => new m.CapacitorRecord360SDKWeb()),\n});\nexport * from './definitions';\nexport { CapacitorRecord360SDK };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class CapacitorRecord360SDKWeb extends WebPlugin {\n    launchRecord360(_) {\n        throw new Error(\"Not available on web.\");\n    }\n    launchReferenceCapture(_) {\n        throw new Error(\"Not available on web\");\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,qBAAqB,GAAGA,mBAAc,CAAC,uBAAuB,EAAE;IACtE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,wBAAwB,EAAE,CAAC;IAC1E,CAAC;;ICFM,MAAM,wBAAwB,SAASC,cAAS,CAAC;IACxD,IAAI,eAAe,CAAC,CAAC,EAAE;IACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC;IAChD;IACA,IAAI,sBAAsB,CAAC,CAAC,EAAE;IAC9B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC;IAC/C;IACA;;;;;;;;;;;;;;;"}
+{"version":3,"file":"plugin.js","sources":["esm/index.js","esm/web.js"],"sourcesContent":["import { registerPlugin } from '@capacitor/core';\nconst CapacitorRecord360SDK = registerPlugin('CapacitorRecord360SDK', {\n    web: () => import('./web').then(m => new m.CapacitorRecord360SDKWeb()),\n});\nexport * from './definitions';\nexport { CapacitorRecord360SDK };\n//# sourceMappingURL=index.js.map","import { WebPlugin } from '@capacitor/core';\nexport class CapacitorRecord360SDKWeb extends WebPlugin {\n    launchRecord360(_) {\n        throw new Error(\"Not available on web.\");\n    }\n    launchReferenceCapture(_) {\n        throw new Error(\"Not available on web\");\n    }\n    addListener(_eventName, _listenerFunc) {\n        throw new Error(\"Not available on web\");\n    }\n}\n//# sourceMappingURL=web.js.map"],"names":["registerPlugin","WebPlugin"],"mappings":";;;AACK,UAAC,qBAAqB,GAAGA,mBAAc,CAAC,uBAAuB,EAAE;IACtE,IAAI,GAAG,EAAE,MAAM,mDAAe,CAAC,IAAI,CAAC,CAAC,IAAI,IAAI,CAAC,CAAC,wBAAwB,EAAE,CAAC;IAC1E,CAAC;;ICFM,MAAM,wBAAwB,SAASC,cAAS,CAAC;IACxD,IAAI,eAAe,CAAC,CAAC,EAAE;IACvB,QAAQ,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC;IAChD;IACA,IAAI,sBAAsB,CAAC,CAAC,EAAE;IAC9B,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC;IAC/C;IACA,IAAI,WAAW,CAAC,UAAU,EAAE,aAAa,EAAE;IAC3C,QAAQ,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC;IAC/C;IACA;;;;;;;;;;;;;;;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "capacitor-record360sdk",
-  "version": "7.0.0",
+  "version": "7.0.1",
   "description": "Capacitor wrapper for Record360SDK",
   "main": "dist/plugin.cjs.js",
   "module": "dist/esm/index.js",
@@ -63,7 +63,7 @@
     "typescript": "~4.1.5"
   },
   "peerDependencies": {
-    "@capacitor/core": "^6.0.0"
+    "@capacitor/core": "^7.0.0"
   },
   "prettier": "@ionic/prettier-config",
   "swiftlint": "@ionic/swiftlint-config",