Merge branch 'main' of github.com:digidem/mapeo-schema into feat/addD…

…eletedToCommon

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapeo/schema",
-  "version": "3.0.0-next.8",
+  "version": "3.0.0-next.9",
   "description": "JSON schema and flow types for Mapeo",
   "main": "dist/index.js",
   "type": "module",

proto/common/v1.proto

@@ -8,13 +8,15 @@ message Common_1 {
   // 32-byte random generated number
   optional bytes docId = 1 [(required) = true];
   message Link {
-    bytes coreKey = 1;
+    bytes coreDiscoveryKey = 1;
     int32 index = 2;
   }
   repeated Link links = 2;
   google.protobuf.Timestamp createdAt = 3 [(required) = true];
   google.protobuf.Timestamp updatedAt = 4 [(required) = true];
-  optional bool deleted = 5;
+  // 32-byte hash of the discovery key of a core
+  bytes createdBy = 5 [(required) = true];
+  optional bool deleted = 6;
 }
 /* ignored fields and differences from common.json jsonSchema
  * id is a byte buffer here and a string in jsonSchema

proto/observation/v5.proto

@@ -32,6 +32,7 @@ message Observation_5 {
     bytes driveId = 1;
     string name = 2;
     AttachmentType type = 3;
+    bytes hash = 4;
   }
   repeated Attachment attachments = 8;
 

schema/common/v1.json

@@ -10,7 +10,7 @@
       "type": "string"
     },
     "versionId": {
-      "description": "core id (hex-encoded 32-byte buffer) and core index number, separated by '/'",
+      "description": "core discovery id (hex-encoded 32-byte buffer) and core index number, separated by '/'",
       "type": "string"
     },
     "schemaName": {
@@ -22,6 +22,10 @@
       "type": "string",
       "format": "date-time"
     },
+    "createdBy": {
+      "description": "discovery id (hex-encoded 32-byte buffer) of the hypercore where the first version of this document is written",
+      "type": "string"
+    },
     "updatedAt": {
       "description": "RFC3339-formatted datetime of when this version of the element was created",
       "type": "string",
@@ -47,6 +51,7 @@
     "schemaName",
     "updatedAt",
     "links",
-    "versionId"
+    "versionId",
+    "createdBy"
   ]
 }

schema/observation/v5.json

@@ -100,9 +100,13 @@
               "UNRECOGNIZED": "future attachment type"
             },
             "enum": ["photo", "video", "audio", "UNRECOGNIZED"]
+          },
+          "hash": {
+            "type": "string",
+            "description": "SHA256 hash of the attachment"
           }
         },
-        "required": ["driveId", "name", "type"]
+        "required": ["driveId", "name", "type", "hash"]
       }
     },
     "tags": {

src/encode.ts

@@ -17,7 +17,7 @@ import {
   convertRole,
   convertDeviceInfo,
   convertCoreOwnership,
-} from './lib/encode-converstions.js'
+} from './lib/encode-conversions.js'
 import { CoreOwnership } from './index.js'
 
 /**

src/lib/decode-conversions.ts

@@ -55,8 +55,8 @@ export const convertObservation: ConvertFunction<'observation'> = (
     ...jsonSchemaCommon,
     ...rest,
     refs: message.refs?.map(({ id }) => ({ id: id.toString('hex') })),
-    attachments: message.attachments?.map(({ driveId, name, type }) => {
-      return { driveId: driveId.toString('hex'), name, type }
+    attachments: message.attachments?.map(({ driveId, name, type, hash }) => {
+      return { driveId: driveId.toString('hex'), name, type, hash: hash.toString('hex') }
     }),
     tags: convertTags(message.tags),
     metadata: message.metadata || {},
@@ -250,5 +250,6 @@ function convertCommon(
     links: common.links.map((link) => getVersionId(link)),
     createdAt: common.createdAt,
     updatedAt: common.updatedAt,
+    createdBy: common.createdBy.toString('hex'),
   }
 }

src/lib/encode-converstions.ts → src/lib/encode-conversions.ts

@@ -83,6 +83,7 @@ export const convertObservation: ConvertFunction<'observation'> = (
       driveId: Buffer.from(attachment.driveId, 'hex'),
       name: attachment.name,
       type: attachment.type,
+      hash: Buffer.from(attachment.hash, 'hex'),
     }
   })
 
@@ -138,6 +139,7 @@ function convertCommon(
     docId: Buffer.from(common.docId, 'hex'),
     createdAt: common.createdAt,
     updatedAt: common.updatedAt,
+    createdBy: Buffer.from(common.createdBy, 'hex'),
     links: common.links.map((link) => parseVersionId(link)),
   }
 }

src/lib/utils.ts

@@ -16,7 +16,7 @@ function capitalize<T extends string>(str: T): Capitalize<T> {
 }
 
 export type VersionIdObject = {
-  coreKey: Buffer
+  coreDiscoveryKey: Buffer
   index: number
 }
 
@@ -27,8 +27,8 @@ export type VersionIdObject = {
  * @param versionIdObject
  * @returns versionId string
  */
