codenotch-react 1.0.12 → 1.0.13

package/index.d.ts

@@ -1,27 +1,14 @@
-export interface ICodenotch {
-    ENV: ICodenotchAppProps,
+export interface ICodenotchApi {
+    ENV: ICodenotchEnv,
 
     requestSioql: (sioql: string) => Promise<any>;
-
-    startProcess: (processName: string) => Promise<IProcessResult>;
-
-    onSignal: (signalId: string, callback: (data: any) => void) => IDisposable;
-
-}
-
-interface IDisposable {
-    dispose(): void;
-}
-
-interface IProcessResult {
-    success: boolean;
 }
 
-export function useCodenotch(): ICodenotch;
+export function useCodenotch(): ICodenotchApi;
 
-export function useCodenotchApp(props: ICodenotchAppProps): ICodenotch;
+export function useCodenotchApp(props: ICodenotchEnv): ICodenotchApi;
 
-export interface ICodenotchAppProps {
+export interface ICodenotchEnv {
     clusterUrl?: string;
     serviceName?: string;
     tenantName?: string;
@@ -29,4 +16,6 @@ export interface ICodenotchAppProps {
     baseUrl?: string;
 }
 
-export type CodenotchApp<T> = React.FC<(ICodenotchAppProps & T)>;
+export type CodenotchFC<T> = React.FC<(ICodenotchEnv & T)>;
+
+export type CodenotchComponent<T> = React.ComponentType<(ICodenotchEnv & T)>;

package/index.js

@@ -2,6 +2,10 @@ const CODENOTCH_ENV = {
 
 };
 
+/**
+ * Return Codenotch API
+ * @returns {Object} Codenotch API
+ */
 function useCodenotch() {
     return {
         ENV: CODENOTCH_ENV,
@@ -65,37 +69,40 @@ function useCodenotch() {
     };
 }
 
-
+/**
+ * Setup Codenotch environment and return Codenotch API
+ * @param {*} props Codenotch app properties
+ * @returns {Object} Codenotch API
+ */
 function useCodenotchApp(props) {
     if (props) {
-        if (props.clusterUrl) {
-            CODENOTCH_ENV.clusterUrl = props.clusterUrl;
-        }
-
-        if (props.serviceName) {
-            CODENOTCH_ENV.serviceName = props.serviceName;
-        }
+        if (props.clusterUrl) CODENOTCH_ENV.clusterUrl = props.clusterUrl;
+        if (props.serviceName) CODENOTCH_ENV.serviceName = props.serviceName;
+        if (props.tenantName) CODENOTCH_ENV.tenantName = props.tenantName;
+        if (props.accessToken) CODENOTCH_ENV.accessToken = props.accessToken;
+
+        // Inject URL parameters as props if they are not already defined
+        const params = new URL(window.location.href).searchParams;
+        params.forEach((value, key) => {
+            if(props[key] === undefined){
+                props[key] = value;
+            }
+        });
+    }
 
-        if (props.tenantName) {
-            CODENOTCH_ENV.tenantName = props.tenantName;
-        }
+    return useCodenotch();
+}
 
-        if (props.accessToken) {
-            CODENOTCH_ENV.accessToken = props.accessToken;
-        }
+class CodenotchApp extends React.Component {
+    constructor(props) {
+        super(props);
+        this.codenotch = useCodenotchApp(props);
     }
-    else {
-        console.warn("useCodenotchApp: No Codenotch configuration provided.");
-    }
-
-    const params = new URL(window.location.href).searchParams;
-    params.forEach((value, key) => {
-        if(props[key] === undefined){
-            props[key] = value;
-        }
-    });
 
-    return useCodenotch();
+    render() {
+        return this.props.children(this.codenotch);
+    }
 }
 
-module.exports = { useCodenotch, useCodenotchApp };
+
+module.exports = { useCodenotch, useCodenotchApp, CODENOTCH_ENV, CodenotchApp };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "codenotch-react",
-    "version": "1.0.12",
+    "version": "1.0.13",
     "main": "index.js",
     "types": "index.d.ts",
     "type": "module",