@progressive-development/pd-spa-helper 0.1.91 → 0.1.93

package/src/PdSpaHelper.ts

@@ -1,8 +1,3 @@
-import { FirebaseApp, FirebaseOptions, initializeApp } from 'firebase/app';
-// TODO: Add SDKs for Firebase products that you want to use
-// https://firebase.google.com/docs/web/setup#available-libraries
-
-
 import { html, LitElement, css, CSSResultGroup, TemplateResult } from 'lit';
 import { router, navigator } from 'lit-element-router';
 import { property } from 'lit/decorators.js';
@@ -10,25 +5,22 @@ import { property } from 'lit/decorators.js';
 import '@progressive-development/pd-page/pd-menu.js';
 import '@progressive-development/pd-page/pd-footer.js';
 
-import { initApplicationServices } from './InitApplicationData.js';
-
-// Refactor: move function definitions to general place (no firebase specific imports here)
-import { FunctionDefinition, FunctionResult, FunctionsConfig } from './service-provider/firebase/functions-client.js';
-
 import { ServiceCallController } from './service-call-controller2.js';
 import { initializeStore } from './store/mini-rx.store.js';
 
+import { authStateChangedImpl, initAppImpl, isAuthenticatedImpl, setServiceProvider } from './service-provider/service-provider-impl.js';
+import { AppConfiguration, Footer, FunctionResult, MenuElement, NavigationConfig, NavigationPage } from './service-provider/service-provider-model.js';
+
 import './router/AppMain.js';
 import './defaultpage/default-login.js';
 import './tmpown/pd-panel-viewer.js';
 import './tmpown/pd-panel.js';
+// eslint-disable-next-line import/no-duplicates
+import './tmpown/pd-toast.js';
 
 // TODO: How to solve this import problem?
 // eslint-disable-next-line import/no-duplicates
 import { PdToast } from './tmpown/pd-toast.js';
-// eslint-disable-next-line import/no-duplicates
-import './tmpown/pd-toast.js';
-import { authStateChangedImpl, isAuthenticatedImpl, setServiceProvider } from './service-provider/service-provider-impl.js';
 
 
 // Footer Text
