add examples

Author: rinick

.gitignore

@@ -0,0 +1,17 @@
+
+node_modules
+
+/.nyc_output
+/coverage
+/playground
+/.idea
+/.cache
+build
+/dist
+/src/**/*.js
+/test/**/*.js
+/example/**/*.js
+*.map
+*.jsx
+/tool/**/*.js
+/temp

.prettierrc

@@ -0,0 +1,9 @@
+{
+  "tabWidth": 2,
+  "printWidth": 120,
+  "semi": true,
+  "singleQuote": true,
+  "bracketSpacing": false,
+  "arrowParens": "always",
+  "quoteProps": "consistent"
+}

package.json

@@ -0,0 +1,30 @@
+{
+  "name": "server-example",
+  "version": "0.0.2",
+  "description": "ticlo server example",
+  "scripts": {
+    "basic-example": "ts-node src/basic-example/main.ts",
+    "route-example": "ts-node src/route-example/main.ts",
+    "multi-server-example": "ts-node src/multi-server-example/main.ts",
+    "custom-function-example": "ts-node src/custom-function-example/main.ts"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ticlo/server-example.git"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@ticlo/core": "^0.0.4",
+    "@ticlo/express": "^0.0.4",
+    "@ticlo/node": "^0.0.4",
+    "@types/express": "^4.17.2",
+    "express": "^4.17.1",
+    "ts-node": "^8.6.2",
+    "typescript": "^3.7.5",
+    "moment": "^2.24.0"
+  },
+  "devDependencies": {
+    "prettier": "^1.19.1"
+  }
+}

src/basic-example/example.ticlo

@@ -0,0 +1,33 @@
+{
+"#is": "",
+"add": {
+ "#is": "add",
+ "0": 2,
+ "1": 3,
+ "@b-p": [
+  "0",
+  "1",
+  "output"
+ ],
+ "@b-xyw": [
+  88.796875,
+  65,
+  150
+ ]
+},
+"add0": {
+ "#is": "add",
+ "@b-p": [
+  "0",
+  "1",
+  "output"
+ ],
+ "@b-xyw": [
+  321.796875,
+  91,
+  150
+ ],
+ "~0": "##.add.1",
+ "~1": "##.add.output"
+}
+}

src/basic-example/main.ts

@@ -0,0 +1,14 @@
+import Express from 'express';
+import {Root} from '@ticlo/core';
+import {FileJobLoader} from '@ticlo/node';
+import {connectTiclo, getEditorUrl} from '@ticlo/express';
+
+// save load jobs from the the same folder
+Root.instance.setLoader(new FileJobLoader('./src/basic-example'));
+
+let app = Express();
+connectTiclo(app, '');
+
+app.listen(8010);
+
+console.log(getEditorUrl('ws://127.0.0.1:8010', 'example'));

src/custom-function-example/async-function.ts

@@ -0,0 +1,29 @@
+import {Functions, BaseFunction} from '@ticlo/core';
+
+// sort input string and output an array
+class SortStringFunction extends BaseFunction {
+  run(): any {
+    let delay = this._data.getValue('delay');
+    if (delay > 0) {
+      return new Promise((resolve) => {
+        setTimeout(() => {
+          this._data.output(delay);
+          resolve();
+        }, delay * 1000);
+      });
+    }
+  }
+}
+
+Functions.add(
+  SortStringFunction,
+  {
+    name: 'delay',
+    icon: 'fas:bomb', // icon from font awesome
+    properties: [
+      {name: 'delay', type: 'number'},
+      {name: 'output', type: 'number', readonly: true}
+    ]
+  },
+  'my' // namespace for the function
+);

src/custom-function-example/example.ticlo

@@ -0,0 +1,44 @@
+{
+"#is": "",
+"delay": {
+ "#is": "my:delay",
+ "#more": [],
+ "@b-p": [
+  "delay",
+  "output"
+ ],
+ "@b-xyw": [
+  349.796875,
+  176,
+  243
+ ],
+ "delay": 5
+},
+"get-time": {
+ "#is": "my:get-time",
+ "@b-p": [
+  "output"
+ ],
+ "@b-xyw": [
+  624.796875,
+  331,
+  243
+ ],
+ "~#call": "##.delay.output"
+},
+"sort-string": {
+ "#is": "my:sort-string",
+ "0": "b",
+ "1": "a",
+ "@b-p": [
+  "0",
+  "1",
+  "output"
+ ],
+ "@b-xyw": [
+  24.796875,
+  179,
+  234
+ ]
+}
+}

src/custom-function-example/group-input-function.ts

@@ -0,0 +1,43 @@
+import {Functions, BaseFunction} from '@ticlo/core';
+
+// sort input string and output an array
+class SortStringFunction extends BaseFunction {
+  run(): any {
+    let len = this._data.getLength();
+    if (!(len >= 0)) {
+      len = 2;
+    }
+    let arr: any[] = [];
+    for (let i = 0; i < len; ++i) {
+      let val = this._data.getValue(String(i));
+      if (typeof val !== 'string') {
+        // invalid input
+        this._data.output(undefined);
+        return;
+      } else {
+        arr.push(val);
+      }
+    }
+    arr.sort();
+    this._data.output(arr);
+  }
+}
+
+Functions.add(
+  SortStringFunction,
+  {
+    name: 'sort-string',
+    icon: 'fas:sort-alpha-down', // icon from font awesome
+    properties: [
+      {
+        // input 0 1 2 3 .... as string
+        name: '',
+        type: 'group',
+        defaultLen: 2,
+        properties: [{name: '', type: 'string', visible: 'high'}]
+      },
+      {name: 'output', type: 'array', readonly: true}
+    ]
+  },
+  'my' // namespace for the function
+);

