@arcanejs/protocol 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Sam Lanning
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# `@arcanejs/diff`
+
+[![NPM Version](https://img.shields.io/npm/v/%40arcanejs%2Fdiff)](https://www.npmjs.com/package/@arcanejs/diff)
+
+This package provides an easy way to:
+
+- Create diffs by comparing objects
+- Update objects by applying diffs
+
+This library is written in TypeScript,
+and produces diffs that are type-safe,
+and can only be applied to objects that match the type
+of the objects being compared.
+
+This package is part of the
+[`arcanejs` project](https://github.com/arcanejs/arcanejs#arcanejs),
+and is used to maintain a copy of a JSON tree in downstream clients in real-time
+via websockets.
+
+## Usage
+
+```ts
+import { diffJson, Diff } from '@arcanejs/diff/diff';
+import { patchJson } from '@arcanejs/diff/patch';
+
+type E = {
+  foo: string;
+  bar?: number[];
+};
+
+const a: E = { foo: 'bar' };
+const b: E = { foo: 'baz', bar: [1] };
+
+const diffA: Diff<E> = diffJson(a, b);
+
+const resultA = patchJson(a, diffA);
+
+console.log(resultB); // { foo: 'baz', bar: [1] }
+
+const c = { baz: 'foo' };
+
+const resultB = patchJson(c, diffA); // TypeScript Type Error: Property 'baz' is missing in type '{ foo: string; bar?: number[] | undefined; }' but required in type '{ baz: string; }'
+```

package/dist/index.d.ts

@@ -0,0 +1,124 @@
+import { Diff } from '@arcanejs/diff';
+import { GroupComponentStyle } from './styles';
+type BaseComponent = {
+    key: number;
+};
+export type ButtonComponent = BaseComponent & {
+    component: 'button';
+    text: string;
+    icon?: string;
+    state: {
+        state: 'normal' | 'pressed';
+    } | {
+        state: 'error';
+        error: string;
+    };
+};
+export type GroupCollapsedState = 'open' | 'closed';
+export type DefaultGroupCollapsedState = GroupCollapsedState | 'auto';
+export type GroupHeaderComponent = BaseComponent & {
+    component: 'group-header';
+    children: Component[];
+};
+export type GroupComponent = BaseComponent & GroupComponentStyle & {
+    component: 'group';
+    title?: string;
+    children: Component[];
+    headers?: GroupHeaderComponent[];
+    labels?: Array<{
+        text: string;
+    }>;
+    editableTitle: boolean;
+    /**
+     * If set, allows the group to be collapsed,
+     * by default set to the given state
+     */
+    defaultCollapsibleState?: DefaultGroupCollapsedState;
+};
+export type LabelComponent = BaseComponent & {
+    component: 'label';
+    bold?: boolean;
+    text: string;
+};
+export type RectComponent = BaseComponent & {
+    component: 'rect';
+    color: string;
+};
+export type SliderButtonComponent = BaseComponent & {
+    component: 'slider_button';
+    min: number;
+    max: number;
+    step: number;
+    value: number | null;
+};
+export type SwitchComponent = BaseComponent & {
+    component: 'switch';
+    state: 'on' | 'off';
+};
+export type TabComponent = BaseComponent & {
+    component: 'tab';
+    name: string;
+    child?: Component;
+};
+export type TabsComponent = BaseComponent & {
+    component: 'tabs';
+    tabs: TabComponent[];
+};
+export type TextInputComponent = BaseComponent & {
+    component: 'text-input';
+    value: string;
+};
+export type TimelineState = {
+    state: 'playing';
+    totalTimeMillis: number;
+    effectiveStartTime: number;
+    speed: number;
+} | {
+    state: 'stopped';
+    totalTimeMillis: number;
+    currentTimeMillis: number;
+};
+export type TimelineComponent = BaseComponent & {
+    component: 'timeline';
+    state: TimelineState;
+    title?: string;
+    subtitles?: string[];
+    source?: {
+        name: string;
+    };
+};
+export type Component = ButtonComponent | GroupHeaderComponent | GroupComponent | LabelComponent | RectComponent | SliderButtonComponent | SwitchComponent | TabComponent | TabsComponent | TextInputComponent | TimelineComponent;
+export type SendTreeMsg = {
+    type: 'tree-full';
+    root: GroupComponent;
+};
+export type UpdateTreeMsg = {
+    type: 'tree-diff';
+    diff: Diff<GroupComponent>;
+};
+export type ServerMessage = SendTreeMsg | UpdateTreeMsg;
+export type BaseClientComponentMessage = {
+    type: 'component-message';
+    componentKey: number;
+};
+export type ButtonPressMessage = BaseClientComponentMessage & {
+    component: 'button';
+};
+export type GroupTitleChangeMessage = BaseClientComponentMessage & {
+    component: 'group';
+    title: string;
+};
+export type SliderButtonUpdateMessage = BaseClientComponentMessage & {
+    component: 'slider_button';
+    value: number;
+};
+export type SwitchToggleMessage = BaseClientComponentMessage & {
+    component: 'switch';
+};
+export type TextInputUpdateMessage = BaseClientComponentMessage & {
+    component: 'text-input';
+    value: string;
+};
+export type ClientComponentMessage = ButtonPressMessage | GroupTitleChangeMessage | SliderButtonUpdateMessage | SwitchToggleMessage | TextInputUpdateMessage;
+export type ClientMessage = ClientComponentMessage;
+export {};

package/dist/styles.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Styling options for the [[Group]] component
+ *
+ * Default Styling: [[GROUP_DEFAULT_STYLE]]
+ */
+export type GroupComponentStyle = {
+    /**
+     * In which way should child components of this group be organized?
+     */
+    direction: 'horizontal' | 'vertical';
+    /**
+     * If true, when the group runs out of vertical or horizontal space, child
+     * components will be wrapped, and start to be arranged on additional columns
+     * or rows.
+     */
+    wrap?: boolean;
+    /**
+     * If true, this group will have a border and a different color background
+     * to its parent.
+     *
+     * This allows you to add a distinctive border between components,
+     * without needing to set a header, add header components,
+     * or make it collapsible.
+     */
+    border?: true;
+};
+/**
+ * Styling options for the [[Label]] component
+ *
+ * Default Styling: [[LABEL_DEFAULT_STYLE]]
+ */
+export type LabelComponentStyle = {
+    /**
+     * If true, make the text of this label bold
+     */
+    bold?: boolean;
+};

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@arcanejs/protocol",
+  "version": "0.1.1",
+  "private": false,
+  "description": "The JSON protocol types for the @arcanejs Toolkit",
+  "license": "MIT",
+  "author": {
+    "name": "Sam Lanning",
+    "url": "https://samlanning.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/arcanejs/arcanejs.git"
+  },
+  "exports": {
+    ".": {
+      "@arcanejs/source": "./src/index.ts",
+      "types": "./dist/index.d.ts"
+    },
+    "./styles": {
+      "@arcanejs/source": "./src/styles.ts",
+      "types": "./dist/styles.d.ts"
+    }
+  },
+  "devDependencies": {
+    "@types/eslint": "^8.56.5",
+    "@types/jest": "^29.5.12",
+    "eslint": "^8.57.0",
+    "typescript": "^5.3.3",
+    "@arcanejs/diff": "^0.3.1",
+    "@arcanejs/typescript-config": "^0.0.0",
+    "@arcanejs/eslint-config": "^0.0.0"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "lint": "eslint . --max-warnings 0",
+    "build": "rm -rf dist && tsc"
+  }
+}