Skip to content

Commit 1c83e75

Browse files
committed
Move Tecemux from Verser
1 parent 116e0b9 commit 1c83e75

35 files changed

+641
-9
lines changed

packages/host/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
"@scramjet/telemetry": "^0.35.3",
2929
"@scramjet/utility": "^0.35.3",
3030
"@scramjet/verser": "^0.35.3",
31+
"@scramjet/tecemux": "^0.35.3",
3132
"bpmux": "^8.2.1",
3233
"ext-ip": "^0.3.9",
3334
"find-package-json": "^1.2.0",

packages/host/src/lib/csi-controller.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ import { DuplexStream, getRouter } from "@scramjet/api-server";
4444
import { getInstanceAdapter } from "@scramjet/adapters";
4545
import { cancellableDefer, CancellablePromise, defer, promiseTimeout, TypedEmitter } from "@scramjet/utility";
4646
import { ObjLogger } from "@scramjet/obj-logger";
47-
import { TeceMux } from "@scramjet/verser";
47+
import { TeceMux } from "@scramjet/tecemux";
4848
import { ReasonPhrases } from "http-status-codes";
4949

5050
/**

packages/host/src/lib/socket-server.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import net, { Socket } from "net";
44

55
import { isDefined, TypedEmitter } from "@scramjet/utility";
66
import { ObjLogger } from "@scramjet/obj-logger";
7-
import { TeceMux, TeceMuxChannel } from "@scramjet/verser";
7+
import { TeceMux, TeceMuxChannel } from "@scramjet/tecemux";
88

99
type MaybeChannel = TeceMuxChannel | Socket | null;
1010

packages/runner/Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ COPY ./dist/obj-logger ./dist/obj-logger
2828
COPY ./dist/model ./dist/model
2929
COPY ./dist/runner ./dist/runner
3030
COPY ./dist/verser ./dist/verser
31+
COPY ./dist/tecemux ./dist/tecemux
3132
COPY ./dist/package.json ./dist/package.json
3233

3334
FROM target

packages/runner/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"@scramjet/obj-logger": "^0.35.2",
2424
"@scramjet/symbols": "^0.35.2",
2525
"@scramjet/utility": "^0.35.2",
26-
"@scramjet/verser": "^0.35.2",
26+
"@scramjet/tecemux": "^0.35.2",
2727
"scramjet": "^4.36.9"
2828
},
2929
"devDependencies": {

packages/runner/src/host-client.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ import { CommunicationChannel as CC } from "@scramjet/symbols";
44
import net, { createConnection, Socket } from "net";
55
import { ObjLogger } from "@scramjet/obj-logger";
66
import { Agent } from "http";
7-
import { TeceMux, TeceMuxChannel } from "@scramjet/verser";
7+
import { TeceMux, TeceMuxChannel } from "@scramjet/tecemux";
88

99
type HostOpenConnections = [
10-
TeceMuxChannel, TeceMuxChannel, TeceMuxChannel, TeceMuxChannel, TeceMuxChannel, TeceMuxChannel, TeceMuxChannel, TeceMuxChannel, TeceMuxChannel
10+
TeceMuxChannel, TeceMuxChannel, TeceMuxChannel, TeceMuxChannel,
11+
TeceMuxChannel, TeceMuxChannel, TeceMuxChannel, TeceMuxChannel, TeceMuxChannel
1112
]
1213

1314
/**

packages/sth/Dockerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ COPY ./dist/types ./dist/types
1717
COPY ./dist/load-check ./dist/load-check
1818
COPY ./dist/utility ./dist/utility
1919
COPY ./dist/verser ./dist/verser
20+
COPY ./dist/tecemux ./dist/tecemux
2021
COPY ./dist/telemetry ./dist/telemetry
2122
COPY ./dist/package.json ./dist/package.json
2223
COPY LICENSE ./

packages/tecemux/.eslintrc.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
module.exports = {
2+
ignorePatterns: [".eslintrc.js", "types.ts"],
3+
parserOptions:{
4+
project: "./tsconfig.json",
5+
tsconfigRootDir: __dirname
6+
}
7+
};

packages/tecemux/README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Scramjet Verser <!-- omit in toc -->
2+
3+
![Scramjet Transform Hub](https://assets.scramjet.org/sth-logo.svg "Scramjet Transform Hub Logo")
4+
5+
This package provides a reverse server functionality.
6+
7+
```bash
8+
npm install -g @scramjet/verser
9+
```
10+
11+
## Docs
12+
13+
See the code documentation here: [scramjetorg/transform-hub/docs/verser/modules.md](https://github.com/scramjetorg/transform-hub/tree/HEAD/docs/verser/modules.md)
14+
15+
## Scramjet Transform Hub
16+
17+
This package is part of [Scramjet Transform Hub](https://www.npmjs.org/package/@scramjet/sth).
18+
19+
Scramjet Transform Hub is a deployment and execution platform. Once installed on a server, it will allow you to start your programs and keep them running on a remote machine. You will be able to start programs in the background or connect to them and see their output directly on your terminal. You will be able to pipe your local data to the program, as if it was running from your terminal. You can start your server in AWS, Google Cloud or Azure, start it on your local machine, install it on a Raspberry Pi or wherever else you'd like.
20+
21+
## Use cases
22+
23+
There's no limit what you can use it for. You want a stock checker? A chat bot? Maybe you'd like to automate your home? Retrieve sensor data? Maybe you have a lot of data and want to transfer and wrangle it? You have a database of cities and you'd like to enrich your data? You do machine learning and you want to train your set while the data is fetched in real time? Hey, you want to use it for something else and ask us if that's a good use? Ask us [via email](mailto:get@scramjet.org) or hop on our [Scramjet Discord](https://scr.je/join-community-mg1)!
24+
25+
## Some important links
26+
27+
* Scramjet, the company behind [Transform Hub](https://scramjet.org)
28+
* The [Scramjet Framework - functional reactive stream processing framework](https://framework.scramjet.org)
29+
* The [Transform Hub repo on github](https://github.com/scramjetorg/transform-hub)
30+
* You can see the [Scramjet Transform Hub API docs here](https://github.com/scramjetorg/transform-hub/tree/HEAD/docs/api-client/README.md)
31+
* You can see the [CLI documentation here](https://github.com/scramjetorg/transform-hub/tree/HEAD/packages/cli/README.md), but `si help` should also be quite effective.
32+
* Don't forget to ⭐ this repo if you like it, `subscribe` to releases and keep visiting us for new versions and updates.
33+
* You can [open an issue - file a bug report or a feature request here](https://github.com/scramjetorg/transform-hub/issues/new/choose)
34+
35+
## License and contributions
36+
37+
This module is licensed under AGPL-3.0 license.
38+
39+
The Scramjet Transform Hub project is dual-licensed under the AGPL-3.0 and MIT licenses. Parts of the project that are linked with your programs are MIT licensed, the rest is AGPL.
40+
41+
## Contributions
42+
43+
We accept valid contributions and we will be publishing a more specific project roadmap so contributors can propose features and also help us implement them. We kindly ask you that contributed commits are Signed-Off `git commit --sign-off`.
44+
45+
We provide support for contributors via test cases. If you expect a certain type of workflow to be officially supported, please specify and implement a test case in `Gherkin` format in `bdd` directory and include it in your pull request. More info about our BDD test you will find [here](https://github.com/scramjetorg/transform-hub/tree/HEAD/bdd/README.md).
46+
47+
### Help wanted 👩‍🎓🧑👱‍♀️
48+
49+
The project need's your help! There's lots of work to do and we have a lot of plans. If you want to help and be part of the Scramjet team, please reach out to us, [on discord](https://scr.je/join-community-mg1) or email us: [opensource@scramjet.org](mailto:opensource@scramjet.org).
50+
51+
### Donation 💸
52+
53+
Do you like this project? It helped you to reduce time spent on delivering your solution? You are welcome to buy us a coffee ☕ Thanks a lot! 😉
54+
55+
[You can sponsor us on github](https://github.com/sponsors/scramjetorg)
56+
57+
* There's also a Paypal donation link if you prefer that:
58+
59+
[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=7F7V65C43EBMW)
60+
61+
62+

packages/tecemux/package.json

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
{
2+
"name": "@scramjet/tecemux",
3+
"version": "0.35.3",
4+
"description": "This package is part of Scramjet Transform Hub. The package provides a communication protocol used among Scramjet modules.",
5+
"main": "./src/index.ts",
6+
"scripts": {
7+
"start": "ts-node ./src/bin/index",
8+
"build": "../../scripts/build-all.js --config-name=tsconfig.build.json --copy-dist",
9+
"build:docs": "typedoc",
10+
"clean": "rm -rf ./dist .bic_cache",
11+
"test": "npm run test:ava",
12+
"test:ava": "ava"
13+
},
14+
"author": "Scramjet <open-source@scramjet.org>",
15+
"license": "AGPL-3.0",
16+
"dependencies": {
17+
"@scramjet/obj-logger": "^0.35.3",
18+
"@scramjet/utility": "^0.35.3",
19+
"bpmux": "^8.2.1"
20+
},
21+
"devDependencies": {
22+
"@scramjet/api-server": "^0.35.3",
23+
"@scramjet/types": "^0.35.3",
24+
"@types/node": "15.12.5",
25+
"ava": "^3.15.0",
26+
"ts-node": "^10.9.1",
27+
"typedoc": "0.23.17",
28+
"typedoc-plugin-markdown": "3.13.6",
29+
"typescript": "~4.7.4"
30+
},
31+
"ava": {
32+
"extensions": [
33+
"ts"
34+
],
35+
"files": [
36+
"**/*.spec.ts"
37+
],
38+
"require": [
39+
"ts-node/register"
40+
]
41+
},
42+
"repository": {
43+
"type": "git",
44+
"url": "https://github.com/scramjetorg/transform-hub.git"
45+
}
46+
}

0 commit comments

Comments
 (0)