@basementuniverse/jsonpad-realtime-sdk 1.0.0 → 1.2.0

package/resources/jsonpad-realtime-sdk-test/node_modules/typescript/package.json

@@ -0,0 +1,121 @@
+{
+    "name": "typescript",
+    "author": "Microsoft Corp.",
+    "homepage": "https://www.typescriptlang.org/",
+    "version": "5.6.3",
+    "license": "Apache-2.0",
+    "description": "TypeScript is a language for application scale JavaScript development",
+    "keywords": [
+        "TypeScript",
+        "Microsoft",
+        "compiler",
+        "language",
+        "javascript"
+    ],
+    "bugs": {
+        "url": "https://github.com/microsoft/TypeScript/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/microsoft/TypeScript.git"
+    },
+    "main": "./lib/typescript.js",
+    "typings": "./lib/typescript.d.ts",
+    "bin": {
+        "tsc": "./bin/tsc",
+        "tsserver": "./bin/tsserver"
+    },
+    "engines": {
+        "node": ">=14.17"
+    },
+    "files": [
+        "bin",
+        "lib",
+        "!lib/enu",
+        "LICENSE.txt",
+        "README.md",
+        "SECURITY.md",
+        "ThirdPartyNoticeText.txt",
+        "!**/.gitattributes"
+    ],
+    "devDependencies": {
+        "@dprint/formatter": "^0.4.1",
+        "@dprint/typescript": "0.91.6",
+        "@esfx/canceltoken": "^1.0.0",
+        "@eslint/js": "^9.9.0",
+        "@octokit/rest": "^21.0.1",
+        "@types/chai": "^4.3.17",
+        "@types/diff": "^5.2.1",
+        "@types/minimist": "^1.2.5",
+        "@types/mocha": "^10.0.7",
+        "@types/ms": "^0.7.34",
+        "@types/node": "latest",
+        "@types/source-map-support": "^0.5.10",
+        "@types/which": "^3.0.4",
+        "@typescript-eslint/rule-tester": "^8.1.0",
+        "@typescript-eslint/type-utils": "^8.1.0",
+        "@typescript-eslint/utils": "^8.1.0",
+        "azure-devops-node-api": "^14.0.2",
+        "c8": "^10.1.2",
+        "chai": "^4.5.0",
+        "chalk": "^4.1.2",
+        "chokidar": "^3.6.0",
+        "diff": "^5.2.0",
+        "dprint": "^0.47.2",
+        "esbuild": "^0.23.0",
+        "eslint": "^9.9.0",
+        "eslint-formatter-autolinkable-stylish": "^1.4.0",
+        "eslint-plugin-regexp": "^2.6.0",
+        "fast-xml-parser": "^4.4.1",
+        "glob": "^10.4.5",
+        "globals": "^15.9.0",
+        "hereby": "^1.9.0",
+        "jsonc-parser": "^3.3.1",
+        "knip": "^5.27.2",
+        "minimist": "^1.2.8",
+        "mocha": "^10.7.3",
+        "mocha-fivemat-progress-reporter": "^0.1.0",
+        "monocart-coverage-reports": "^2.10.2",
+        "ms": "^2.1.3",
+        "node-fetch": "^3.3.2",
+        "playwright": "^1.46.0",
+        "source-map-support": "^0.5.21",
+        "tslib": "^2.6.3",
+        "typescript": "^5.5.4",
+        "typescript-eslint": "^8.1.0",
+        "which": "^3.0.1"
+    },
+    "overrides": {
+        "typescript@*": "$typescript"
+    },
+    "scripts": {
+        "test": "hereby runtests-parallel --light=false",
+        "test:eslint-rules": "hereby run-eslint-rules-tests",
+        "build": "npm run build:compiler && npm run build:tests",
+        "build:compiler": "hereby local",
+        "build:tests": "hereby tests",
+        "build:tests:notypecheck": "hereby tests --no-typecheck",
+        "clean": "hereby clean",
+        "gulp": "hereby",
+        "lint": "hereby lint",
+        "knip": "hereby knip",
+        "format": "dprint fmt",
+        "setup-hooks": "node scripts/link-hooks.mjs"
+    },
+    "browser": {
+        "fs": false,
+        "os": false,
+        "path": false,
+        "crypto": false,
+        "buffer": false,
+        "source-map-support": false,
+        "inspector": false,
+        "perf_hooks": false
+    },
+    "packageManager": "npm@8.19.4",
+    "volta": {
+        "node": "20.1.0",
+        "npm": "8.19.4"
+    },
+    "gitHead": "d48a5cf89a62a62d6c6ed53ffa18f070d9458b85"
+}

