@blueyerobotics/protocol-definitions 3.2.0-3e0ba702 → 3.2.0-569cf784

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.
@@ -424,12 +424,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
424
424
  type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
425
425
  [K in keyof T]?: DeepPartial<T[K]>;
426
426
  } : Partial<T>;
427
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
428
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
429
+ [K in keyof P]: Exact<P[K], I[K]>;
430
+ } & {
431
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
432
+ };
427
433
  interface MessageFns<T> {
428
434
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
429
435
  decode(input: BinaryReader | Uint8Array, length?: number): T;
430
436
  fromJSON(object: any): T;
431
437
  toJSON(message: T): unknown;
432
- create(base?: DeepPartial<T>): T;
433
- fromPartial(object: DeepPartial<T>): T;
438
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
439
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
434
440
  }
435
441
  export {};
package/dist/control.d.ts CHANGED
@@ -251,12 +251,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
251
251
  type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
252
252
  [K in keyof T]?: DeepPartial<T[K]>;
253
253
  } : Partial<T>;
254
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
255
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
256
+ [K in keyof P]: Exact<P[K], I[K]>;
257
+ } & {
258
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
259
+ };
254
260
  interface MessageFns<T> {
255
261
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
256
262
  decode(input: BinaryReader | Uint8Array, length?: number): T;
257
263
  fromJSON(object: any): T;
258
264
  toJSON(message: T): unknown;
259
- create(base?: DeepPartial<T>): T;
260
- fromPartial(object: DeepPartial<T>): T;
265
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
266
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
261
267
  }
262
268
  export {};
@@ -121,12 +121,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
121
121
  type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
122
122
  [K in keyof T]?: DeepPartial<T[K]>;
123
123
  } : Partial<T>;
124
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
125
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
126
+ [K in keyof P]: Exact<P[K], I[K]>;
127
+ } & {
128
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
129
+ };
124
130
  interface MessageFns<T> {
125
131
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
126
132
  decode(input: BinaryReader | Uint8Array, length?: number): T;
127
133
  fromJSON(object: any): T;
128
134
  toJSON(message: T): unknown;
129
- create(base?: DeepPartial<T>): T;
130
- fromPartial(object: DeepPartial<T>): T;
135
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
136
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
131
137
  }
132
138
  export {};
@@ -81,12 +81,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
81
81
  type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
82
82
  [K in keyof T]?: DeepPartial<T[K]>;
83
83
  } : Partial<T>;
84
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
85
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
86
+ [K in keyof P]: Exact<P[K], I[K]>;
87
+ } & {
88
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
89
+ };
84
90
  interface MessageFns<T> {
85
91
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
86
92
  decode(input: BinaryReader | Uint8Array, length?: number): T;
87
93
  fromJSON(object: any): T;
88
94
  toJSON(message: T): unknown;
89
- create(base?: DeepPartial<T>): T;
90
- fromPartial(object: DeepPartial<T>): T;
95
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
96
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
91
97
  }
92
98
  export {};
@@ -110,12 +110,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
110
110
  type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
111
111
  [K in keyof T]?: DeepPartial<T[K]>;
112
112
  } : Partial<T>;
113
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
114
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
115
+ [K in keyof P]: Exact<P[K], I[K]>;
116
+ } & {
117
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
118
+ };
113
119
  interface MessageFns<T> {
114
120
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
115
121
  decode(input: BinaryReader | Uint8Array, length?: number): T;
116
122
  fromJSON(object: any): T;
117
123
  toJSON(message: T): unknown;
118
- create(base?: DeepPartial<T>): T;
119
- fromPartial(object: DeepPartial<T>): T;
124
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
125
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
120
126
  }
121
127
  export {};
@@ -1835,12 +1835,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
1835
1835
  type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
1836
1836
  [K in keyof T]?: DeepPartial<T[K]>;
1837
1837
  } : Partial<T>;
1838
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
1839
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
1840
+ [K in keyof P]: Exact<P[K], I[K]>;
1841
+ } & {
1842
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
1843
+ };
1838
1844
  interface MessageFns<T> {
1839
1845
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
1840
1846
  decode(input: BinaryReader | Uint8Array, length?: number): T;
1841
1847
  fromJSON(object: any): T;
1842
1848
  toJSON(message: T): unknown;
1843
- create(base?: DeepPartial<T>): T;
1844
- fromPartial(object: DeepPartial<T>): T;
1849
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
1850
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
1845
1851
  }
1846
1852
  export {};
@@ -335,12 +335,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
335
335
  type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
