@blueid/access-proto 12.8.0 → 12.10.0

package/BlueCore.proto

@@ -231,11 +231,6 @@ message BlueLocalTimeperiod {
   required uint32 minutesTo = 4 [ (nanopb).int_size = IS_8 ];
 }
 
-//message BlueTransponderId {
-//  required string id = 1 [ (nanopb).max_length = 21 ]; // Most NFC UIDs are 4, 7, or 10 bytes (not 15). When converted to hex, each byte becomes 2 hex characters → maximum 20 characters + null = 21 bytes
-//}
-
-
 enum BlueTimeUnit {
   option (nanopb_enumopt).packed_enum = true;
 
@@ -430,7 +425,6 @@ enum BlueEventInfoSystem {
 
   SystemRestart = 0x01;
   SystemConfigured = 0x2;
-  UnknownTransponderDetected= 0x3;
 
   // -- Oss So events
 
@@ -487,9 +481,6 @@ message BlueEvent {
 
   // Set if eventId =
   optional string command = 6 [ (nanopb).max_length = 8 ];
-
-   // Set if credential related
-//  optional BlueTransponderId transponderId = 7;
 }
 
 ///////////////////////////////////////////////////////////////////////
@@ -513,7 +504,7 @@ message BlueSPTokenCommand {
   required BlueLocalTimestamp validityEnd = 3;
   required string command = 4 [ (nanopb).max_length = 8 ];
   required bytes data = 5
-      [ (nanopb).max_size = 8216 ]; // we'll add 256b for add. data. The normal data for UUZ device would be 1792 however Nexus device will use 8216 buffer
+      [ (nanopb).max_size = 1792 ]; // we'll add 256b for add. data
 }
 
 message BlueSPToken {
@@ -531,6 +522,43 @@ message BlueSPResult {
       [ (nanopb).max_size = 1792 ]; // we'll add 256b for add. data
 }
 
+///////////////////////////////////////////////////////////////////////
+// Secure Protocol over WebSocket
+///////////////////////////////////////////////////////////////////////
+
+message BlueWebSPHandshake {
+  required bytes salt = 1
+      [ (nanopb).max_size = 16, (nanopb).fixed_length = true ];
+}
+
+message BlueWebSPHandshakeReply {
+  required string deviceId = 1 [ (nanopb).max_length = 8 ];
+  required bytes signature = 2 [ (nanopb).max_size = 74 ];
+}
+
+message BlueWebSPMessage {
+  required uint32 transactionId = 1 [ (nanopb).int_size = IS_8 ];
+  required BlueSPResult payload = 2;
+}
+
+// Message sent by the server to the device
+message BlueWebSPServerMessage {
+  oneof payload {
+    BlueWebSPHandshake handshake = 2;
+    BlueSPTokenCommand command = 3;
+    BlueOssSoMobile ossSo = 4;
+    BlueOssSidMobile ossSid = 5;
+  }
+}
+
+message BlueWebSPClientMessage {
+  // TODO: payload
+}
+
+message BlueWebSPStatusMessage {
+  required BlueReturnCode status = 1;
+}
+
 
 ///////////////////////////////////////////////////////////////////////
 // Oss shared types
@@ -972,4 +1000,4 @@ message _BlueTestEncodeDecode {
   required string hardware_name = 2 [ (nanopb).max_length = 32 ];
   required int32 hardware_version = 3;
   required int32 application_version = 4;
-}
+}

package/BlueSystem.proto

@@ -140,9 +140,6 @@ message BlueOssConfig {
   // The mifare application id for the oss offline application, default is the
   // oss so default aid. A value of 0 disables Oss So Mifare support.
   required uint32 soMifareAid = 8 [ default = 16076800 ];
-
-  // The card will request to refresh if the existing days passed. It can become required after stable
-  optional uint32 minRefreshDays = 9 [ default = 5, (nanopb).int_size = IS_8 ];
 }
 
 message BlueSystemAVRInfo {
@@ -230,15 +227,6 @@ message BlueSystemStatus {
   optional uint32 applicationVersionTest = 10;
 }
 
-enum BlueNetworkType {
-  option (nanopb_enumopt).packed_enum = true;
-
-  None = 1;
-  Ethernet = 2;
-  Wifi = 3;
-  Gsm = 4;
-}
-
 ///////////////////////////////////////////////////////////////////////
 // System Log
 ///////////////////////////////////////////////////////////////////////
@@ -293,4 +281,4 @@ message BlueEventLogResult {
 
 message BlueBlacklistEntries {
   repeated BlueBlacklistEntry entries = 1 [ (nanopb).max_count = 75 ];
-}
+}

package/cjs/BlueCore_pb.d.ts

@@ -981,11 +981,6 @@ export declare enum BlueEventInfoSystem {
    * @generated from enum value: SystemConfigured = 2;
    */
   SystemConfigured = 2,
-
-  /**
-   * @generated from enum value: UnknownTransponderDetected = 3;
-   */
-  UnknownTransponderDetected = 3,
 }
 
 /**
@@ -1658,7 +1653,7 @@ export declare class BlueSPTokenCommand extends Message<BlueSPTokenCommand> {
   command: string;
 
   /**
-   * we'll add 256b for add. data. The normal data for UUZ device would be 1792 however Nexus device will use 8216 buffer
+   * we'll add 256b for add. data
    *
    * @generated from field: required bytes data = 5;
    */
@@ -1752,6 +1747,183 @@ export declare class BlueSPResult extends Message<BlueSPResult> {
   static equals(a: BlueSPResult | PlainMessage<BlueSPResult> | undefined, b: BlueSPResult | PlainMessage<BlueSPResult> | undefined): boolean;
 }
 
+/**
+ * @generated from message BlueWebSPHandshake
+ */
+export declare class BlueWebSPHandshake extends Message<BlueWebSPHandshake> {
+  /**
+   * @generated from field: required bytes salt = 1;
+   */
+  salt: Uint8Array;
+
+  constructor(data?: PartialMessage<BlueWebSPHandshake>);
+
+  static readonly runtime: typeof proto2;
+  static readonly typeName = "BlueWebSPHandshake";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): BlueWebSPHandshake;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): BlueWebSPHandshake;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): BlueWebSPHandshake;
+
+  static equals(a: BlueWebSPHandshake | PlainMessage<BlueWebSPHandshake> | undefined, b: BlueWebSPHandshake | PlainMessage<BlueWebSPHandshake> | undefined): boolean;
+}
+
+/**
+ * @generated from message BlueWebSPHandshakeReply
+ */
+export declare class BlueWebSPHandshakeReply extends Message<BlueWebSPHandshakeReply> {
+  /**
+   * @generated from field: required string deviceId = 1;
+   */
+  deviceId: string;
+
+  /**
+   * @generated from field: required bytes signature = 2;
+   */
+  signature: Uint8Array;
+
+  constructor(data?: PartialMessage<BlueWebSPHandshakeReply>);
+
+  static readonly runtime: typeof proto2;
+  static readonly typeName = "BlueWebSPHandshakeReply";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): BlueWebSPHandshakeReply;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): BlueWebSPHandshakeReply;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): BlueWebSPHandshakeReply;
+
+  static equals(a: BlueWebSPHandshakeReply | PlainMessage<BlueWebSPHandshakeReply> | undefined, b: BlueWebSPHandshakeReply | PlainMessage<BlueWebSPHandshakeReply> | undefined): boolean;
+}
+
+/**
+ * @generated from message BlueWebSPMessage
+ */
+export declare class BlueWebSPMessage extends Message<BlueWebSPMessage> {
+  /**
+   * @generated from field: required uint32 transactionId = 1;
+   */
+  transactionId: number;
+
+  /**
+   * @generated from field: required BlueSPResult payload = 2;
+   */
+  payload?: BlueSPResult;
+
+  constructor(data?: PartialMessage<BlueWebSPMessage>);
+
+  static readonly runtime: typeof proto2;
+  static readonly typeName = "BlueWebSPMessage";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): BlueWebSPMessage;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): BlueWebSPMessage;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): BlueWebSPMessage;
+
+  static equals(a: BlueWebSPMessage | PlainMessage<BlueWebSPMessage> | undefined, b: BlueWebSPMessage | PlainMessage<BlueWebSPMessage> | undefined): boolean;
+}
+
+/**
+ * Message sent by the server to the device
+ *
+ * @generated from message BlueWebSPServerMessage
+ */
+export declare class BlueWebSPServerMessage extends Message<BlueWebSPServerMessage> {
+  /**
+   * @generated from oneof BlueWebSPServerMessage.payload
+   */
+  payload: {
+    /**
+     * @generated from field: BlueWebSPHandshake handshake = 2;
+     */
+    value: BlueWebSPHandshake;
+    case: "handshake";
+  } | {
+    /**
+     * @generated from field: BlueSPTokenCommand command = 3;
+     */
+    value: BlueSPTokenCommand;
+    case: "command";
+  } | {
+    /**
+     * @generated from field: BlueOssSoMobile ossSo = 4;
+     */
+    value: BlueOssSoMobile;
+    case: "ossSo";
+  } | {
+    /**
+     * @generated from field: BlueOssSidMobile ossSid = 5;
+     */
+    value: BlueOssSidMobile;
+    case: "ossSid";
+  } | { case: undefined; value?: undefined };
+
+  constructor(data?: PartialMessage<BlueWebSPServerMessage>);
+
+  static readonly runtime: typeof proto2;
+  static readonly typeName = "BlueWebSPServerMessage";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): BlueWebSPServerMessage;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): BlueWebSPServerMessage;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): BlueWebSPServerMessage;
+
+  static equals(a: BlueWebSPServerMessage | PlainMessage<BlueWebSPServerMessage> | undefined, b: BlueWebSPServerMessage | PlainMessage<BlueWebSPServerMessage> | undefined): boolean;
+}
+
+/**
+ * TODO: payload
+ *
+ * @generated from message BlueWebSPClientMessage
+ */
+export declare class BlueWebSPClientMessage extends Message<BlueWebSPClientMessage> {
+  constructor(data?: PartialMessage<BlueWebSPClientMessage>);
+
+  static readonly runtime: typeof proto2;
+  static readonly typeName = "BlueWebSPClientMessage";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): BlueWebSPClientMessage;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): BlueWebSPClientMessage;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): BlueWebSPClientMessage;
+
+  static equals(a: BlueWebSPClientMessage | PlainMessage<BlueWebSPClientMessage> | undefined, b: BlueWebSPClientMessage | PlainMessage<BlueWebSPClientMessage> | undefined): boolean;
+}
+
+/**
+ * @generated from message BlueWebSPStatusMessage
+ */
+export declare class BlueWebSPStatusMessage extends Message<BlueWebSPStatusMessage> {
+  /**
+   * @generated from field: required BlueReturnCode status = 1;
+   */
+  status: BlueReturnCode;
+
+  constructor(data?: PartialMessage<BlueWebSPStatusMessage>);
+
+  static readonly runtime: typeof proto2;
+  static readonly typeName = "BlueWebSPStatusMessage";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): BlueWebSPStatusMessage;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): BlueWebSPStatusMessage;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): BlueWebSPStatusMessage;
+
+  static equals(a: BlueWebSPStatusMessage | PlainMessage<BlueWebSPStatusMessage> | undefined, b: BlueWebSPStatusMessage | PlainMessage<BlueWebSPStatusMessage> | undefined): boolean;
+}
+
 /**
  * @generated from message BlueOssAccessResult
  */