@@ -39,74 +31,12 @@ const MADE_BY = {
 // Visible time for time-limited toast
 const TOAST_DURATION = 6000;
 
-/**
- * Data models.
- */
-
-export interface MenuElement {
-  key: string,
-  name: string,
-  sec?: string,
-  route?: string,
-  action?: Function,
-  topItem?: boolean,
-  ref?: any,
-  icon?: string,
-}
-
-export interface NavigationPage {
-  name: string,
-  mainClass?: string,
-  pattern: Array<string>,  
-  auth: boolean,
-  menu?: Array<MenuElement>,
-  topMenu?: Array<MenuElement>,
-  withTeaser?: boolean,
-  withFooter?: boolean
-  hideMenu?: boolean
-}
-
-export type ServiceProviderFirebase = "firebase";
-export type ServiceProviderMock = "mock";
-export type ServiceProviderConfiguration = ServiceProviderFirebase | ServiceProviderMock;
-
-export interface NavigationConfig {
-  pages: Array<NavigationPage>,
-  includeLogin: boolean
-}
-
-export interface LinkObj {
-  name: string,
-  key: string,
-  link?: string,
-  action?: Function
-}
-
-export interface Footer {
-  version: string,
-  links: Array<LinkObj>
-}
-
-export interface StoreConfig {
-  appName: string,
-  reducer: any,
-  effects: Array<any>
-}
-
-export interface AppConfiguration {  
-  serviceProvider?: ServiceProviderConfiguration,
-  navigationConfigParam: NavigationConfig;
-  storeConfigParam?: StoreConfig;
-  firebaseConfig?: FirebaseOptions;
-  functionsConfig?: FunctionsConfig;
-}
 
 /**
  * Transformed routes, generated during startInit.
  */
 let transformedRoutes:Array<any>;
 let navigationConfig:NavigationConfig;
-let postLoginFunc:FunctionDefinition | undefined;
 
 /**
  * Internal helper functions to generate route elemets for lit-router. 
@@ -162,15 +92,8 @@ export const startInit = (config: AppConfiguration) => {
     initializeStore(config.storeConfigParam);
   }
 
-  // init firebase app
-  if (config.firebaseConfig) {
-    const app:FirebaseApp = initializeApp(config.firebaseConfig);
-    if (config.functionsConfig) {
-      // init application services (functions, store)    
-      initApplicationServices(app, config.functionsConfig);
-      postLoginFunc = config.functionsConfig.postLoginFunc;
-    }
-  }
+  // init app
+  initAppImpl(config);
 
   if (config.navigationConfigParam.includeLogin) {
     config.navigationConfigParam.pages.push({

package/src/index.ts

@@ -1,15 +1,10 @@
 export {  
-  PdSpaHelper,    
-  AppConfiguration,
-  startInit,  
-  NavigationConfig,
-  StoreConfig,
-  NavigationPage,
-  MenuElement,
-  LinkObj,
-  Footer
+  PdSpaHelper,      
+  startInit,              
 } from './PdSpaHelper.js';
 
+export * as pdSpaModel from './service-provider/service-provider-model.js'
+
 export {isBlank, isEmpty} from './helper/helper-utils.js';
 
 export {DefaultViewPage} from './defaultpage/default-view-page.js';
@@ -28,14 +23,6 @@ export {DefaultStepAddress} from './defaultpage/default-step-address.js';
 
 export {DefaultStepSummary, OrderStep} from './defaultpage/default-step-summary.js';
 
-export {
-  FunctionDefinition,
-  FunctionResult,
-  FunctionParam,
-  FunctionsConfig,
-  callFunction
-} from './service-provider/firebase/functions-client.js'
-
 export {
   getDB,
 } from './service-provider/firebase/firestore-client.js'
@@ -43,7 +30,8 @@ export {
 export {
   loginImpl,
   logoutImpl,
-  isAuthenticatedImpl
+  isAuthenticatedImpl,
+  callFunctionImpl
 } from './service-provider/service-provider-impl.js'
 
 export { pdStore } from './store/mini-rx.store.js';

package/src/service-call-controller2.ts

@@ -1,7 +1,8 @@
 import {ReactiveControllerHost} from 'lit';
 import {initialState, Task} from '@lit-labs/task';
 
-import { FunctionDefinition, FunctionResult, initController } from './service-provider/firebase/functions-client.js';
+import { FunctionDefinition, FunctionResult } from './service-provider/service-provider-model.js';
+import { initController } from './service-provider/service-provider-impl.js';
 
 export interface ServiceControllerInput {
   promise: Promise<FunctionResult>,

package/src/service-provider/firebase/functions-client.ts

@@ -1,38 +1,8 @@
 import { FirebaseApp } from "firebase/app";
 import { getFunctions, HttpsCallable, httpsCallable } from "firebase/functions";
-import { TemplateResult } from "lit";
-import { ServiceCallController } from "../../service-call-controller2.js";
-
-export interface FunctionDefinition {
-  name: string,
-  successCodes: Array<Number>,    
-  // Fade window during function call (true) or show only background infos (false).
-  fadeWindow: boolean,
-  successTxt: TemplateResult,
-  pendingTxt: TemplateResult,
-  param?: any,
-  redirect?: string,
-  logoutOnFail?: boolean
-}
-
-export interface FunctionParam {
-  func: FunctionDefinition,
-  inputData: any,
-}
-
-export interface FunctionResult {
-  resultData: unknown,
-  statusCode: number,
-}
-
-export interface FunctionsConfig {
-  region: string, // 'europe-west3'
-  functions: Array<FunctionDefinition>,
-  postLoginFunc?: FunctionDefinition,
-}
+import { FunctionDefinition, FunctionResult, FunctionsConfig } from "../service-provider-model.js";
 
 const functionMap = new Map<FunctionDefinition, HttpsCallable>;
-let controller: ServiceCallController;
 
 /**
  * During start/load application, initialize functions.  
@@ -54,10 +24,6 @@ export const initFunctions = (app: FirebaseApp, functionsConfig: FunctionsConfig
   }
 }
 
-export const initController = (controllerParam: ServiceCallController) => {
-  controller = controllerParam
-}
-
 const internalCallFunction = async (def: FunctionDefinition, functionInput: any): Promise<FunctionResult> => {
   const funcRef = functionMap.get(def);    
   if (funcRef) {    
@@ -97,10 +63,6 @@ const internalCallFunction = async (def: FunctionDefinition, functionInput: any)
   throw new Error("Illegal state, no data with right state available");
 }
 
-export const callFunction = async (def: FunctionDefinition, functionInput: any): Promise<FunctionResult> => {
-  const promise = internalCallFunction(def, functionInput);
-  if (controller) {
-    controller.callDataPromise = {func: def, promise};
-  }
-  return promise;
-}
+export const callFunction = async (def: FunctionDefinition, functionInput: any): Promise<FunctionResult> => 
+  internalCallFunction(def, functionInput);  
+  

package/src/service-provider/mock/auth.ts

@@ -38,7 +38,7 @@ export const isAuthenticatedMock = (): boolean => {
 } 
 
 
-export const authStateChangedMock = (callback: Function) => {
+export const authStateChangedMock = () => {
   console.log("Not implemented for MOCK");
 }
 

package/src/service-provider/mock/function-client.ts

@@ -0,0 +1,9 @@
+import { FunctionDefinition, FunctionResult } from "../service-provider-model.js";
+
+export const callFunctionMock = (def: FunctionDefinition, functionInput: any): Promise<FunctionResult> => {
+  console.log("Mock function call", def, functionInput);
+  if (def.mockResult) {
+    return Promise.resolve(def.mockResult);
+  }
+  throw new Error("No data with right state available");
+}

package/src/service-provider/service-provider-impl.ts

@@ -1,27 +1,92 @@
-import { ServiceProviderConfiguration } from "../PdSpaHelper.js";
+import { FirebaseApp, initializeApp } from "firebase/app";
 
 import { authStateChanged, isAuthenticated, login, logout } from "./firebase/auth.js";
 import { authStateChangedMock, isAuthenticatedMock, loginMock, logoutMock } from "./mock/auth.js";
-
+import { AppConfiguration, FunctionDefinition, FunctionResult, FunctionsConfig, ServiceProviderConfiguration } from "./service-provider-model.js";
+import { callFunction, initFunctions } from "./firebase/functions-client.js";
+import { initFirestore } from "./firebase/firestore-client.js";
+import { callFunctionMock } from "./mock/function-client.js";
+import { ServiceCallController } from "../service-call-controller2.js";
 
 let provider: ServiceProviderConfiguration | undefined;
-
+let controller: ServiceCallController;
 
 const throwUndefinedProviderError = () => {
   throw new Error("Undefined service provider, please check configuration. 'firebase' or 'mock' allowed here.");
 }
 
+/* #####################
+ * Init Implementation
+ * ##################### */
+
 export const setServiceProvider = (providerParam?: ServiceProviderConfiguration) => {
   provider = providerParam;
 }
 
+export const initController = (controllerParam: ServiceCallController) => {
+  controller = controllerParam
+}
+
+const initFirebaseApplicationServices = (firebaseApp: FirebaseApp, functionsConfig: FunctionsConfig) => {
+  // do something with the app, init db, firestore and functions    
+  initFunctions(firebaseApp, functionsConfig);
+  initFirestore(firebaseApp);
+}
+
+export const initAppImpl = (config: AppConfiguration) => {
+
+  if (provider === "firebase" && config.firebaseConfig) {
+    const app:FirebaseApp = initializeApp(config.firebaseConfig);
+    if (config.functionsConfig) {
+      // init application services (functions, store)    
+      initFirebaseApplicationServices(app, config.functionsConfig);
+    }
+  } else if (provider === "mock") {
+    // no init needed
+  } else {
+    throwUndefinedProviderError();
+  }
+}
+
+/* #####################
+ * Functions Implementation
+ * ##################### */
+export const callFunctionImpl = async (def: FunctionDefinition, functionInput: any): Promise<FunctionResult> => {
+  
+  const callController = (promise: Promise<any>) => {
+    if (controller) {
+      controller.callDataPromise = {func: def, promise};
+    }
+  }
+  
+  if (provider === "firebase") {
+    const promise = callFunction(def, functionInput)
+    callController(promise);
+    return promise;
+  } 
+  if (provider === "mock") {
+    const promise = callFunctionMock(def, functionInput)
+    callController(promise);
+    return promise;
+  }
+
+  return throwUndefinedProviderError();  
+}
+
+
+
+/* #####################
+ * Auth Implementation
+ * ##################### */
+
+
 export const authStateChangedImpl = (
   callback: Function
 ) => {
   if (provider === "firebase") {
     authStateChanged(callback);
   } else if (provider === "mock") {
-    authStateChangedMock(callback);
+    authStateChangedMock();
   } else {
     throwUndefinedProviderError();
   }

package/src/service-provider/service-provider-model.ts

@@ -0,0 +1,106 @@
+import { FirebaseOptions } from "firebase/app";
+import { TemplateResult } from "lit";
+
+
+/**
+ * Implemeted service provider
+ */
+export type ServiceProviderFirebase = "firebase";
+export type ServiceProviderMock = "mock";
+export type ServiceProviderConfiguration = ServiceProviderFirebase | ServiceProviderMock;
+
+
+export interface FunctionResult {
+  resultData: unknown,
+  statusCode: number,
+}
+
+/**
+ * Function model.
+ */
+
+export interface FunctionDefinition {
+  name: string,
+  successCodes: Array<Number>,    
+  // Fade window during function call (true) or show only background infos (false).
+  fadeWindow: boolean,
+  successTxt: string | TemplateResult,
+  pendingTxt: string | TemplateResult,
+  param?: any,
+  redirect?: string,
+  logoutOnFail?: boolean,
+  mockResult?: FunctionResult
+}
+
+export interface FunctionParam {
+  func: FunctionDefinition,
+  inputData: any,
+}
+
+export interface FunctionsConfig {
+  region: string, // 'europe-west3'
+  functions: Array<FunctionDefinition>,
+  postLoginFunc?: FunctionDefinition,
+}
+
+
+/**
+ * App data models.
+ */
+
+export interface MenuElement {
+  key: string,
+  name: string,
+  sec?: string,
+  route?: string,
+  action?: Function,
+  topItem?: boolean,
+  ref?: any,
+  icon?: string,
+}
+
+export interface NavigationPage {
+  name: string,
+  mainClass?: string,
+  pattern: Array<string>,  
+  auth: boolean,
+  menu?: Array<MenuElement>,
+  topMenu?: Array<MenuElement>,
+  withTeaser?: boolean,
+  withFooter?: boolean
+  hideMenu?: boolean
+}
+
+export interface NavigationConfig {
+  pages: Array<NavigationPage>,
+  includeLogin: boolean
+}
+
+export interface LinkObj {
+  name: string,
+  key: string,
+  link?: string,
+  action?: Function
+}
+
+export interface Footer {
+  version: string,
+  links: Array<LinkObj>
+}
+
+
+export interface StoreConfig {
+  appName: string,
+  reducer: any,
+  effects: Array<any>
+}
+
+export interface AppConfiguration {  
+  serviceProvider?: ServiceProviderConfiguration,
+  navigationConfigParam: NavigationConfig;
+  storeConfigParam?: StoreConfig;
+  firebaseConfig?: FirebaseOptions;
+  functionsConfig?: FunctionsConfig;
+}
+
+

package/src/store/mini-rx.store.ts

@@ -1,6 +1,6 @@
 import { configureStore, Store, LoggerExtension, ReduxDevtoolsExtension } from 'mini-rx-store';
 
-import { StoreConfig } from '../PdSpaHelper.js';
+import { StoreConfig } from '../service-provider/service-provider-model.js';
 
 
 let store: Store;

package/src/InitApplicationData.ts

@@ -1,9 +0,0 @@
-import { FirebaseApp } from "firebase/app";
-import { initFirestore } from "./service-provider/firebase/firestore-client.js";
-import { FunctionsConfig, initFunctions } from "./service-provider/firebase/functions-client.js";
-
-export const initApplicationServices = (firebaseApp: FirebaseApp, functionsConfig: FunctionsConfig) => {
-    // do something with the app, init db, firestore and functions    
-    initFunctions(firebaseApp, functionsConfig);
-    initFirestore(firebaseApp);
-}