-export function getVersionId({ coreKey, index }: VersionIdObject) {
-  return coreKey.toString('hex') + '/' + index
+export function getVersionId({ coreDiscoveryKey, index }: VersionIdObject) {
+  return coreDiscoveryKey.toString('hex') + '/' + index
 }
 
 /**
@@ -41,9 +41,9 @@ export function getVersionId({ coreKey, index }: VersionIdObject) {
 export function parseVersionId(versionId: string): VersionIdObject {
   const items = versionId.split('/')
   if (!items[0] || !items[1]) throw new Error('Invalid versionId')
-  const coreKey = Buffer.from(items[0], 'hex')
-  if (coreKey.length !== 32) throw new Error('Invalid versionId')
+  const coreDiscoveryKey = Buffer.from(items[0], 'hex')
+  if (coreDiscoveryKey.length !== 32) throw new Error('Invalid versionId')
   const index = Number.parseInt(items[1])
   if (isNaN(index)) throw new Error('Invalid versionId')
-  return { coreKey, index }
+  return { coreDiscoveryKey, index }
 }

test/fixtures/cached.js

@@ -8,9 +8,13 @@ export const cachedValues = {
   projectId: randomBytes(32).toString('hex'),
   authorId: randomBytes(32).toString('hex'),
   coreId: randomBytes(32).toString('hex'),
+  createdBy: randomBytes(32).toString('hex'),
   createdAt: date,
   updatedAt: date,
-  attachments: { driveId: randomBytes(32).toString('hex') },
+  attachments: {
+    driveId: randomBytes(32).toString('hex'),
+    hash: randomBytes(32).toString('hex'),
+  },
   metadata: {
     position: {
       timestamp: date,

test/fixtures/good-docs-completed.js

@@ -16,6 +16,7 @@ export const goodDocsCompleted = [
       schemaName: 'observation',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       lat: 24.0424,
       lon: 21.0214,
@@ -25,6 +26,7 @@ export const goodDocsCompleted = [
           name: 'myFile',
           type: 'photo',
           driveId: cachedValues.attachments.driveId,
+          hash: cachedValues.attachments.hash,
         },
       ],
       tags: {
@@ -74,6 +76,7 @@ export const goodDocsCompleted = [
       schemaName: 'projectSettings',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       defaultPresets: {
         point: cachedValues.defaultPresets.point,
@@ -93,6 +96,7 @@ export const goodDocsCompleted = [
       schemaName: 'field',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       tagKey: 'otherTagKey',
       type: 'number',
@@ -116,6 +120,7 @@ export const goodDocsCompleted = [
       schemaName: 'preset',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       name: 'myPreset',
       geometry: ['point', 'vertex', 'line'],
@@ -142,6 +147,7 @@ export const goodDocsCompleted = [
       schemaName: 'role',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       roleId: '6fd029a78243',
       fromIndex: 5,
@@ -155,6 +161,7 @@ export const goodDocsCompleted = [
       schemaName: 'deviceInfo',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       name: 'my device name',
     },
@@ -167,6 +174,7 @@ export const goodDocsCompleted = [
       schemaName: 'coreOwnership',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       authCoreId: Buffer.from('authCoreId').toString('hex'),
       configCoreId: Buffer.from('configCoreId').toString('hex'),

test/fixtures/good-docs-minimal.js

@@ -18,6 +18,7 @@ export const goodDocsMinimal = [
       schemaName: 'observation',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       refs: [],
       attachments: [],
@@ -33,6 +34,7 @@ export const goodDocsMinimal = [
       schemaName: 'projectSettings',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
     },
     expected: {},
@@ -44,6 +46,7 @@ export const goodDocsMinimal = [
       schemaName: 'field',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       tagKey: 'myTagKey',
       label: 'my label',
@@ -58,6 +61,7 @@ export const goodDocsMinimal = [
       schemaName: 'preset',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       name: 'myPreset',
       geometry: ['point'],
@@ -76,6 +80,7 @@ export const goodDocsMinimal = [
       schemaName: 'role',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       roleId: '3b0104e370f9',
       fromIndex: 5,
@@ -89,6 +94,7 @@ export const goodDocsMinimal = [
       schemaName: 'deviceInfo',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       name: 'my device name',
     },
@@ -101,6 +107,7 @@ export const goodDocsMinimal = [
       schemaName: 'coreOwnership',
       createdAt: cachedValues.createdAt,
       updatedAt: cachedValues.updatedAt,
+      createdBy: cachedValues.createdBy,
       links: [],
       authCoreId: Buffer.from('authCoreId').toString('hex'),
       configCoreId: Buffer.from('configCoreId').toString('hex'),