@icanbwell/types 0.40.2 → 0.41.0

package/frontend-telemetry.js

@@ -0,0 +1,39 @@
+/**
+ * Error Codes should be used in combination with the BwellError
+ * They categorize known error conditions and provide a mechanism for customized error handling.
+ */
+var ErrorCode;
+(function (ErrorCode) {
+  // Initialization Errors
+  /** Client or client key is unknown */
+  ErrorCode["CLIENT_UNKNOWN"] = "CLIENT_UNKNOWN";
+  /** Insufficient feature services defined by embeddable  */
+  ErrorCode["INSUFFICIENT_SERVICES"] = "INSUFFICIENT_SERVICES";
+  /** Method called before initialization */
+  ErrorCode["METHOD_CALLED_BEFORE_INITIALIZATION"] = "METHOD_CALLED_BEFORE_INITIALIZATION";
+  /** General initialization failure of Bwell object */
+  ErrorCode["BWELL_INITIALIZATION"] = "BWELL_INITIALIZATION";
+  /** Error durring token exchange */
+  ErrorCode["TOKEN_EXCHANGE"] = "TOKEN_EXCHANGE";
+  // Routing Errors
+  /** Defines an error while executing a route */
+  ErrorCode["ROUTE_ACTION"] = "ROUTE_ACTION";
+  /** Defines an error while initializing the navigation service delegate */
+  ErrorCode["ROUTE_NAVIGATION_DELEGATE"] = "ROUTE_NAVIGATION_DELEGATE";
+  /** Specifies the the route is unknown */
+  ErrorCode["ROUTE_UNKNOWN"] = "ROUTE_UNKNOWN";
+  /** An elementId in the route definition does not have a matching element in the registry */
+  ErrorCode["ROUTE_ELEMENT_UNKNOWN"] = "ROUTE_ELEMENT_UNKNOWN";
+  // React Errors
+  /** Hook or Consumer used outside of a React Provider */
+  ErrorCode["PROVIDER_UNDEFINED"] = "PROVIDER_UNDEFINED";
+  // Miscelaneous Errors
+  /** Configuration Error */
+  ErrorCode["CONFIGURATION_ERROR"] = "CONFIGURATION_ERROR";
+  /** Network Error */
+  ErrorCode["NETWORK"] = "NETWORK";
+  /** Unknown error */
+  ErrorCode["UNKNOWN"] = "UNKNOWN";
+})(ErrorCode || (ErrorCode = {}));
+
+export { ErrorCode };

package/index.js

@@ -1 +1 @@
-
+export { ErrorCode } from './frontend-telemetry.js';

package/native-bridge.js

@@ -0,0 +1 @@
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@icanbwell/types",
-  "version": "0.40.2",
+  "version": "0.41.0",
   "typedoc": {
     "entryPoint": "./src/index.ts",
     "tsconfig": "./tsconfig.lib.json"
@@ -12,6 +12,9 @@
       ],
       "native-bridge": [
         "src/native-bridge.d.ts"
+      ],
+      "frontend-telemetry": [
+        "src/frontend-telemetry.d.ts"
       ]
     }
   },
@@ -24,11 +27,17 @@
       "types": "./src/native-bridge.d.ts",
       "import": "./native-bridge.js"
     },
+    "./frontend-telemetry": {
+      "types": "./src/frontend-telemetry.d.ts",
+      "import": "./frontend-telemetry.js"
+    },
     ".": {
       "types": "./src/index.d.ts",
       "import": "./index.js"
     }
   },
+  "repoVersion": "1.27.0",
+  "description": "@icanbwell/types. repo version: 1.27.0",
   "module": "./index.js",
   "main": "./index.js",
   "type": "module",

package/src/frontend-telemetry.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Error Codes should be used in combination with the BwellError
+ * They categorize known error conditions and provide a mechanism for customized error handling.
+ */
+export declare enum ErrorCode {
+    /** Client or client key is unknown */
+    CLIENT_UNKNOWN = "CLIENT_UNKNOWN",
+    /** Insufficient feature services defined by embeddable  */
+    INSUFFICIENT_SERVICES = "INSUFFICIENT_SERVICES",
+    /** Method called before initialization */
+    METHOD_CALLED_BEFORE_INITIALIZATION = "METHOD_CALLED_BEFORE_INITIALIZATION",
+    /** General initialization failure of Bwell object */
+    BWELL_INITIALIZATION = "BWELL_INITIALIZATION",
+    /** Error durring token exchange */
+    TOKEN_EXCHANGE = "TOKEN_EXCHANGE",
+    /** Defines an error while executing a route */
+    ROUTE_ACTION = "ROUTE_ACTION",
+    /** Defines an error while initializing the navigation service delegate */
+    ROUTE_NAVIGATION_DELEGATE = "ROUTE_NAVIGATION_DELEGATE",
+    /** Specifies the the route is unknown */
+    ROUTE_UNKNOWN = "ROUTE_UNKNOWN",
+    /** An elementId in the route definition does not have a matching element in the registry */
+    ROUTE_ELEMENT_UNKNOWN = "ROUTE_ELEMENT_UNKNOWN",
+    /** Hook or Consumer used outside of a React Provider */
+    PROVIDER_UNDEFINED = "PROVIDER_UNDEFINED",
+    /** Configuration Error */
+    CONFIGURATION_ERROR = "CONFIGURATION_ERROR",
+    /** Network Error */
+    NETWORK = "NETWORK",
+    /** Unknown error */
+    UNKNOWN = "UNKNOWN"
+}
+export type ErrorDetails = {
+    message: string;
+    errorCode: ErrorCode;
+};
+export type ErrorContext = {
+    errorDetails: ErrorDetails;
+    resetError: () => void;
+};

package/src/index.d.ts

@@ -1 +1,2 @@
 export * from './lib';
+export * from './frontend-telemetry';

package/src/native-bridge.d.ts

@@ -38,12 +38,23 @@ export interface ICamera {
     requestPermission(): Promise<PermissionStatus>;
     checkPermission(): Promise<PermissionStatus>;
 }
+export type PrintOptions = {
+    html: string;
+    filePath?: never;
+} & {
+    html?: never;
+    filePath: string;
+};
+export interface IPrint {
+    print(options: PrintOptions): Promise<boolean>;
+}
 export interface INativeBridge {
     webview: IWebview;
     biometrics: IBiometrics;
     events: IEvents;
     storage: IStorage;
     camera: ICamera;
+    print: IPrint;
     reloadView(): void;
 }
 export type PluginKeys = Exclude<keyof INativeBridge, 'webview'>;