@hcikn/colibri 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +117 -0
  2. package/dist/index.cjs +596 -0
  3. package/dist/index.cjs.map +1 -0
  4. package/dist/index.d.cts +105 -0
  5. package/dist/index.d.ts +105 -0
  6. package/dist/index.js +507 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +42 -0
package/dist/index.d.cts ADDED
@@ -0,0 +1,105 @@
1
+ import * as rxjs from 'rxjs';
2
+ import { Subject, Observable } from 'rxjs';
3
+
4
+ declare const Colibri: {
5
+ init: (app: string, server?: string) => void;
6
+ };
7
+
8
+ type genericCallback = (val: any) => void;
9
+ declare const Sync: {
10
+ sendBool: (channel: string, val: boolean) => void;
11
+ sendBoolArray: (channel: string, val: boolean[]) => void;
12
+ sendNumber: (channel: string, val: number) => void;
13
+ sendNumberArray: (channel: string, val: number[]) => void;
14
+ sendString: (channel: string, val: string) => void;
15
+ sendStringArray: (channel: string, val: string[]) => void;
16
+ sendVector3: (channel: string, val: [number, number, number]) => void;
17
+ sendVector3Array: (channel: string, val: [
18
+ number,
19
+ number,
20
+ number
21
+ ][]) => void;
22
+ sendQuaternion: (channel: string, val: [number, number, number, number]) => void;
23
+ sendQuaternionArray: (channel: string, val: [
24
+ number,
25
+ number,
26
+ number,
27
+ number
28
+ ][]) => void;
29
+ sendColor: (channel: string, val: [number, number, number, number]) => void;
30
+ sendColorArray: (channel: string, val: [
31
+ number,
32
+ number,
33
+ number,
34
+ number
35
+ ][]) => void;
36
+ sendJson: (channel: string, val: {
37
+ [key: string]: unknown;
38
+ }) => void;
39
+ receiveBool: (channel: string, callback: (val: boolean) => void) => void;
40
+ receiveBoolArray: (channel: string, callback: (val: boolean[]) => void) => void;
41
+ receiveNumber: (channel: string, callback: (val: number) => void) => void;
42
+ receiveNumberArray: (channel: string, callback: (val: number[]) => void) => void;
43
+ receiveString: (channel: string, callback: (val: string) => void) => void;
44
+ receiveStringArray: (channel: string, callback: (val: string[]) => void) => void;
45
+ receiveVector3: (channel: string, callback: (val: [number, number, number]) => void) => void;
46
+ receiveVector3Array: (channel: string, callback: (val: [
47
+ number,
48
+ number,
49
+ number
50
+ ][]) => void) => void;
51
+ receiveQuaternion: (channel: string, callback: (val: [number, number, number, number]) => void) => void;
52
+ receiveQuaternionArray: (channel: string, callback: (val: [
53
+ number,
54
+ number,
55
+ number,
56
+ number
57
+ ][]) => void) => void;
58
+ receiveColor: (channel: string, callback: (val: string) => void) => void;
59
+ receiveColorArray: (channel: string, callback: (val: string[]) => void) => void;
60
+ receiveJson: (channel: string, callback: (val: {
61
+ [key: string]: unknown;
62
+ }) => void) => void;
63
+ unregister: (channel: string, callback: genericCallback) => void;
64
+ sendFloat: (channel: string, val: number) => void;
65
+ sendInt: (channel: string, val: number) => void;
66
+ sendFloatArray: (channel: string, val: number[]) => void;
67
+ sendIntArray: (channel: string, val: number[]) => void;
68
+ };
69
+
70
+ declare const RemoteLogger: {
71
+ init: () => void;
72
+ };
73
+
74
+ declare abstract class SyncModel<T> {
75
+ readonly id: string;
76
+ private syncedProperties;
77
+ ignoreNextChange: boolean;
78
+ readonly modelChanges: Subject<string>;
79
+ readonly modelChanges$: rxjs.Observable<string[]>;
80
+ constructor(id: string);
81
+ private uniq;
82
+ protected onModelChanges(prop: string): void;
83
+ delete(): void;
84
+ registerSyncedProperty(name: string, prop: string | symbol): void;
85
+ update(updates: Partial<T>): void;
86
+ toJson(attributes?: string[]): Partial<T>;
87
+ }
88
+
89
+ interface ModelSyncRegistration<T> {
90
+ name?: string;
91
+ type: {
92
+ new (id: string): T;
93
+ };
94
+ }
95
+ type ModelSync<T> = [Observable<T[]>, (model: T) => void];
96
+ declare const RegisterModelSync: <T extends SyncModel<T>>(registration: ModelSyncRegistration<T>) => ModelSync<T>;
97
+
98
+ /**
99
+ * This decorator can be attached to any property or accessor of a SyncModel.
100
+ * It will cause the property to be synchronized with the server.
101
+ * Refer to https://www.typescriptlang.org/docs/handbook/decorators.html
102
+ */
103
+ declare const Synced: <T>(syncedName?: string) => PropertyDecorator;
104
+
105
+ export { Colibri, RegisterModelSync, RemoteLogger, Sync, SyncModel, Synced };
package/dist/index.d.ts ADDED
@@ -0,0 +1,105 @@
1
+ import * as rxjs from 'rxjs';
2
+ import { Subject, Observable } from 'rxjs';
3
+
4
+ declare const Colibri: {
5
+ init: (app: string, server?: string) => void;
6
+ };
7
+
8
+ type genericCallback = (val: any) => void;
9
+ declare const Sync: {
10
+ sendBool: (channel: string, val: boolean) => void;
11
+ sendBoolArray: (channel: string, val: boolean[]) => void;
12
+ sendNumber: (channel: string, val: number) => void;
13
+ sendNumberArray: (channel: string, val: number[]) => void;
14
+ sendString: (channel: string, val: string) => void;
15
+ sendStringArray: (channel: string, val: string[]) => void;
16
+ sendVector3: (channel: string, val: [number, number, number]) => void;
17
+ sendVector3Array: (channel: string, val: [
18
+ number,
19
+ number,
20
+ number
21
+ ][]) => void;
22
+ sendQuaternion: (channel: string, val: [number, number, number, number]) => void;
23
+ sendQuaternionArray: (channel: string, val: [
24
+ number,
25
+ number,
26
+ number,
27
+ number
28
+ ][]) => void;
29
+ sendColor: (channel: string, val: [number, number, number, number]) => void;
30
+ sendColorArray: (channel: string, val: [
31
+ number,
32
+ number,
33
+ number,
34
+ number
35
+ ][]) => void;
36
+ sendJson: (channel: string, val: {
37
+ [key: string]: unknown;
38
+ }) => void;
39
+ receiveBool: (channel: string, callback: (val: boolean) => void) => void;
40
+ receiveBoolArray: (channel: string, callback: (val: boolean[]) => void) => void;
41
+ receiveNumber: (channel: string, callback: (val: number) => void) => void;
42
+ receiveNumberArray: (channel: string, callback: (val: number[]) => void) => void;
43
+ receiveString: (channel: string, callback: (val: string) => void) => void;
44
+ receiveStringArray: (channel: string, callback: (val: string[]) => void) => void;
45
+ receiveVector3: (channel: string, callback: (val: [number, number, number]) => void) => void;
46
+ receiveVector3Array: (channel: string, callback: (val: [
47
+ number,
48
+ number,
49
+ number
50
+ ][]) => void) => void;
51
+ receiveQuaternion: (channel: string, callback: (val: [number, number, number, number]) => void) => void;
52
+ receiveQuaternionArray: (channel: string, callback: (val: [
53
+ number,
54
+ number,
55
+ number,
56
+ number
57
+ ][]) => void) => void;
58
+ receiveColor: (channel: string, callback: (val: string) => void) => void;
59
+ receiveColorArray: (channel: string, callback: (val: string[]) => void) => void;
60
+ receiveJson: (channel: string, callback: (val: {
61
+ [key: string]: unknown;
62
+ }) => void) => void;
63
+ unregister: (channel: string, callback: genericCallback) => void;
64
+ sendFloat: (channel: string, val: number) => void;
65
+ sendInt: (channel: string, val: number) => void;
66
+ sendFloatArray: (channel: string, val: number[]) => void;
67
+ sendIntArray: (channel: string, val: number[]) => void;
68
+ };
69
+
70
+ declare const RemoteLogger: {
71
+ init: () => void;
72
+ };
73
+
74
+ declare abstract class SyncModel<T> {
75
+ readonly id: string;
76
+ private syncedProperties;
77
+ ignoreNextChange: boolean;
78
+ readonly modelChanges: Subject<string>;
79
+ readonly modelChanges$: rxjs.Observable<string[]>;
80
+ constructor(id: string);
81
+ private uniq;
82
+ protected onModelChanges(prop: string): void;
83
+ delete(): void;
84
+ registerSyncedProperty(name: string, prop: string | symbol): void;
85
+ update(updates: Partial<T>): void;
86
+ toJson(attributes?: string[]): Partial<T>;
87
+ }
88
+
89
+ interface ModelSyncRegistration<T> {
90
+ name?: string;
91
+ type: {
92
+ new (id: string): T;
93
+ };
94
+ }
95
+ type ModelSync<T> = [Observable<T[]>, (model: T) => void];
96
+ declare const RegisterModelSync: <T extends SyncModel<T>>(registration: ModelSyncRegistration<T>) => ModelSync<T>;
97
+
98
+ /**
99
+ * This decorator can be attached to any property or accessor of a SyncModel.
100
+ * It will cause the property to be synchronized with the server.
101
+ * Refer to https://www.typescriptlang.org/docs/handbook/decorators.html
102
+ */
103
+ declare const Synced: <T>(syncedName?: string) => PropertyDecorator;
104
+
105
+ export { Colibri, RegisterModelSync, RemoteLogger, Sync, SyncModel, Synced };