Naming consistency: Use DeltaChat not Deltachat

This commit is contained in:
Franz Heinzmann (Frando)
2022-06-30 00:31:32 +02:00
committed by Simon Laux
parent 7fc162543a
commit 7eae3a1072
9 changed files with 31 additions and 25 deletions

View File

@@ -0,0 +1,6 @@
node_modules
accounts
docs
coverage
yarn*
package-lock.json

View File

@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>Deltachat JSON-RPC example</title>
<title>DeltaChat JSON-RPC example</title>
<style>
body {
font-family: monospace;
@@ -42,7 +42,7 @@
<script type="module" src="dist/example.bundle.js"></script>
</head>
<body>
<h1>Deltachat JSON-RPC example</h1>
<h1>DeltaChat JSON-RPC example</h1>
<div class="grid">
<div id="header"></div>
<div id="main"></div>

View File

@@ -1,4 +1,4 @@
import { Deltachat, DeltachatEvent } from "../deltachat.js";
import { DeltaChat, DeltaChatEvent } from "../deltachat.js";
var SELECTED_ACCOUNT = 0;
@@ -16,7 +16,7 @@ async function run() {
const $side = document.getElementById("side")!;
const $head = document.getElementById("header")!;
const client = new Deltachat('ws://localhost:20808/ws')
const client = new DeltaChat('ws://localhost:20808/ws')
;(window as any).client = client.rpc;
@@ -88,7 +88,7 @@ async function run() {
}
}
function onIncomingEvent(event: DeltachatEvent) {
function onIncomingEvent(event: DeltaChatEvent) {
write(
$side,
`

View File

@@ -1,9 +1,9 @@
import { Deltachat } from "../dist/deltachat.js";
import { DeltaChat } from "../dist/deltachat.js";
run().catch(console.error);
async function run() {
const delta = new Deltachat('ws://localhost:20808/ws');
const delta = new DeltaChat('ws://localhost:20808/ws');
delta.on("event", (event) => {
console.log("event", event.data);
});

View File

@@ -1,9 +1,9 @@
import { Deltachat } from "../dist/deltachat.js";
import { DeltaChat } from "../dist/deltachat.js";
run().catch(console.error);
async function run() {
const delta = new Deltachat();
const delta = new DeltaChat();
delta.on("event", (event) => {
console.log("event", event.data);
});

View File

@@ -1,5 +1,5 @@
{
"name": "@deltachat/jsonrpc-client",
"name": "deltachat-jsonrpc-client",
"version": "0.1.0",
"main": "dist/deltachat.js",
"types": "dist/deltachat.d.ts",
@@ -12,7 +12,7 @@
"generate-bindings": "cargo test",
"build": "run-s generate-bindings build:tsc build:bundle",
"build:tsc": "tsc",
"build:bundle": "esbuild --bundle dist/deltachat.js --outfile=dist/deltachat.bundle.js",
"build:bundle": "esbuild --format=esm --bundle dist/deltachat.js --outfile=dist/deltachat.bundle.js",
"example": "run-s build example:build example:start",
"example:build": "esbuild --bundle dist/example/example.js --outfile=dist/example.bundle.js",
"example:start": "http-server .",

View File

@@ -5,7 +5,7 @@ import { EventTypeName } from "../generated/events.js";
import { WebsocketTransport, BaseTransport, Request } from "yerpc";
import { TinyEmitter } from "tiny-emitter";
export type DeltachatEvent = {
export type DeltaChatEvent = {
id: EventTypeName;
contextId: number;
field1: any;
@@ -13,10 +13,10 @@ export type DeltachatEvent = {
};
export type Events = Record<
EventTypeName | "ALL",
(event: DeltachatEvent) => void
(event: DeltaChatEvent) => void
>;
export class BaseDeltachat<
export class BaseDeltaChat<
Transport extends BaseTransport<any>
> extends TinyEmitter<Events> {
rpc: RawClient;
@@ -28,7 +28,7 @@ export class BaseDeltachat<
this.transport.on("request", (request: Request) => {
const method = request.method;
if (method === "event") {
const event = request.params! as DeltachatEvent;
const event = request.params! as DeltaChatEvent;
this.emit(event.id, event);
this.emit("ALL", event);
@@ -61,7 +61,7 @@ export type Opts = {
export const DEFAULT_OPTS: Opts = {
url: "ws://localhost:20808/ws",
};
export class Deltachat extends BaseDeltachat<WebsocketTransport> {
export class DeltaChat extends BaseDeltaChat<WebsocketTransport> {
opts: Opts;
close() {
this.transport.close();

View File

@@ -2,7 +2,7 @@ import { strictEqual } from "assert";
import chai, { assert, expect } from "chai";
import chaiAsPromised from "chai-as-promised";
chai.use(chaiAsPromised);
import { Deltachat } from "../deltachat.js";
import { DeltaChat } from "../deltachat.js";
import {
RpcServerHandle,
@@ -11,13 +11,13 @@ import {
describe("basic tests", () => {
let serverHandle: RpcServerHandle;
let dc: Deltachat;
let dc: DeltaChat;
before(async () => {
serverHandle = await startServer();
// make sure server is up by the time we continue
await new Promise((res) => setTimeout(res, 100));
dc = new Deltachat(serverHandle.url)
dc = new DeltaChat(serverHandle.url)
// dc.on("ALL", (event) => {
//console.log("event", event);
// });

View File

@@ -1,5 +1,5 @@
import { assert, expect } from "chai";
import { Deltachat, DeltachatEvent, EventTypeName } from "../deltachat.js";
import { DeltaChat, DeltaChatEvent, EventTypeName } from "../deltachat.js";
import {
RpcServerHandle,
createTempUser,
@@ -10,7 +10,7 @@ const EVENT_TIMEOUT = 10000
describe("online tests", function () {
let serverHandle: RpcServerHandle;
let dc: Deltachat;
let dc: DeltaChat;
let account1: { email: string; password: string };
let account2: { email: string; password: string };
let accountId1: number, accountId2: number;
@@ -31,7 +31,7 @@ describe("online tests", function () {
this.skip();
}
serverHandle = await startServer();
dc = new Deltachat(serverHandle.url)
dc = new DeltaChat(serverHandle.url)
dc.on("ALL", ({ id, contextId }) => {
if (id !== "Info") console.log(contextId, id);
@@ -182,17 +182,17 @@ describe("online tests", function () {
});
async function waitForEvent(
dc: Deltachat,
dc: DeltaChat,
eventType: EventTypeName,
accountId: number,
timeout: number = EVENT_TIMEOUT
): Promise<DeltachatEvent> {
): Promise<DeltaChatEvent> {
return new Promise((resolve, reject) => {
const rejectTimeout = setTimeout(
() => reject(new Error('Timeout reached before event came in')),
timeout
)
const callback = (event: DeltachatEvent) => {
const callback = (event: DeltaChatEvent) => {
if (event.contextId == accountId) {
dc.off(eventType, callback);
clearTimeout(rejectTimeout)