336
336
  [K in keyof T]?: DeepPartial<T[K]>;
337
337
  } : Partial<T>;
338
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
339
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
340
+ [K in keyof P]: Exact<P[K], I[K]>;
341
+ } & {
342
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
343
+ };
338
344
  interface MessageFns<T> {
339
345
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
340
346
  decode(input: BinaryReader | Uint8Array, length?: number): T;
341
347
  fromJSON(object: any): T;
342
348
  toJSON(message: T): unknown;
343
- create(base?: DeepPartial<T>): T;
344
- fromPartial(object: DeepPartial<T>): T;
349
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
350
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
345
351
  }
346
352
  export {};
package/dist/req_rep.d.ts CHANGED
@@ -251,12 +251,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
251
251
  type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
252
252
  [K in keyof T]?: DeepPartial<T[K]>;
253
253
  } : Partial<T>;
254
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
255
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
256
+ [K in keyof P]: Exact<P[K], I[K]>;
257
+ } & {
258
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
259
+ };
254
260
  interface MessageFns<T> {
255
261
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
256
262
  decode(input: BinaryReader | Uint8Array, length?: number): T;
257
263
  fromJSON(object: any): T;
258
264
  toJSON(message: T): unknown;
259
- create(base?: DeepPartial<T>): T;
260
- fromPartial(object: DeepPartial<T>): T;
265
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
266
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
261
267
  }
262
268
  export {};
@@ -342,12 +342,18 @@ type Builtin = Date | Function | Uint8Array | string | number | boolean | undefi
342
342
  type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
343
343
  [K in keyof T]?: DeepPartial<T[K]>;
344
344
  } : Partial<T>;
345
+ type KeysOfUnion<T> = T extends T ? keyof T : never;
346
+ type Exact<P, I extends P> = P extends Builtin ? P : P & {
347
+ [K in keyof P]: Exact<P[K], I[K]>;
348
+ } & {
349
+ [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
350
+ };
345
351
  interface MessageFns<T> {
346
352
  encode(message: T, writer?: BinaryWriter): BinaryWriter;
347
353
  decode(input: BinaryReader | Uint8Array, length?: number): T;
348
354
  fromJSON(object: any): T;
349
355
  toJSON(message: T): unknown;
350
- create(base?: DeepPartial<T>): T;
351
- fromPartial(object: DeepPartial<T>): T;
356
+ create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
357
+ fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
352
358
  }
353
359
  export {};
package/package.json CHANGED
@@ -1,12 +1,6 @@
1
1
  {
2
2
  "name": "@blueyerobotics/protocol-definitions",
3
- "version": "3.2.0-3e0ba702",
4
- "license": "LGPL-3.0-only",
5
- "description": "TypeScript definitions for Blueye Robotics protocols",
6
- "repository": {
7
- "type": "git",
8
- "url": "https://github.com/BluEye-Robotics/ProtocolDefinitions.git"
9
- },
3
+ "version": "3.2.0-569cf784",
10
4
  "main": "dist/index.js",
11
5
  "types": "dist/index.d.ts",
12
6
  "files": ["dist"],
package/README.md DELETED
@@ -1,40 +0,0 @@
1
- # @blueyerobotics/protocol-definitions
2
-
3
- TypeScript protobuf definitions for Blueye Robotics protocols generated using [ts-proto](https://github.com/stephenh/ts-proto).
4
-
5
- ## Installation
6
-
7
- ```bash
8
- npm install @blueyerobotics/protocol-definitions
9
- ```
10
-
11
- ## Usage
12
-
13
- ```ts
14
- import { blueye } from "@blueyerobotics/protocol-definitions";
15
-
16
- // Create a new GetBatteryReq message
17
- const request = blueye.protocol.GetBatteryReq.create();
18
-
19
- // Serialize the message to a Uint8Array (binary)
20
- const binary = blueye.protocol.GetBatteryReq.encode(request).finish();
21
-
22
- // ...
23
-
24
- // For demonstration, we will simulate a response from the device
25
- const response = blueye.protocol.GetBatteryRep.create({
26
- battery: {
27
- level: 85,
28
- voltage: 12.5,
29
- temperature: 25,
30
- },
31
- });
32
-
33
- const binaryResponse = blueye.protocol.GetBatteryRep.encode(response).finish();
34
-
35
- // Decode a binary response back into a message
36
- const decoded = blueye.protocol.GetBatteryRep.decode(binaryResponse);
37
-
38
- // Access fields
39
- console.log(decoded.battery?.level);
40
- ```