package/cjs/BlueCore_pb.js

@@ -88,6 +88,12 @@ __export(BlueCore_pb_exports, {
   BlueTimeUnit: () => BlueTimeUnit,
   BlueTransponderType: () => BlueTransponderType,
   BlueVersionInfo: () => BlueVersionInfo,
+  BlueWebSPClientMessage: () => BlueWebSPClientMessage,
+  BlueWebSPHandshake: () => BlueWebSPHandshake,
+  BlueWebSPHandshakeReply: () => BlueWebSPHandshakeReply,
+  BlueWebSPMessage: () => BlueWebSPMessage,
+  BlueWebSPServerMessage: () => BlueWebSPServerMessage,
+  BlueWebSPStatusMessage: () => BlueWebSPStatusMessage,
   BlueWeekday: () => BlueWeekday,
   _BlueTestEncodeDecode: () => _BlueTestEncodeDecode
 });
@@ -310,8 +316,7 @@ const BlueEventInfoSystem = import_protobuf.proto2.makeEnum(
   "BlueEventInfoSystem",
   [
     { no: 1, name: "SystemRestart" },
-    { no: 2, name: "SystemConfigured" },
-    { no: 3, name: "UnknownTransponderDetected" }
+    { no: 2, name: "SystemConfigured" }
   ]
 );
 const BlueEventInfoAccess = import_protobuf.proto2.makeEnum(
@@ -685,6 +690,69 @@ const BlueSPResult = import_protobuf.proto2.makeMessageType(
     }
   ]
 );
