init

.eslintrc.js

@@ -0,0 +1,24 @@
+/*
+ * Copyright (C) Sapphirecode - All Rights Reserved
+ * This file is part of Snippeteer which is released under BSD-3-Clause.
+ * See file 'LICENSE' for full license details.
+ * Created by Timo Hocker <timo@scode.ovh>, March 2020
+ */
+
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true
+  },
+  extends: [
+    '@scode'
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly'
+  },
+  parserOptions: {
+    ecmaVersion: 2018
+  }
+}

.gitignore

@@ -0,0 +1,4 @@
+/node_modules/
+/dist/
+/.nyc_output/
+/coverage/

.npmrc

@@ -0,0 +1 @@
+@scode:registry=https://npm.scode.ovh

Jenkinsfile

@@ -0,0 +1,23 @@
+pipeline {
+    agent any
+
+    environment {
+        VERSION = VersionNumber([
+            versionNumberString:
+                '${BUILDS_ALL_TIME}',
+            versionPrefix: '1.0.',
+            worstResultForIncrement: 'SUCCESS'
+        ])
+    }
+
+    stages {
+        stage('Building') {
+            steps {
+                script {
+                    currentBuild.displayName = env.VERSION
+                }
+                sh 'yarn ci ${VERSION}'
+            }
+        }
+    }
+}

jenkins.js

@@ -0,0 +1,33 @@
+/*
+ * Copyright (C) Sapphirecode - All Rights Reserved
+ * This file is part of Snippeteer which is released under BSD-3-Clause.
+ * See file 'LICENSE' for full license details.
+ * Created by Timo Hocker <timo@scode.ovh>, March 2020
+ */
+
+/* eslint-disable no-process-exit */
+/* eslint-disable no-console */
+/* eslint-disable no-sync */
+'use strict';
+
+const fs = require ('fs');
+const child_process = require ('child_process');
+
+const pkg = JSON.parse (fs.readFileSync ('package.json', 'utf-8'));
+[
+  ,, pkg.version
+] = process.argv;
+fs.writeFileSync ('package.json', JSON.stringify (pkg, null, 2));
+
+child_process.execSync ('yarn lint', { stdio: 'inherit' });
+if (typeof pkg.scripts !== 'undefined' && typeof pkg.scripts.test === 'string')
+  child_process.execSync ('yarn test', { stdio: 'inherit' });
+
+child_process.exec ('git log -1 | grep \'\\[no publish\\]\'')
+  .addListener ('exit', (code) => {
+    if (code === 0) {
+      console.log ('build not marked for deployment');
+      process.exit (1);
+    }
+    else { child_process.execSync ('yarn publish'); }
+  });

lib/.eslintrc.js

@@ -0,0 +1,24 @@
+/*
+ * Copyright (C) Sapphirecode - All Rights Reserved
+ * This file is part of Snippeteer which is released under BSD-3-Clause.
+ * See file 'LICENSE' for full license details.
+ * Created by Timo Hocker <timo@scode.ovh>, March 2020
+ */
+
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true
+  },
+  extends: [
+    '@scode/eslint-config-ts'
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly'
+  },
+  parserOptions: {
+    ecmaVersion: 2018
+  }
+}

lib/ControlModel.ts

@@ -0,0 +1,10 @@
+export abstract class ControlModel {
+  public abstract get object(): Record<string, unknown>;
+  public abstract set object(obj: Record<string, unknown>);
+
+  public update (): void {
+    this.verify ();
+  }
+
+  public abstract verify(): void;
+}

lib/DatabaseModel.ts

@@ -0,0 +1,25 @@
+export abstract class DatabaseModel {
+  protected id?: number;
+
+  public static async get<T extends DatabaseModel> (
+    id: number,
+    constructor: new () => T
+  ): Promise<T> {
+    const dbm = (new constructor);
+    dbm.id = id;
+    await dbm.read ();
+    return dbm;
+  }
+
+  public get object (): Record<string, number | string | undefined> {
+    const obj = { id: this.id };
+    return obj;
+  }
+
+  public set object (obj: Record<string, number | string | undefined>) {
+    this.id = obj.id as number | undefined;
+  }
+
+  public abstract read(): Promise<void>;
+  public abstract write(): Promise<void>;
+}

lib/index.ts

@@ -0,0 +1,2 @@
+export { ControlModel } from './ControlModel';
+export { DatabaseModel } from './DatabaseModel';

package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@scode/modelling",
+  "version": "1.0.0",
+  "main": "index.js",
+  "author": "Timo Hocker <t-hocker@web.de>",
+  "license": "MIT",
+  "devDependencies": {
+    "@ava/typescript": "^1.1.1",
+    "@scode/eslint-config-ts": "^1.0.22",
+    "ava": "^3.7.1",
+    "eslint": "^6.8.0",
+    "nyc": "^15.0.1",
+    "typescript": "^3.8.3"
+  },
+  "scripts": {
+    "lint": "eslint . --ext .js,.jsx,.ts,.tsx,.vue,.mjs",
+    "test": "nyc ava",
+    "ci": "yarn && node jenkins.js"
+  }
+}

tsconfig.json

@@ -0,0 +1,66 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist",                        /* Redirect output structure to the directory. */
+    "rootDir": "./lib",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  }
+}