qcobjects-cli 2.4.51 → 2.4.53

package/VERSION

@@ -1 +1 @@
-2.4.51
+2.4.53

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qcobjects-cli",
-  "version": "2.4.51",
+  "version": "2.4.53",
   "description": "qcobjects cli command line tool",
   "main": "src/index.cjs",
   "module": "src/index.mjs",
@@ -24,9 +24,7 @@
   "dependencies": {
     "commander": "^10.0.1",
     "mime": "^2.4.7",
-    "qcobjects": "^2.4.87",
-    "yaml": "^2.2.2",
-    "qcobjects-sdk": "^2.4.53"
+    "yaml": "^2.2.2"
   },
   "devDependencies": {
     "@types/qcobjects": "github:QCObjects/-types-qcobjects",
@@ -44,13 +42,13 @@
     "eslint-plugin-n": "^15.7.0",
     "eslint-plugin-promise": "^6.1.1",
     "jasmine": "^3.99.0",
-    "qcobjects": "^2.4.87",
-    "qcobjects-sdk": "^2.4.53",
+    "qcobjects": "^2.4.92",
+    "qcobjects-sdk": "^2.4.60",
     "qcobjects-tsconfig": "^2.4.10"
   },
   "peerDependencies": {
-    "qcobjects": "^2.4.87",
-    "qcobjects-sdk": "^2.4.53"
+    "qcobjects": "^2.4.92",
+    "qcobjects-sdk": "^2.4.60"
   },
   "repository": {
     "type": "file",

package/spec/testsSpec.js

@@ -6,8 +6,8 @@ describe("QCObjects Integrity", function () {
   const package_config = require(absolutePath+"/../package.json");
 
   it("Verifying the version of CLI Tool", function () {
-    console.log("Verifying the version of QCObjects is required and same for dependencies and peerDependencies...");
-    expect(package_config.dependencies.qcobjects).toEqual(package_config.peerDependencies.qcobjects);
+    console.log("Verifying the version of QCObjects is required and same for devDependencies and peerDependencies...");
+    expect(package_config.devDependencies.qcobjects).toEqual(package_config.peerDependencies.qcobjects);
     console.log("Verifying the version of CLI Tool... OK");
   });
 

package/src/org.quickcorp.qcobjects.cli.js

@@ -62,10 +62,11 @@ Package("org.quickcorp.qcobjects.cli",[
   class SwitchCommander extends InheritClass {
 
     choiceOption = {
-      generateSw(_appName){
+      generateSw(_appName, options){
+        let dirPrefix = options.dir;
         let switchCommander = this;
         let appName = (typeof _appName ==="undefined" || _appName === true)?("MyAppName"):(_appName);
-        switchCommander.generateServiceWorker(appName);
+        switchCommander.generateServiceWorker(appName, dirPrefix);
 
       },
       create(_appName, options){
@@ -282,46 +283,70 @@ Package("org.quickcorp.qcobjects.cli",[
       });
     }
 
-    generateServiceWorker(appName){
+    generateServiceWorker(appName, dirPrefix = "./"){
+      const writeContent = (component) => {
+        const parsedText = component.parseTemplate(component.template);
+        logger.debug("Starting to write the sw file...");
+        fs.writeFile(`${dirPrefix}/sw.js`, parsedText , (err) => {
+          if (err){
+            throw Error (err);
+          }
+          logger.info("Service Worker Generated");
+          console.log("");
+          console.log("Now simply put:");
+          console.log("CONFIG.set('serviceWorkerURI','/sw.js');");
+          console.log(" In your init.js file ");
+          console.log("");
+          console.log("To start your app in a local server ");
+          console.log("Execute the command: ");
+          console.log("> qcobjects launch <appname>");
+          console.log("");
+        });
+
+      };
+
+
+      class ServiceWorkerComponent extends Component {
+        cached = false;
+        templateURI= "sw.js";
+        basePath = templatePwaPath;
+        name ="sw";
+        tplsource= "default";
+        template = "";
+
+        done ({request, component}){
+          super.done({request, component});
+          writeContent(this);
+        }
+      }
+
       return new Promise( (resolve, reject) => {
-        var filelist = ["/"].concat(this.fileListRecursive("./"));
+        var filelist = ["/"].concat(this.fileListRecursive(`${dirPrefix}`));
+        if (typeof dirPrefix !== "undefined" && dirPrefix !== "./" && dirPrefix !== "."){
+          filelist = filelist.map(f=>f.replace(new RegExp(`${dirPrefix}/`), ""));
+        }
         filelist = filelist.filter(function (fl){return fl !== "sw.js" && (!fl.startsWith("node_modules/")); });
         filelist = filelist.filter(fname => !fname.endsWith(".pem"));
         filelist = filelist.filter(fname => !fname.endsWith(".sh"));
         filelist = filelist.filter(fname => !(new RegExp("^package(.*).json$")).test(fname));
         filelist = filelist.filter(fname => !fname.startsWith("."));
         var fileListString = "\n\t\""+filelist.join("\",\n\t\"")+"\"";
-        var component = New(Component, {
-          templateURI: "sw.js",
-          basePath:templatePwaPath,
-          name:"sw",
-          cached:false,
-          tplsource: "default",
-          data: {
-            appName: appName,
-            appVersion: "1.0.0",
-            filelist: fileListString
-          },
-          done ({request, component}) {
-            return new Promise ((resolve, reject)=> {
-              fs.writeFile("./sw.js", component.parsedAssignmentText, err => {
-                logger.info("Service Worker Generated");
-                console.log("");
-                console.log("Now simply put:");
-                console.log("CONFIG.set('serviceWorkerURI','/sw.js');");
-                console.log(" In your init.js file ");
-                console.log("");
-                console.log("To start your app in a local server ");
-                console.log("Execute the command: ");
-                console.log("> qcobjects launch <appname>");
-                console.log("");
-              });
-              resolve({request, component});  
+        let component;
+
+        new Promise ((resolve, reject)=> {
+            component = new ServiceWorkerComponent({
+              name: "sw",
+              data: {
+                appName: appName,
+                appVersion: "1.0.0",
+                filelist: fileListString
+              }
             });
-          }
+            setTimeout(()=> {
+              component.done({request:null, component});
+            }, 1000);
         });
-  
-      } );
+      });
     }
 
     copyTemplate(source, dest){
@@ -443,8 +468,9 @@ Package("org.quickcorp.qcobjects.cli",[
           .action(function(args, options){
               switchCommander.choiceOption.upgradeToEnterprise.call(switchCommander,args,options);
           });
-        switchCommander.program.command("generate-sw  <appname>")
-          .description("Generates the service worker  <appname>")
+        switchCommander.program.command("generate-sw <appname>")
+          .option("-d, --dir <dirPrefix> ", "creates the service worker in a specific dir <dirPrefix>")
+          .description("Generates the service worker <appname>")
           .action(function(args, options){
               switchCommander.choiceOption.generateSw.call(switchCommander,args,options);
           });

package/src/templates/pwa/sw.js

@@ -1,6 +1,6 @@
 /**
- * QCObjects SDK 1.0
- * ________________
+ * QCObjects Framework
+ * ____________________________________
  *
  * Author: Jean Machuca <correojean@gmail.com>
  *
@@ -23,31 +23,90 @@
  * license document, but changing it is not allowed.
 */
 "use strict";
+// eslint-disable-next-line no-undef
+
+/* eslint-disable no-undef */
+// This is the service worker with the combined offline experience (Offline page + Offline copy of pages)
+
+const CACHE = "{{appName}}-offline-page";
+
+importScripts("https://storage.googleapis.com/workbox-cdn/releases/5.1.2/workbox-sw.js");
+
+const offlineFallbackPage = "index-fallback.html";
+
+self.addEventListener("message", (event) => {
+  if (event.data && event.data.type === "SKIP_WAITING") {
+    self.skipWaiting();
+  }
+});
+
+self.addEventListener("install", async (event) => {
+  event.waitUntil(
+    caches.open(CACHE)
+      .then((cache) => cache.add(offlineFallbackPage))
+  );
+});
+
+if (workbox.navigationPreload.isSupported()) {
+  workbox.navigationPreload.enable();
+}
+
+workbox.routing.registerRoute(
+  // eslint-disable-next-line prefer-regex-literals
+  new RegExp("/*"),
+  new workbox.strategies.StaleWhileRevalidate({
+    cacheName: CACHE
+  })
+);
+
+self.addEventListener("fetch", (event) => {
+  if (event.request.mode === "navigate") {
+    event.respondWith((async () => {
+      try {
+        const preloadResp = await event.preloadResponse;
+
+        if (preloadResp) {
+          return preloadResp;
+        }
+
+        const networkResp = await fetch(event.request);
+        return networkResp;
+      } catch (error) {
+
+        const cache = await caches.open(CACHE);
+        const cachedResp = await cache.match(offlineFallbackPage);
+        return cachedResp;
+      }
+    })());
+  }
+});
+
+
 const version = "{{appVersion}}";
 const appName = "{{appName}}";
 const cacheSufix = (Math.round(Date.now()/(1000*3600))).toString(); // 1 hour
 const cacheName = `qcobjects-app-${appName}-${version}-${cacheSufix}`;
-const start_url = "/?homescreen=1";
+const startUrl = "/?homescreen=1";
 caches.delete(cacheName); // force to reload cache for the first time the sw is loaded
-self.addEventListener('install', e => {
+self.addEventListener("install", e => {
   e.waitUntil(
     caches.open(cacheName).then(cache => {
-      return cache.addAll([`${start_url}`,{{filelist}}])
-          .then(() => self.skipWaiting());
+      return cache.addAll([`${startUrl}`,{{filelist}}])
+        .then(() => self.skipWaiting());
     })
   );
 });
 
-self.addEventListener('activate', event => {
+self.addEventListener("activate", event => {
   event.waitUntil(self.clients.claim());
 });
 
-self.addEventListener('fetch', event => {
+self.addEventListener("fetch", event => {
   event.respondWith(
     caches.open(cacheName)
-      .then(cache => cache.match(event.request, {ignoreSearch: true}))
+      .then(cache => cache.match(event.request, { ignoreSearch: true }))
       .then(response => {
-      return response || fetch(event.request);
-    })
+        return response || fetch(event.request);
+      })
   );
 });