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

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

@@ -1,21 +1,18 @@
 class Processor {
-    constructor({ apiClient, logger}) {
-        this.apiClient = apiClient;
-        this.logger = logger;
-    }
-
-    async process({ event }) {
-        const {
-            asset_id,
-            records,
-        } = event;
+  constructor({ apiClient, logger }) {
+    this.apiClient = apiClient;
+    this.logger = logger;
+  }
 
-        if (!records.length) {
-            return;
-        }
+  async process({ event }) {
+    const { asset_id, records } = event;
 
-        this.logger.info(`Processing event. Asset: ${asset_id}. Received ${records.length} records.`);
+    if (!records.length) {
+      return;
     }
+
+    this.logger.info(`Processing event. Asset: ${asset_id}. Received ${records.length} records.`);
+  }
 }
 
 module.exports = Processor;

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

@@ -0,0 +1,25 @@
+# Dev Center Node.js TypeScript Real-Time Stream 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/stream/node-ts/__test__/processor.spec.ts

@@ -0,0 +1,43 @@
+import { Processor } from '../lib/processor';
+import type { HandlerContext } from '@corva/node-sdk';
+import { NormalizedStreamLambdaEvent } from '@corva/node-sdk/lib/lambdas/interfaces';
+
+test('process event', async () => {
+  const fakeLogger = console as unknown as HandlerContext['logger'];
+  const fakeApiClient = {} as unknown as HandlerContext['api'];
+
+  const processor = new Processor(fakeApiClient, fakeLogger);
+
+  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 },
+      },
+    ],
+  } as unknown as NormalizedStreamLambdaEvent<unknown>;
+
+  await processor.process(event);
+});

package/template/stream/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/stream/node-ts/index.ts

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

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

@@ -0,0 +1,16 @@
+import type { HandlerContext } from '@corva/node-sdk';
+import { NormalizedStreamLambdaEvent } from '@corva/node-sdk/lib/lambdas/interfaces';
+
+export class Processor {
+  constructor(private apiClient: HandlerContext['api'], private logger: HandlerContext['logger']) {}
+
+  async process(event: NormalizedStreamLambdaEvent<unknown>) {
+    const { asset_id, records } = event;
+
+    if (!records.length) {
+      return;
+    }
+
+    this.logger.info(`Processing event. Asset: ${asset_id}. Received ${records.length} records.`);
+  }
+}

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