src/custom-function-example/main.ts

@@ -0,0 +1,19 @@
+import Express from 'express';
+import {Root} from '@ticlo/core';
+import {FileJobLoader} from '@ticlo/node';
+import {connectTiclo, getEditorUrl} from '@ticlo/express';
+
+// import the function
+import './async-function';
+import './group-input-function';
+import './oncall-function';
+
+// save load jobs from the the same folder
+Root.instance.setLoader(new FileJobLoader('./src/custom-function-example'));
+
+let app = Express();
+connectTiclo(app, '');
+
+app.listen(8014);
+
+console.log(getEditorUrl('ws://127.0.0.1:8014', 'example'));

src/custom-function-example/oncall-function.ts

@@ -0,0 +1,20 @@
+import {Functions, BaseFunction} from '@ticlo/core';
+import Moment from 'moment';
+
+// sort input string and output an array
+class GetTimeFunction extends BaseFunction {
+  run(): any {
+    this._data.output(Moment());
+  }
+}
+
+Functions.add(
+  GetTimeFunction,
+  {
+    name: 'get-time',
+    icon: 'fas:clock', // icon from font awesome
+    mode: 'onCall', // by default run function only when #call is triggered
+    properties: [{name: 'output', type: 'date', readonly: true}]
+  },
+  'my' // namespace for the function
+);

src/multi-server-example/example.ticlo

@@ -0,0 +1,108 @@
+{
+"#is": "",
+"note": {
+ "#is": "note",
+ "@b-p": [
+  "text",
+  "color",
+  "background",
+  "border"
+ ],
+ "@b-xyw": [
+  26.796875,
+  28,
+  453
+ ],
+ "text": "this is example of routing to multiple servers\ntry these links:\nport 8012\nhttp://localhost:8012/ticlo1/test\nhttp://localhost:8012/ticlo2/test\nport 8013:\nhttp://localhost:8013/ticlo3/test"
+},
+"route1": {
+ "#is": "http:route",
+ "@b-p": [
+  "server",
+  "path"
+ ],
+ "@b-xyw": [
+  46.796875,
+  234,
+  227
+ ],
+ "contentType": [
+  "empty"
+ ],
+ "method": [
+  "GET"
+ ],
+ "path": "/test",
+ "~server": "^server1.output"
+},
+"route2": {
+ "#is": "http:route",
+ "@b-p": [
+  "server",
+  "path"
+ ],
+ "@b-xyw": [
+  304.796875,
+  239,
+  222
+ ],
+ "contentType": [
+  "empty"
+ ],
+ "method": [
+  "GET"
+ ],
+ "path": "/test",
+ "~server": "^server2.output"
+},
+"route3": {
+ "#is": "http:route",
+ "@b-p": [
+  "server",
+  "path"
+ ],
+ "@b-xyw": [
+  560.796875,
+  237,
+  234
+ ],
+ "contentType": [
+  "empty"
+ ],
+ "method": [
+  "GET"
+ ],
+ "path": "/test",
+ "~server": "^server3.output"
+},
+"static-response1": {
+ "#is": "http:static-response",
+ "#sync": true,
+ "@b-p": [
+  "data"
+ ],
+ "@b-xyw": "route1",
+ "data": "test 1",
+ "~#call": "##.route1.#emit"
+},
+"static-response2": {
+ "#is": "http:static-response",
+ "#sync": true,
+ "@b-p": [
+  "data"
+ ],
+ "@b-xyw": "route2",
+ "data": "test 2",
+ "~#call": "##.route2.#emit"
+},
+"static-response3": {
+ "#is": "http:static-response",
+ "#sync": true,
+ "@b-p": [
+  "data"
+ ],
+ "@b-xyw": "route3",
+ "data": "test 3",
+ "~#call": "##.route3.#emit"
+}
+}

src/multi-server-example/main.ts

@@ -0,0 +1,19 @@
+import Express from 'express';
+import {Root} from '@ticlo/core';
+import {connectTiclo, routeTiclo, getEditorUrl} from '@ticlo/express';
+import {FileJobLoader} from '@ticlo/node';
+
+// save load jobs from the same folder
+Root.instance.setLoader(new FileJobLoader('./src/multi-server-example'));
+
+let app = Express();
+connectTiclo(app, '');
+routeTiclo(app, '/ticlo1', 'server1');
+routeTiclo(app, '/ticlo2', 'server2'); // same host, different path
+app.listen(8012);
+
+let bpp = Express();
+routeTiclo(bpp, '/ticlo3', 'server3'); // different host; not used for Editor
+bpp.listen(8013);
+
+console.log(getEditorUrl('ws://127.0.0.1:8012', 'example'));