package/resources/jsonpad-realtime-sdk-test/package-lock.json

@@ -0,0 +1,54 @@
+{
+  "name": "jsonpad-realtime-sdk-test",
+  "version": "1.0.0",
+  "lockfileVersion": 3,
+  "requires": true,
+  "packages": {
+    "": {
+      "name": "jsonpad-realtime-sdk-test",
+      "version": "1.0.0",
+      "license": "ISC",
+      "dependencies": {
+        "@basementuniverse/jsonpad-realtime-sdk": "file:../.."
+      },
+      "devDependencies": {
+        "typescript": "^5.6.3"
+      }
+    },
+    "../..": {
+      "version": "1.0.0",
+      "license": "MIT",
+      "dependencies": {
+        "socket.io-client": "^4.8.1"
+      },
+      "devDependencies": {
+        "-": "^0.0.1",
+        "@rollup/plugin-commonjs": "^28.0.1",
+        "@rollup/plugin-node-resolve": "^15.3.0",
+        "@rollup/plugin-terser": "^0.4.4",
+        "@rollup/plugin-typescript": "^12.1.1",
+        "rollup": "^4.24.3",
+        "rollup-plugin-dts": "^6.1.1",
+        "save-dev": "^0.0.1-security",
+        "tslib": "^2.8.1"
+      }
+    },
+    "node_modules/@basementuniverse/jsonpad-realtime-sdk": {
+      "resolved": "../..",
+      "link": true
+    },
+    "node_modules/typescript": {
+      "version": "5.6.3",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.6.3.tgz",
+      "integrity": "sha512-hjcS1mhfuyi4WW8IWtjP7brDrG2cuDZukyrYrSauoXGNgx0S7zceP07adYkJycEr56BOUTNPzbInooiN3fn1qw==",
+      "dev": true,
+      "bin": {
+        "tsc": "bin/tsc",
+        "tsserver": "bin/tsserver"
+      },
+      "engines": {
+        "node": ">=14.17"
+      }
+    }
+  }
+}

package/resources/jsonpad-realtime-sdk-test/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "jsonpad-realtime-sdk-test",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "build": "tsc"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@basementuniverse/jsonpad-realtime-sdk": "file:../.."
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  }
+}

package/resources/jsonpad-realtime-sdk-test/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compileOnSave": false,
+  "compilerOptions": {
+    "target": "es2019",
+    "module": "commonjs",
+    "allowJs": false,
+    "declaration": true,
+    "outDir": "./build",
+    "rootDir": "./",
+    "strict": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "strictFunctionTypes": true,
+    "strictBindCallApply": true,
+    "strictPropertyInitialization": true,
+    "noImplicitThis": true,
+    "alwaysStrict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": false,
+    "noImplicitReturns": true,
+    "esModuleInterop": true,
+    "inlineSourceMap": true,
+  },
+  "include": ["index.ts"]
+}

package/src/events/index.ts

@@ -0,0 +1,2 @@
+export * from './item-event';
+export * from './list-event';

package/src/events/item-event.ts

@@ -0,0 +1,12 @@
+import { EventDetail, Item, MessageType } from '../types';
+
+export class ItemEvent extends CustomEvent<any> {
+  constructor(messageType: MessageType, detail: EventDetail<Item>) {
+    if (detail.model.data && typeof detail.model.data === 'string') {
+      try {
+        detail.model.data = JSON.parse(detail.model.data);
+      } catch (error) {}
+    }
+    super(messageType, { detail });
+  }
+}

package/src/events/list-event.ts

@@ -0,0 +1,7 @@
+import { EventDetail, List, MessageType } from '../types';
+
+export class ListEvent extends CustomEvent<any> {
+  constructor(messageType: MessageType, detail: EventDetail<List>) {
+    super(messageType, { detail });
+  }
+}

package/src/index.ts

@@ -0,0 +1,14 @@
+import { ItemEvent, ListEvent } from './events';
+import { JSONPadRealtime } from './jsonpad-realtime';
+import { EventDetail, EventType, Item, List, MessageType } from './types';
+
+export default JSONPadRealtime;
+export {
+  EventDetail,
+  EventType,
+  Item,
+  ItemEvent,
+  List,
+  ListEvent,
+  MessageType,
+};

