@dxos/credentials 2.33.1-dev.0a5ae2e2 → 2.33.1-dev.376de34c

package/src/greet/greeting-message.ts

@@ -10,11 +10,11 @@ const TYPE_URL_GREETING_COMMAND = 'dxos.credentials.greet.Command';
 
 /**
  * Create a Greeting 'BEGIN' command message.
- * @returns {{__type_url: string, command: *}}
+ * @returns {{'@type': string, command: *}}
  */
 export const createGreetingBeginMessage = (): WithTypeUrl<Command> => {
   return {
-    __type_url: TYPE_URL_GREETING_COMMAND,
+    '@type': TYPE_URL_GREETING_COMMAND,
     command: Command.Type.BEGIN,
     params: []
   };
@@ -28,7 +28,7 @@ export const createGreetingHandshakeMessage = (secret: Buffer, params = []): Wit
   assert(Array.isArray(params));
 
   return {
-    __type_url: TYPE_URL_GREETING_COMMAND,
+    '@type': TYPE_URL_GREETING_COMMAND,
     command: Command.Type.HANDSHAKE,
     params,
     secret
@@ -43,7 +43,7 @@ export const createGreetingNotarizeMessage = (secret: Buffer, credentialMessages
   assert(Array.isArray(credentialMessages));
 
   return {
-    __type_url: TYPE_URL_GREETING_COMMAND,
+    '@type': TYPE_URL_GREETING_COMMAND,
     command: Command.Type.NOTARIZE,
     params: credentialMessages,
     secret
@@ -57,7 +57,7 @@ export const createGreetingFinishMessage = (secret: Buffer): WithTypeUrl<Command
   assert(Buffer.isBuffer(secret), 'Secret is not a buffer.');
 
   return {
-    __type_url: TYPE_URL_GREETING_COMMAND,
+    '@type': TYPE_URL_GREETING_COMMAND,
     command: Command.Type.FINISH,
     secret,
     params: []
@@ -71,11 +71,11 @@ export const createGreetingClaimMessage = (invitationID: Buffer): WithTypeUrl<Co
   assert(Buffer.isBuffer(invitationID), 'invitationID is not a buffer.');
 
   return {
-    __type_url: TYPE_URL_GREETING_COMMAND,
+    '@type': TYPE_URL_GREETING_COMMAND,
     command: Command.Type.CLAIM,
     params: [
       {
-        __type_url: 'google.protobuf.BytesValue',
+        '@type': 'google.protobuf.BytesValue',
         value: invitationID
       }
     ]
@@ -86,14 +86,14 @@ export const createGreetingClaimMessage = (invitationID: Buffer): WithTypeUrl<Co
  * Crate a Greeting ClaimResponse message.
  * @param {Buffer} id   The ID of the new invitation.
  * @param {Buffer} rendezvousKey   The swarm key to use for Greeting.
- * @returns {{__type_url: string, payload: {__type_url: string, rendezvousKey: *, id: *}}}
+ * @returns {{'@type': string, payload: {'@type': string, rendezvousKey: *, id: *}}}
  */
 export const createGreetingClaimResponse = (id: Buffer, rendezvousKey: Buffer): WithTypeUrl<ClaimResponse> => {
   assert(id);
   assert(Buffer.isBuffer(rendezvousKey), 'rendezvousKey is not a buffer.');
 
   return {
-    __type_url: 'dxos.credentials.greet.ClaimResponse',
+    '@type': 'dxos.credentials.greet.ClaimResponse',
     id,
     rendezvousKey
   };

package/src/identity/identity-message.ts

@@ -9,12 +9,12 @@ import { unwrapEnvelopes, extractContents, unwrapMessage, wrapMessage } from '..
 import { DeviceInfo, IdentityInfo, KeyRecord, Message, SignedMessage, WithTypeUrl } from '../proto';
 
 /**
- * Return the __type_url, if present.
+ * Return the @type, if present.
  * @param message
  */
 function getTypeUrl (message: any) {
   // eslint-disable-next-line camelcase
-  return message?.__type_url;
+  return message?.['@type'];
 }
 
 /**
@@ -26,7 +26,7 @@ export const createDeviceInfoMessage = (keyring: Keyring, displayName: string, d
   assert(deviceKey);
 
   const message: WithTypeUrl<DeviceInfo> = {
-    __type_url: 'dxos.credentials.identity.DeviceInfo',
+    '@type': 'dxos.credentials.identity.DeviceInfo',
     publicKey: deviceKey.publicKey,
     displayName
   };
@@ -43,7 +43,7 @@ export const createIdentityInfoMessage = (keyring: Keyring, displayName: string,
   assert(identityKey);
 
   const message: WithTypeUrl<IdentityInfo> = {
-    __type_url: 'dxos.credentials.identity.IdentityInfo',
+    '@type': 'dxos.credentials.identity.IdentityInfo',
     publicKey: identityKey.publicKey,
     displayName
   };

package/src/keys/keyring-helpers.ts

@@ -132,11 +132,12 @@ export const canonicalStringify = (obj: any) => {
   return stableStringify(obj, {
     /* The point of signing and verifying is not that the internal, private state of the objects be
      * identical, but that the public contents can be verified not to have been altered. For that reason,
-     * really private fields (indicated by '__') are not included in the signature. In practice, this skips __type_url,
-     * and it also gives a mechanism for attaching other attributes to an object without breaking the signature.
+     * really private fields (indicated by '__') are not included in the signature.
+     * This gives a mechanism for attaching other attributes to an object without breaking the signature.
+     * We also skip @type.
      */
     replacer: (key: any, value: any) => {
-      if (key.toString().startsWith('__')) {
+      if (key.toString().startsWith('__') || key.toString() === '@type') {
         return undefined;
       }
       if (value) {

package/src/keys/keyring.ts

@@ -140,7 +140,7 @@ export class Keyring implements Signer {
     });
 
     return {
-      __type_url: 'dxos.credentials.SignedMessage',
+      '@type': 'dxos.credentials.SignedMessage',
       signed,
       signatures
     };
@@ -564,7 +564,7 @@ export class Keyring implements Signer {
     });
 
     return canonicalStringify({
-      __type_url: 'dxos.credentials.keys.KeyRecordList',
+      '@type': 'dxos.credentials.keys.KeyRecordList',
       keys
     });
   }

package/src/party/party-credential.ts

@@ -34,7 +34,7 @@ export const createPartyGenesisMessage = (
   assert(typeof admitKeyPair.type !== 'undefined');
 
   const message: WithTypeUrl<PartyCredential> = {
-    __type_url: TYPE_URL_PARTY_CREDENTIAL,
+    '@type': TYPE_URL_PARTY_CREDENTIAL,
     type: PartyCredential.Type.PARTY_GENESIS,
     partyGenesis: {
       partyKey: partyKeyPair.publicKey,
@@ -61,7 +61,7 @@ export const createKeyAdmitMessage = (
   partyKey = PublicKey.from(partyKey);
 
   const message: WithTypeUrl<PartyCredential> = {
-    __type_url: TYPE_URL_PARTY_CREDENTIAL,
+    '@type': TYPE_URL_PARTY_CREDENTIAL,
     type: PartyCredential.Type.KEY_ADMIT,
     keyAdmit: {
       partyKey,
@@ -87,7 +87,7 @@ export const createFeedAdmitMessage = (
   partyKey = PublicKey.from(partyKey);
 
   const message: WithTypeUrl<PartyCredential> = {
-    __type_url: TYPE_URL_PARTY_CREDENTIAL,
+    '@type': TYPE_URL_PARTY_CREDENTIAL,
     type: PartyCredential.Type.FEED_ADMIT,
     feedAdmit: {
       partyKey,
@@ -115,7 +115,7 @@ export const createEnvelopeMessage = (
   partyKey = PublicKey.from(partyKey);
 
   const message: WithTypeUrl<PartyCredential> = {
-    __type_url: TYPE_URL_PARTY_CREDENTIAL,
+    '@type': TYPE_URL_PARTY_CREDENTIAL,
     type: PartyCredential.Type.ENVELOPE,
     envelope: {
       partyKey,
@@ -134,7 +134,7 @@ export const createEnvelopeMessage = (
 export const isPartyCredentialMessage = (message: Message | SignedMessage) => {
   const signed = unwrapMessage(message) as SignedMessage;
   // eslint-disable-next-line camelcase
-  return signed?.signed?.payload?.__type_url === TYPE_URL_PARTY_CREDENTIAL;
+  return signed?.signed?.payload?.['@type'] === TYPE_URL_PARTY_CREDENTIAL;
 };
 
 /**
@@ -166,7 +166,7 @@ export function isSignedMessage (message: any): message is SignedMessage {
 // TODO(burdon): Typespec is too loose.
 export function wrapMessage (message: Message | SignedMessage | Command | Auth): WithTypeUrl<Message> {
   const payload = message as any;
-  return { __type_url: TYPE_URL_MESSAGE, payload } as WithTypeUrl<Message>;
+  return { '@type': TYPE_URL_MESSAGE, payload } as WithTypeUrl<Message>;
 }
 
 /**
@@ -286,10 +286,10 @@ export const createPartyInvitationMessage = (
   inviteeKey = PublicKey.from(inviteeKey);
 
   return {
-    __type_url: TYPE_URL_MESSAGE,
+    '@type': TYPE_URL_MESSAGE,
     payload:
       signer.sign({
-        __type_url: TYPE_URL_PARTY_INVITATION,
+        '@type': TYPE_URL_PARTY_INVITATION,
         id: randomBytes(),
         partyKey,
         issuerKey: issuerKey.publicKey,
@@ -307,8 +307,8 @@ export const isPartyInvitationMessage = (message: Message | SignedMessage) => {
   const signed = unwrapMessage(message);
 
   // eslint-disable-next-line camelcase
-  const payloadType = signed?.__type_url;
+  const payloadType = signed?.['@type'];
   // eslint-disable-next-line camelcase
-  const signedType = signed?.signed?.payload?.__type_url;
+  const signedType = signed?.signed?.payload?.['@type'];
   return payloadType === TYPE_URL_SIGNED_MESSAGE && signedType === TYPE_URL_PARTY_INVITATION;
 };

package/src/proto/any.ts

@@ -5,17 +5,17 @@
 import { TYPES } from './gen';
 
 // eslint-disable-next-line camelcase
-export type WithTypeUrl<T> = T & { __type_url: string }
+export type WithTypeUrl<T> = T & { '@type': string }
 
 export interface DecodedAny {
   // eslint-disable-next-line camelcase
-  __type_url: string,
+  '@type': string,
   [key: string]: any,
 }
 
 export type KnownAny = {
   [K in keyof TYPES]: {
   // eslint-disable-next-line camelcase
-  __type_url: K,
+  '@type': K,
 } & TYPES[K]
 }[keyof TYPES]