+const BlueWebSPHandshake = import_protobuf.proto2.makeMessageType(
+  "BlueWebSPHandshake",
+  () => [
+    {
+      no: 1,
+      name: "salt",
+      kind: "scalar",
+      T: 12
+      /* ScalarType.BYTES */
+    }
+  ]
+);
+const BlueWebSPHandshakeReply = import_protobuf.proto2.makeMessageType(
+  "BlueWebSPHandshakeReply",
+  () => [
+    {
+      no: 1,
+      name: "deviceId",
+      kind: "scalar",
+      T: 9
+      /* ScalarType.STRING */
+    },
+    {
+      no: 2,
+      name: "signature",
+      kind: "scalar",
+      T: 12
+      /* ScalarType.BYTES */
+    }
+  ]
+);
+const BlueWebSPMessage = import_protobuf.proto2.makeMessageType(
+  "BlueWebSPMessage",
+  () => [
+    {
+      no: 1,
+      name: "transactionId",
+      kind: "scalar",
+      T: 13
+      /* ScalarType.UINT32 */
+    },
+    { no: 2, name: "payload", kind: "message", T: BlueSPResult }
+  ]
+);
+const BlueWebSPServerMessage = import_protobuf.proto2.makeMessageType(
+  "BlueWebSPServerMessage",
+  () => [
+    { no: 2, name: "handshake", kind: "message", T: BlueWebSPHandshake, oneof: "payload" },
+    { no: 3, name: "command", kind: "message", T: BlueSPTokenCommand, oneof: "payload" },
+    { no: 4, name: "ossSo", kind: "message", T: BlueOssSoMobile, oneof: "payload" },
+    { no: 5, name: "ossSid", kind: "message", T: BlueOssSidMobile, oneof: "payload" }
+  ]
+);
+const BlueWebSPClientMessage = import_protobuf.proto2.makeMessageType(
+  "BlueWebSPClientMessage",
+  []
+);
+const BlueWebSPStatusMessage = import_protobuf.proto2.makeMessageType(
+  "BlueWebSPStatusMessage",
+  () => [
+    { no: 1, name: "status", kind: "enum", T: import_protobuf.proto2.getEnumType(BlueReturnCode) }
+  ]
+);
 const BlueOssAccessResult = import_protobuf.proto2.makeMessageType(
   "BlueOssAccessResult",
   () => [

package/cjs/BlueSystem_pb.d.ts

@@ -8,31 +8,6 @@ import { Message, proto2 } from "@bufbuild/protobuf";
 import type { BlueBatteryLevel, BlueBlacklistEntry, BlueEvent, BlueHardwareType, BlueLocalTimeSchedule, BlueLocalTimestamp } from "./BlueCore_pb.js";
 import type { BlueLockConfig, BlueLockStatus } from "./BlueLock_pb.js";
 
-/**
- * @generated from enum BlueNetworkType
- */
-export declare enum BlueNetworkType {
-  /**
-   * @generated from enum value: None = 1;
-   */
-  None = 1,
-
-  /**
-   * @generated from enum value: Ethernet = 2;
-   */
-  Ethernet = 2,
-
-  /**
-   * @generated from enum value: Wifi = 3;
-   */
-  Wifi = 3,
-
-  /**
-   * @generated from enum value: Gsm = 4;
-   */
-  Gsm = 4,
-}
-
 /**
  * @generated from message BlueBaseConfig
  */
@@ -350,13 +325,6 @@ export declare class BlueOssConfig extends Message<BlueOssConfig> {
    */
   soMifareAid: number;
 
-  /**
-   * The card will request to refresh if the existing days passed. It can become required after stable
-   *
-   * @generated from field: optional uint32 minRefreshDays = 9 [default = 5];
-   */
-  minRefreshDays?: number;
-
   constructor(data?: PartialMessage<BlueOssConfig>);
 
   static readonly runtime: typeof proto2;

package/cjs/BlueSystem_pb.js

@@ -24,7 +24,6 @@ __export(BlueSystem_pb_exports, {
   BlueBleConfig: () => BlueBleConfig,
   BlueEventLogQuery: () => BlueEventLogQuery,
   BlueEventLogResult: () => BlueEventLogResult,
-  BlueNetworkType: () => BlueNetworkType,
   BlueOnlineConfig: () => BlueOnlineConfig,
   BlueOssConfig: () => BlueOssConfig,
   BlueSystemAVRInfo: () => BlueSystemAVRInfo,
@@ -42,15 +41,6 @@ module.exports = __toCommonJS(BlueSystem_pb_exports);
 var import_protobuf = require("@bufbuild/protobuf");
 var import_BlueCore_pb = require("./BlueCore_pb.js");
 var import_BlueLock_pb = require("./BlueLock_pb.js");
-const BlueNetworkType = import_protobuf.proto2.makeEnum(
-  "BlueNetworkType",
-  [
-    { no: 1, name: "None" },
-    { no: 2, name: "Ethernet" },
-    { no: 3, name: "Wifi" },
-    { no: 4, name: "Gsm" }
-  ]
-);
 const BlueBaseConfig = import_protobuf.proto2.makeMessageType(
   "BlueBaseConfig",
   () => [
@@ -144,8 +134,7 @@ const BlueOssConfig = import_protobuf.proto2.makeMessageType(
     { no: 5, name: "soWritePendingEvents", kind: "scalar", T: 8, default: true },
     { no: 6, name: "soUpdateFromBlacklist", kind: "scalar", T: 8, default: true },
     { no: 7, name: "soMifareAesKey", kind: "scalar", T: 12, default: new Uint8Array([16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31]) },
-    { no: 8, name: "soMifareAid", kind: "scalar", T: 13, default: 16076800 },
-    { no: 9, name: "minRefreshDays", kind: "scalar", T: 13, opt: true, default: 5 }
+    { no: 8, name: "soMifareAid", kind: "scalar", T: 13, default: 16076800 }
   ]
 );
 const BlueSystemAVRInfo = import_protobuf.proto2.makeMessageType(

package/cjs/index.d.ts

@@ -1,6 +1,5 @@
 export * from "./BlueCore_pb"
 export * from "./BlueLock_pb"
-export * from "./BlueNetworkCore_pb"
 export * from "./BlueSDK_pb"
 export * from "./BlueSystem_pb"
 

package/cjs/index.js

@@ -16,6 +16,5 @@ var es_exports = {};
 module.exports = __toCommonJS(es_exports);
 __reExport(es_exports, require("./BlueCore_pb.js"), module.exports);
 __reExport(es_exports, require("./BlueLock_pb.js"), module.exports);
-__reExport(es_exports, require("./BlueNetworkCore_pb.js"), module.exports);
 __reExport(es_exports, require("./BlueSDK_pb.js"), module.exports);
 __reExport(es_exports, require("./BlueSystem_pb.js"), module.exports);