@corva/create-app 0.11.0-0 → 0.12.0-2

package/scripts/ui/zipAppSource.js

@@ -1,105 +1,95 @@
-const fs = require("fs");
-const path = require("path");
-const archiver = require("archiver");
-const os = require("os");
-const chalk = require("chalk");
-const semverInc = require("semver/functions/inc");
+const fs = require('fs');
+const path = require('path');
+const archiver = require('archiver');
+const os = require('os');
+const chalk = require('chalk');
+const semverInc = require('semver/functions/inc');
 
 const { warnIfOutdated } = require('../utils/version');
 
-
-async function compressAppToZip() {
+async function compressAppToZip(useYarn) {
   warnIfOutdated();
 
   const dirname = process.cwd();
 
   // Left only build script for package json;
-  const packageJsonContent = fs.readFileSync(
-    path.resolve(dirname, "package.json"),
-    "utf-8"
-  );
+  const packageJsonContent = fs.readFileSync(path.resolve(dirname, 'package.json'), 'utf-8');
 
   const packageJson = JSON.parse(packageJsonContent);
 
-  const updatedVersion = semverInc(packageJson.version, "patch");
+  const updatedVersion = semverInc(packageJson.version, 'patch');
 
   const updatedPackage = {
     ...packageJson,
     version: updatedVersion,
     scripts: {
-      build: "webpack --config=./config-overrides.js --mode production"
-    }
+      build: 'webpack --config=./config-overrides.js --mode production',
+    },
   };
 
+  const zipPath = path.resolve(path.resolve(dirname, `${packageJson.name}-${updatedVersion}.zip`));
 
-  const zipPath = path.resolve(
-    path.resolve(dirname, `${packageJson.name}-${updatedVersion}.zip`)
-  );
-
-  var archive = archiver.create("zip", {});
+  var archive = archiver.create('zip', {});
   var output = fs.createWriteStream(zipPath);
 
   // pipe archive data to the file
   archive.pipe(output);
 
-  output.on("close", function() {
-    console.log(archive.pointer() + " total bytes");
+  output.on('close', function () {
+    console.log(archive.pointer() + ' total bytes');
 
-    console.log(
-      "archiver has been finalized and the output file descriptor has closed."
-    );
+    console.log('archiver has been finalized and the output file descriptor has closed.');
 
     // clean up temp package.json file
     try {
-      fs.unlinkSync(path.resolve(dirname, "packageForSource.json"));
+      fs.unlinkSync(path.resolve(dirname, 'packageForSource.json'));
       // deleteFolderRecursive(path.resolve(dirname, 'src'));
     } catch (err) {
       console.error(err);
     }
   });
 
-  output.on("end", function() {
-    console.log("Data has been drained");
+  output.on('end', function () {
+    console.log('Data has been drained');
   });
 
-  archive.on("warning", function(err) {
-    if (err.code === "ENOENT") {
+  archive.on('warning', function (err) {
+    if (err.code === 'ENOENT') {
       console.log(err.message);
     } else {
       throw err;
     }
   });
 
-  archive.on("error", function(err) {
+  archive.on('error', function (err) {
     throw err;
   });
 
   fs.writeFileSync(
-    path.resolve(dirname, "package.json"),
-    JSON.stringify({ ...packageJson, version: updatedVersion }, null, 2) +
-      os.EOL
+    path.resolve(dirname, 'package.json'),
+    JSON.stringify({ ...packageJson, version: updatedVersion }, null, 2) + os.EOL
   );
 
   console.log(
     chalk(`
-    NOTE: Version of you app was updated to ${updatedVersion} (package.json), please don't lower it.
+    NOTE: Version of your app was updated to ${updatedVersion} (package.json), please don't lower it.
   `)
   );
 
   fs.writeFileSync(
-    path.resolve(dirname, "packageForSource.json"),
+    path.resolve(dirname, 'packageForSource.json'),
     JSON.stringify(updatedPackage, null, 2) + os.EOL
   );
 
-  archive.file(path.resolve(dirname, "packageForSource.json"), {
-    name: "package.json"
+  archive.file(path.resolve(dirname, 'packageForSource.json'), {
+    name: 'package.json',
   });
 
-  ["manifest.json", "config-overrides.js", "yarn.lock"].forEach(name =>
-    archive.file(path.resolve(dirname, name), { name })
+  ['manifest.json', 'config-overrides.js', useYarn ? 'yarn.lock' : 'package-lock.json'].forEach(
+    (name) => archive.file(path.resolve(dirname, name), { name })
   );
 
-  archive.directory(path.resolve(dirname, "src"), "src");
+  archive.directory(path.resolve(dirname, 'src'), 'src');
 
   archive.finalize();
 }

package/scripts/utils/version.js

@@ -1,14 +1,13 @@
-const NpmApi = require("npm-api");
-const chalk = require("chalk");
-const semverGt = require("semver/functions/gt");
+const NpmApi = require('npm-api');
+const chalk = require('chalk');
+const semverGt = require('semver/functions/gt');
 
-const packageJson = require("../../package.json");
+const packageJson = require('../../package.json');
 const npm = new NpmApi();
 const errorStyle = chalk.bold.red;
 
 const getCurrentVersion = () => packageJson.version;
-const getLatestVersion = async () =>
-  npm.repo("@corva/create-app").prop("version");
+const getLatestVersion = async () => npm.repo('@corva/create-app').prop('version');
 
 // NOTE: Stop process and show error if version is outdated
 async function ensureLatestVersion() {
@@ -17,11 +16,7 @@ async function ensureLatestVersion() {
 
   const isCurrentVersionOutdated = semverGt(latestVersion, currentVersion);
   if (isCurrentVersionOutdated) {
-    console.log(
-      errorStyle(
-        "****************************************************************"
-      )
-    );
+    console.log(errorStyle('****************************************************************'));
     console.log(chalk`
       Your version of the @corva/create-app is outdated.
       There is a new version available ({green.bold ${latestVersion}}).
@@ -30,11 +25,7 @@ async function ensureLatestVersion() {
           npm i -g @corva/create-app@latest
 
     `);
-    console.log(
-      errorStyle(
-        "****************************************************************"
-      )
-    );
+    console.log(errorStyle('****************************************************************'));
     process.exit(0);
   }
 }
@@ -47,9 +38,7 @@ async function warnIfOutdated() {
   const isCurrentVersionOutdated = semverGt(latestVersion, currentVersion);
 
   if (isCurrentVersionOutdated) {
-    console.log(
-      "****************************************************************"
-    );
+    console.log('****************************************************************');
     console.log(chalk`
       There is a new version available ({green.bold ${latestVersion}}).
       You can update the CLI version with the following command:
@@ -57,9 +46,7 @@ async function warnIfOutdated() {
           npm i -g @corva/create-app@latest
 
     `);
-    console.log(
-      "****************************************************************"
-    );
+    console.log('****************************************************************');
   }
 }
 

package/template/scheduler/node/__test__/processor.test.js

@@ -1,19 +1,19 @@
 const Processor = require('../src/processor');
-const loggerFactory = require('@corva/node-logger');
 
 test('process event', async () => {
-    const logger = loggerFactory();
+  const fakeLogger = console;
+  const fakeApiClient = {};
 
-    const event = {
-        company: 1,
-        asset_id: 1234,
-        schedule: 206977482,
-        interval: 300,
-        schedule_start: 157829100000,
-        schedule_end: 157829400000,
-    };
+  const event = {
+    company: 1,
+    asset_id: 1234,
+    schedule: 206977482,
+    interval: 300,
+    schedule_start: 157829100000,
+    schedule_end: 157829400000,
+  };
 
-    const processor = new Processor({ logger });
+  const processor = new Processor({ logger: fakeLogger, apiClient: fakeApiClient });
 
-    await processor.process({ event });
+  await processor.process({ event });
 });

package/template/scheduler/node/gitignore

@@ -0,0 +1,21 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+
+# testing
+/coverage
+
+# misc
+.env
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+*.zip

package/template/scheduler/node/index.js

@@ -6,11 +6,10 @@ const Processor = require('./src/processor');
  * @param {import('@corva/node-sdk').HandlerContext} context
  */
 exports.handler = new Corva().scheduled(async (event, context) => {
+  const processor = new Processor({
+    apiClient: context.api,
+    logger: context.logger,
+  });
 
-    const processor = new Processor({
-        apiClient: context.api,
-        logger: context.logger,
-    });
-
-    await processor.process({ event });
+  await processor.process({ event });
 });

package/template/scheduler/node/package.json

@@ -4,14 +4,14 @@
     "description": "My Dev Center Polling Scheduler Data App",
     "main": "index.js",
     "scripts": {
-        "bundle": "zip -r $npm_package_name-$npm_package_version.zip package.json package-lock.json manifest.json index.js src",
+        "bundle": "zip -r $npm_package_name-$npm_package_version.zip package.json $LOCKFILE manifest.json index.js src",
         "test": "npm audit --production && npm run unit",
         "unit": "jest"
     },
     "dependencies": {
-        "@corva/node-sdk": "^1.5.5"
+        "@corva/node-sdk": "^5.3.1"
     },
     "devDependencies": {
-        "jest": "^26.6.3"
+        "jest": "^27.2.0"
     }
 }

package/template/scheduler/node/src/processor.js

@@ -1,20 +1,16 @@
 class Processor {
-    constructor({ apiClient, logger }) {
-        this.apiClient = apiClient;
-        this.logger = logger;
-    }
+  constructor({ apiClient, logger }) {
+    this.apiClient = apiClient;
+    this.logger = logger;
+  }
 
-    async process({ event }) {
-        this.logger.debug({ event }, 'Event');
+  async process({ event }) {
+    this.logger.debug({ event }, 'Event');
 
-        const {
-            asset_id: assetId,
-            schedule_start: scheduleStart,
-            interval,
-        } = event;
+    const { asset_id: assetId, schedule_start: scheduleStart, interval } = event;
 
-        this.logger.info(`Processing event. Asset: ${assetId}. Schedule start: ${scheduleStart}`);
-    }
+    this.logger.info(`Processing event. Asset: ${assetId}. Schedule start: ${scheduleStart}`);
+  }
 }
 
 module.exports = Processor;

package/template/scheduler/node-ts/README.md

@@ -0,0 +1,25 @@
+# Dev Center Node.js TypeScript Polling Scheduler Data App
+
+## Getting started
+
+### 1. Install Dependencies
+
+```
+npm install
+```
+
+### 2. Run Tests
+
+```
+npm test
+```
+
+### 3. Build
+
+```
+npm run build
+```
+
+### 4. Deploy
+
+Run `npm run bundle` to create a zip package that can be uploaded to Dev Center

package/template/scheduler/node-ts/__test__/processor.spec.ts

@@ -0,0 +1,20 @@
+import { Processor } from '../lib/processor';
+import type { HandlerContext, ScheduledLambdaEvent } from '@corva/node-sdk';
+
+test('process event', async () => {
+  const fakeLogger = console as unknown as HandlerContext['logger'];
+  const fakeApiClient = {} as unknown as HandlerContext['api'];
+
+  const event = {
+    company: 1,
+    asset_id: 1234,
+    schedule: 206977482,
+    interval: 300,
+    schedule_start: 157829100000,
+    schedule_end: 157829400000,
+  } as unknown as ScheduledLambdaEvent<any>;
+
+  const processor = new Processor(fakeApiClient, fakeLogger);
+
+  await processor.process(event);
+});

package/template/scheduler/node-ts/gitignore

@@ -0,0 +1,25 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+
+# testing
+/coverage
+
+# misc
+.env
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+**/*.js
+**/*.js.map
+**/.d.ts
+
+*.zip

package/template/scheduler/node-ts/index.ts

@@ -0,0 +1,8 @@
+import { Corva } from '@corva/node-sdk';
+import { Processor } from './lib/processor';
+
+export const handler = new Corva().scheduled<{ some: string }, void>(async (event, context) => {
+  const processor = new Processor(context.api, context.logger);
+
+  await processor.process(event);
+});

package/template/scheduler/node-ts/lib/processor.ts

@@ -0,0 +1,13 @@
+import type { HandlerContext, ScheduledLambdaEvent } from '@corva/node-sdk';
+
+export class Processor {
+  constructor(private apiClient: HandlerContext['api'], private logger: HandlerContext['logger']) {}
+
+  async process(event: ScheduledLambdaEvent<{ some: string }>) {
+    this.logger.debug({ event }, 'Event');
+
+    const { asset_id: assetId, schedule_start: scheduleStart, interval } = event;
+
+    this.logger.info(`Processing event. Asset: ${assetId}. Schedule start: ${scheduleStart}`);
+  }
+}

package/template/scheduler/node-ts/package.json

@@ -0,0 +1,37 @@
+{
+    "name": "my-dev-center-polling-scheduler-app",
+    "version": "0.0.1",
+    "description": "My Dev Center Polling Scheduler Data App",
+    "main": "index.js",
+    "scripts": {
+        "bundle": "zip -r $npm_package_name-$npm_package_version.zip package.json $LOCKFILE manifest.json index.js lib -x '*.ts'",
+        "test": "npm audit --production && npm run unit",
+        "build": "tsc -p tsconfig.build.json",
+        "unit": "jest"
+    },
+    "jest": {
+        "moduleFileExtensions": [
+            "js",
+            "json",
+            "ts"
+        ],
+        "rootDir": ".",
+        "testEnvironment": "node",
+        "testMatch": [
+            "**/*.spec.ts"
+        ],
+        "transform": {
+            "^.+\\.ts$": "ts-jest"
+        },
+        "verbose": true
+    },
+    "dependencies": {
+        "@corva/node-sdk": "^5.3.1"
+    },
+    "devDependencies": {
+        "@types/jest": "^27.0.1",
+        "jest": "^27.2.1",
+        "ts-jest": "^27.0.5",
+        "typescript": "^4.4.3"
+    }
+}

package/template/scheduler/node-ts/tsconfig.build.json

@@ -0,0 +1,11 @@
+{
+    "extends": "./tsconfig.json",
+    "include": [
+        "lib/**/*.ts",
+        "index.ts"
+    ],
+    "exclude": [
+        "node_modules",
+        "**/*.spec.ts"
+    ]
+}

package/template/scheduler/node-ts/tsconfig.json

@@ -0,0 +1,33 @@
+{
+    "include": [
+        "lib/**/*.ts",
+        "__tests__"
+    ],
+    "exclude": [
+        "node_modules"
+    ],
+    "compilerOptions": {
+        "target": "es2019",
+        "skipLibCheck": false,
+        "baseUrl": "./",
+        "moduleResolution": "node",
+        "esModuleInterop": true,
+        "resolveJsonModule": true,
+        "checkJs": false,
+        "module": "commonjs",
+        "alwaysStrict": true,
+        "noImplicitAny": true,
+        "allowSyntheticDefaultImports": true,
+        "declaration": false,
+        "sourceMap": true,
+        "types": [
+            "jest"
+        ],
+        "typeRoots": [
+            "./node_modules/@types",
+        ]
+    },
+    "typeAcquisition": {
+        "enable": true
+    }
+}

package/template/stream/node/README.md

@@ -16,4 +16,4 @@ npm test
 
 ### 3. Deploy
 
-Run `npm run bundle` to create a zip package that can be uploaded to Dev Center
+Run `npm run bundle` to create a zip package that can be uploaded to Dev Center

package/template/stream/node/__test__/processor.test.js

@@ -1,49 +1,46 @@
 jest.mock('@corva/node-api-client');
 
-const loggerFactory = require('@corva/node-logger');
-const { ApiClient } = require('@corva/node-api-client');
 const Processor = require('../src/processor');
 
 test('process event', async () => {
-    const apiClient = new ApiClient();
-    const logger = loggerFactory();
+  const fakeLogger = console;
+  const fakeApiClient = {};
 
-    const processor = new Processor({
-        apiClient,
-        logger,
-    });
+  const processor = new Processor({
+    apiClient: fakeApiClient,
+    logger: fakeLogger,
+  });
 
-    const event = {
-        assetId: 1234,
-        appStreamId: 2345,
-        appConnectionId: 3456,
-        records: [
-            {
-                company_id: 1,
-                asset_id: 1234,
-                timestamp: 157829400,
-                data: { hole_depth: 1000 }
-            },
-            {
-                company_id: 1,
-                asset_id: 1234,
-                timestamp: 157829401,
-                data: { hole_depth: 1001 }
-            },
-            {
-                company_id: 1,
-                asset_id: 1234,
-                timestamp: 157829402,
-                data: { hole_depth: 1001 }
-            },
-            {
-                company_id: 1,
-                asset_id: 1234,
-                timestamp: 157829403,
-                data: { hole_depth: 1001.5 }
-            },
-        ]
-    };
+  const event = {
+    asset_id: 1234,
+    app_stream_id: 2345,
+    records: [
+      {
+        company_id: 1,
+        asset_id: 1234,
+        timestamp: 157829400,
+        data: { hole_depth: 1000 },
+      },
+      {
+        company_id: 1,
+        asset_id: 1234,
+        timestamp: 157829401,
+        data: { hole_depth: 1001 },
+      },
+      {
+        company_id: 1,
+        asset_id: 1234,
+        timestamp: 157829402,
+        data: { hole_depth: 1001 },
+      },
+      {
+        company_id: 1,
+        asset_id: 1234,
+        timestamp: 157829403,
+        data: { hole_depth: 1001.5 },
+      },
+    ],
+  };
 
-    await processor.process({ event });
+  await processor.process({ event });
 });

package/template/stream/node/gitignore

@@ -0,0 +1,21 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+
+# testing
+/coverage
+
+# misc
+.env
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+*.zip

package/template/stream/node/index.js

@@ -6,11 +6,10 @@ const Processor = require('./src/processor');
  * @param {import('@corva/node-sdk').HandlerContext} context
  */
 exports.handler = new Corva().stream(async (event, context) => {
+  const processor = new Processor({
+    apiClient: context.api,
+    logger: context.logger,
+  });
 
-    const processor = new Processor({
-        apiClient: context.api,
-        logger: context.logger,
-    });
-
-    await processor.process({ event });
+  await processor.process({ event });
 });

package/template/stream/node/package.json

@@ -4,14 +4,14 @@
     "description": "My Dev Center Real-Time Stream Data App",
     "main": "index.js",
     "scripts": {
-        "bundle": "zip -r $npm_package_name-$npm_package_version.zip package.json package-lock.json manifest.json index.js src",
+        "bundle": "zip -r $npm_package_name-$npm_package_version.zip package.json $LOCKFILE manifest.json index.js src",
         "test": "npm audit --production && npm run unit",
         "unit": "jest"
     },
     "dependencies": {
-        "@corva/node-sdk": "^1.5.5"
+        "@corva/node-sdk": "^5.3.1"
     },
     "devDependencies": {
-        "jest": "^26.6.3"
+        "jest": "^27.2.0"
     }
 }