@@ -0,0 +1,37 @@
+{
+    "name": "my-dev-center-real-time-stream-app",
+    "version": "0.0.1",
+    "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 $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/stream/node-ts/tsconfig.build.json

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

package/template/stream/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/task/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/task/node/__test__/processor.test.js

@@ -0,0 +1,18 @@
+const Processor = require('../src/processor');
+
+test('process event', async () => {
+  const fakeLogger = console;
+  const fakeApiClient = {};
+
+  const event = {
+    asset_id: 123,
+    company_id: 1234,
+    properties: {
+      foo: 'bar',
+    },
+  };
+
+  const processor = new Processor({ logger: fakeLogger, apiClient: fakeApiClient });
+
+  await processor.process({ event });
+});

package/template/task/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/task/node/index.js

@@ -2,16 +2,15 @@ const { Corva } = require('@corva/node-sdk');
 const Processor = require('./src/processor');
 
 /**
- * @param {import('@corva/node-sdk').TaskLambdaEvent} event
+ * @param {import('@corva/node-sdk').Task} event
  * @param {import('@corva/node-sdk').HandlerContext} context
  */
 exports.handler = new Corva().task((event, context) => {
+  const processor = new Processor({
+    apiClient: context.api,
+    logger: context.logger,
+    config: context.config,
+  });
 
-    const processor = new Processor({
-        apiClient: context.api,
-        logger: context.logger,
-        config: context.config,
-    });
-
-    return processor.process({ event });
+  return processor.process({ event });
 });

package/template/task/node/package.json

@@ -4,14 +4,14 @@
     "description": "My Dev Center Task 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/task/node/src/processor.js

@@ -1,21 +1,16 @@
 class Processor {
+  constructor({ apiClient, logger, config }) {
+    this.apiClient = apiClient;
+    this.logger = logger;
+  }
 
-    constructor({ apiClient, logger, config }) {
-        this.apiClient = apiClient;
-        this.logger = logger;
-        this.config = config;
-    }
+  async process({ event }) {
+    this.logger.debug({ event }, 'Event');
 
-    async process({ event }) {
-        this.logger.debug({ event }, 'Event');
+    const { asset_id: assetId, company_id: companyId } = event;
 
-        const {
-            asset_id: assetId,
-            company_id: companyId
-        } = event;
-
-        this.logger.info(`Processing event. Asset: ${assetId}`);
-    }
+    this.logger.info(`Processing event. Asset: ${assetId}`);
+  }
 }
 
 module.exports = Processor;

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

@@ -0,0 +1,25 @@
+# Dev Center Node.js Task 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/task/node-ts/__test__/processor.spec.ts

@@ -0,0 +1,27 @@
+import { HandlerContext, Task, TaskState } from '@corva/node-sdk';
+import { Processor } from '../src/processor';
+
+test('process event', async () => {
+  const fakeLogger = console as unknown as HandlerContext['logger'];
+  const fakeApiClient = {} as unknown as HandlerContext['api'];
+
+  const event: Task<{
+    foo: string;
+  }> = {
+    id: 'id',
+    state: TaskState.Running,
+    fail_reason: null,
+    asset_id: 123,
+    company_id: 1234,
+    properties: {
+      foo: 'bar',
+    },
+    document_bucket: 'test',
+    payload: null,
+    app_id: 42,
+  };
+
+  const processor = new Processor(fakeApiClient, fakeLogger);
+
+  await processor.process(event);
+});

package/template/task/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/task/node-ts/index.ts

@@ -0,0 +1,8 @@
+import { Corva } from '@corva/node-sdk';
+import { Processor } from './src/processor';
+
+exports.handler = new Corva().task((event, context) => {
+  const processor = new Processor(context.api, context.logger);
+
+  return processor.process(event);
+});

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

@@ -0,0 +1,37 @@
+{
+    "name": "my-dev-center-task-app",
+    "version": "0.0.1",
+    "description": "My Dev Center Task 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/task/node-ts/src/processor.ts

@@ -0,0 +1,13 @@
+import type { HandlerContext, Task } from '@corva/node-sdk';
+
+export class Processor {
+  constructor(private apiClient: HandlerContext['api'], private logger: HandlerContext['logger']) {}
+
+  async process(event: Task) {
+    this.logger.debug({ event }, 'Event');
+
+    const { asset_id: assetId, company_id: companyId } = event;
+
+    this.logger.info(`Processing event. Asset: ${assetId}`);
+  }
+}

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

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

package/template/task/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/ui/README.md

@@ -16,7 +16,7 @@ You will also see any lint errors in the console.
 
 Bundles the app into static files for production.
 
-### `yarn  zip`
+### `yarn zip`
 
 Bundles the app into ZIP file in app root directory
 

package/template/ui/gitignore

@@ -12,6 +12,7 @@
 /build
 
 # misc
+.env
 .DS_Store
 .env.local
 .env.development.local

package/template/ui/src/App.js

@@ -28,7 +28,8 @@ function App(props) {
           </a>
         </div>
         <div>
-          Settings &quot;Example&quot; checkbox is {isExampleCheckboxChecked ? 'checked' : 'unchecked'}
+          Settings &quot;Example&quot; checkbox is{' '}
+          {isExampleCheckboxChecked ? 'checked' : 'unchecked'}
         </div>
       </div>
     </div>

package/template/ui/src/AppSettings.js

@@ -33,7 +33,7 @@ AppSettings.propTypes = {
   company: PropTypes.shape({}),
   onSettingChange: PropTypes.func.isRequired,
   settings: PropTypes.shape({
-    isExampleCheckboxChecked: PropTypes.bool
+    isExampleCheckboxChecked: PropTypes.bool,
   }).isRequired,
   user: PropTypes.shape({}),
 };

package/template/ui/src/constants.js

@@ -1,3 +1,3 @@
 export const DEFAULT_SETTINGS = {
-  isExampleCheckboxChecked: false
+  isExampleCheckboxChecked: false,
 };

package/template/ui/src/index.js

@@ -1,5 +1,5 @@
-import App from "./App";
-import AppSettings from "./AppSettings";
+import App from './App';
+import AppSettings from './AppSettings';
 
 export default {
   component: App,

package/helpers/metadata.js

@@ -1,29 +0,0 @@
-function getType(item) {
-  if (typeof item === "string") return null;
-  if (Array.isArray(item)) return "rawlist";
-
-  if (typeof item === "boolean") return "expand";
-}
-
-function getChoices(item) {
-  if (typeof item === "string") return null;
-
-  if (Array.isArray(item)) return item;
-
-  if (typeof item === "boolean")
-    return [
-      {
-        key: "y",
-        value: true,
-      },
-      {
-        key: "n",
-        value: false,
-      },
-    ];
-}
-
-module.exports = {
-  getType,
-  getChoices,
-};