Initial commit

Author: faassen

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+dist

.npmignore

@@ -0,0 +1,6 @@
+# override .gitignore as we don't want `dist` to be checked in
+# but we *do* want it to be included when we publish. Without
+# an .nmpignore, npm will use .gitignore by default which is
+# what we don't want. node_modules is automatically ignored.
+# https://docs.npmjs.com/cli/v8/using-npm/developers#keeping-files-out-of-your-package
+

package-lock.json

@@ -0,0 +1,41 @@
+{
+  "name": "webxdc-types",
+  "version": "0.0.1",
+  "description": "TypeScript type definitions for webxdc",
+  "homepage": "https://github.com/webxdc/webxdc-types#readme",
+  "keywords": [
+    "webxdc",
+    "deltachat"
+  ],
+  "license": "unlicense",
+  "contributors": [
+    {
+      "name": "Webxdc devs",
+      "url": "https://webxdc.org"
+    },
+    {
+      "name": "Martijn Faassen",
+      "email": "faassen@startifact.com",
+      "url": "http://blog.startifact.com"
+    }
+  ],
+  "types": "./dist/webxdc.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "build": "npm run clean && tsc",
+    "clean": "rimraf dist",
+    "version": "version-changelog CHANGELOG.md && git add CHANGELOG.md",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@tsconfig/recommended": "^1.0.1",
+    "prettier": "^2.7.1",
+    "rimraf": "^3.0.2",
+    "typescript": "^4.7.3",
+    "version-changelog": "^3.1.1"
+  },
+  "dependencies": {}
+}

package.json

@@ -0,0 +1,39 @@
+type JsonObject = {
+  [x: string]: JsonValue;
+};
+
+export type JsonValue =
+  | string
+  | number
+  | boolean
+  | null
+  | JsonObject
+  | Array<JsonValue>;
+
+export type Update<T> = {
+  payload: T;
+  info?: string;
+  document?: string;
+  summary?: string;
+};
+
+export type ReceivedUpdate<T> = Update<T> & {
+  serial: number;
+  max_serial: number;
+};
+
+export type UpdateListener<T> = (update: ReceivedUpdate<T>) => void;
+
+export type SendUpdate<T> = (update: Update<T>, descr: string) => void;
+
+export type SetUpdateListener<T> = (
+  listener: UpdateListener<T>,
+  serial: number
+) => Promise<void>;
+
+export type WebXdc<T = JsonValue> = {
+  sendUpdate: SendUpdate<T>;
+  setUpdateListener: SetUpdateListener<T>;
+  selfAddr: string;
+  selfName: string;
+};

src/webxdc.ts

@@ -0,0 +1,13 @@
+{
+  "extends": "@tsconfig/recommended/tsconfig.json",
+  "include": ["src"],
+  "compilerOptions": {
+    "target": "ES2016",
+    "module": "commonjs",
+    "outDir": "dist",
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "declarationDir": "dist",
+    "resolveJsonModule": true
+  }
+}