@wcardinal/wcardinal

$3

WinterCardinal is a library for real-time web applications build on top of the Spring framework.
It is designed for making single-page applications stable against unintended network/server failures.
The controller class and its fields defined on a server will be synchronized with clones on browsers in real time.
Also enables us to call methods defined on the controller class from browsers.

``java
import org.wcardinal.controller.annotation.AbstractController;
import org.wcardinal.controller.annotation.Controller;
import org.wcardinal.controller.annotation.Callable;

@Controller
class MyController extends AbstractController {
@Autowired
SLong field;

@OnCreate
void init() {
field.set(42);
}

@Callable
String hello(String name) {
return "Hello, " + name + "!";
}

void method() {
trigger("eventname", 42);
}
}
`

`html


`

$3

#### Gradle

`groovy
dependencies {
compile 'com.github.winter-cardinal:winter-cardinal:latest.release'
}
`

Client-side libraries are packed in this JAR as a WebJars.
Please find the wcardinal.worker.min.js in the directory META-INF/resources/webjars/wcardinal/${version}/.
WebJars can be loaded from browsers as follows:

`html

`

Please note that the ${version} part is omitted. The worker version wcardinal.worker.min.js is strongly recommended over the non-worker version wcardinal.min.js as the setTimeout is not reliable in some cases.

#### NPM

The client-side libraries are also available as a NPM package.

`shell
$> npm i @wcardinal/wcardinal
`

Please note that the NPM package has no default exports.

`javascript:JavaScript
import * as wcardinal from "@wcardinal/wcardinal";
`

#### CDN

`html


`

All the classes are in window.wcardinal in this case.
Note that the wcardinal.worker.min.js must be loaded before loading your controller as shown above.

$3

* API document
* Java
* JS
* Cheatsheet
* Starter

$3

|WinterCardinal Version|JDK Version |Spring Boot Version |
|-- |-- |-- |
|1.0.x |8 |2.2.4.RELEASE |
|1.1.0 |8 |2.7.18 |
|2.0.0 to 2.5.0 |17 |3.3.1 |

$3

#### JS for Release

`shell
npm run build
`

#### JS for Development

`shell
npm run watch:ts
`

and then in an another terminal

`shell
npm run watch:rollup
`

#### Java API Document

`shell
./gradlew compileJavaApiDocument
`

#### JS API Document

`shell
npm run build:api
`

#### Cheatsheet

`shell
npm run build:cheatsheet
`

$3

#### JReleaser Setting

In ~/.gradle/gradle.properties, add

`
systemProp.jreleaser.deploy.maven.mavencentral.sonatype.username=${Sonatype Username}
systemProp.jreleaser.deploy.maven.mavencentral.sonatype.password=${Sonatype Password}
systemProp.jreleaser.gpg.passphrase=${Passphrase of your key ring}
systemProp.jreleaser.gpg.secret.key=${Output of gpg --export-secret-keys ZZZZZZZZZZZZZZZZ | base64 -w0}
systemProp.jreleaser.gpg.public.key=${Output of gpg --export ZZZZZZZZZZZZZZZZ | base64 -w0}
systemProp.jreleaser.github.token=${GitHub Token https://github.com/settings/tokens/}

developer.username=${Sonatype Username}
developer.name=${Sonatype}
developer.email=${Your Email}
`

Here, ZZZZZZZZZZZZZZZZ is from the following:

`
$ gpg --list-keys --keyid-format=long
/c/Users/XXXXXXXX/.gnupg/pubring.kbx
------------------------------------
pub rsa3072/XXXXXXXXXXXXXXXX YYYY-MM-DD [SC] [expires: YYYY-MM-DD]
YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY
uid [ultimate] Your Name
sub rsa3072/ZZZZZZZZZZZZZZZZ YYYY-MM-DD [E] [expires: YYYY-MM-DD]
`

Refer to https://foojay.io/today/how-to-release-a-java-module-with-jreleaser-to-maven-central-with-github-actions/

#### Sending Public Key

Need to send the public key to https://keyserver.ubuntu.com/ .

`
gpg --export --armor ZZZZZZZZZZZZZZZZ > public.key
`

Go to https://keyserver.ubuntu.com/ and submit the content of public.key.


#### Publish Jars

`
./gradlew clean
npm run build
./gradlew publish
./gradlew jreleaseFullRelease
`

./gradlew jreleaseFullRelease might fail because of a proxy.
In that case, upload build/deploy/mavenCentral/sonatype/*.zip to https://central.sonatype.com/publishing manually.

See also:
* https://jreleaser.org/guide/latest/examples/maven/maven-central.html#_portal_publisher_api
* https://central.sonatype.org/publish/publish-portal-gradle/

#### NPM

`shell
npm publish
``

$3

Apache License Version 2.0