package/src/jsonpad-realtime.ts

@@ -1,6 +1,8 @@
 import { io, Socket } from 'socket.io-client';
 import * as constants from './constants';
-import { EventType, MessageType } from './types';
+import { ItemEvent } from './events/item-event';
+import { ListEvent } from './events/list-event';
+import { EventDetail, EventType, Item, List, MessageType } from './types';
 
 export class JSONPadRealtime extends EventTarget {
   private static readonly connected = new Event('connected');
@@ -8,6 +10,10 @@ export class JSONPadRealtime extends EventTarget {
 
   private socket: Socket | null = null;
 
+  public get connected() {
+    return this.socket?.connected ?? false;
+  }
+
   /**
    * Create a new JSONPad realtime client instance
    */
@@ -63,6 +69,10 @@ export class JSONPadRealtime extends EventTarget {
     this.socket.on('list-deleted', this.handleEvent.bind(this, 'list-deleted'));
     this.socket.on('item-created', this.handleEvent.bind(this, 'item-created'));
     this.socket.on('item-updated', this.handleEvent.bind(this, 'item-updated'));
+    this.socket.on(
+      'item-restored',
+      this.handleEvent.bind(this, 'item-restored')
+    );
     this.socket.on('item-deleted', this.handleEvent.bind(this, 'item-deleted'));
   }
 
@@ -79,7 +89,7 @@ export class JSONPadRealtime extends EventTarget {
   }
 
   private handleEvent(messageType: MessageType, data: string) {
-    let parsedData: any;
+    let parsedData: EventDetail<any>;
     try {
       parsedData = JSON.parse(data);
     } catch (error) {
@@ -87,6 +97,48 @@ export class JSONPadRealtime extends EventTarget {
       return;
     }
 
-    this.dispatchEvent(new CustomEvent(messageType, { detail: parsedData }));
+    switch (messageType) {
+      case 'list-created':
+        this.dispatchEvent(
+          new ListEvent('list-created', parsedData as EventDetail<List>)
+        );
+        break;
+
+      case 'list-updated':
+        this.dispatchEvent(
+          new ListEvent('list-updated', parsedData as EventDetail<List>)
+        );
+        break;
+
+      case 'list-deleted':
+        this.dispatchEvent(
+          new ListEvent('list-deleted', parsedData as EventDetail<List>)
+        );
+        break;
+
+      case 'item-created':
+        this.dispatchEvent(
+          new ItemEvent('item-created', parsedData as EventDetail<Item>)
+        );
+        break;
+
+      case 'item-updated':
+        this.dispatchEvent(
+          new ItemEvent('item-updated', parsedData as EventDetail<Item>)
+        );
+        break;
+
+      case 'item-restored':
+        this.dispatchEvent(
+          new ItemEvent('item-restored', parsedData as EventDetail<Item>)
+        );
+        break;
+
+      case 'item-deleted':
+        this.dispatchEvent(
+          new ItemEvent('item-deleted', parsedData as EventDetail<Item>)
+        );
+        break;
+    }
   }
 }

package/src/types/event-detail.ts

@@ -0,0 +1,5 @@
+export type EventDetail<T extends object> = {
+  listId?: string;
+  itemId?: string;
+  model: T;
+};

package/src/types/index.ts

@@ -1,2 +1,5 @@
+export * from './event-detail';
 export * from './event-type';
+export * from './item';
+export * from './list';
 export * from './message-type';

package/src/types/item.ts

@@ -0,0 +1,11 @@
+export type Item = {
+  id: string;
+  createdAt: Date;
+  updatedAt: Date;
+  data: any;
+  description: string;
+  version: string;
+  readonly: boolean;
+  activated: boolean;
+  size: number;
+};

package/src/types/list.ts

@@ -0,0 +1,25 @@
+export type List = {
+  id: string;
+  createdAt: Date;
+  updatedAt: Date;
+  user: {
+    id: string;
+    createdAt: Date;
+    updatedAt: Date;
+    lastActiveAt: Date | null;
+    activated: boolean;
+    displayName: string;
+    description: string;
+  };
+  name: string;
+  description: string;
+  pathName: string;
+  schema: any;
+  pinned: boolean;
+  readonly: boolean;
+  realtime: boolean;
+  protected: boolean;
+  indexable: boolean;
+  activated: boolean;
+  itemCount: number;
+};