feat: add related identifiers to DepositMetadata

I believe 'scheme', 'relation', and 'resource_type' could be fixed lists, and the type of
'identifier' based on 'scheme', but I've started with plain strings.

Refs 34334fa

Author: thewilkybarkid

docs/modules/index.ts.md

@@ -151,6 +151,12 @@ export type DepositMetadata = {
     name: string
   }>
   description: string
+  related_identifiers?: NonEmptyArray<{
+    scheme: string
+    identifier: string
+    relation: string
+    resource_type?: string
+  }>
   title: string
 } & (
   | {

src/index.ts

@@ -107,6 +107,12 @@ export type DepositMetadata = {
     name: string
   }>
   description: string
+  related_identifiers?: NonEmptyArray<{
+    scheme: string
+    identifier: string
+    relation: string
+    resource_type?: string
+  }>
   title: string
 } & (
   | {
@@ -495,6 +501,12 @@ const DepositMetadataC = pipe(
   C.intersect(
     C.partial({
       communities: NonEmptyArrayC(C.struct({ identifier: C.string })),
+      related_identifiers: NonEmptyArrayC(
+        pipe(
+          C.struct({ identifier: C.string, scheme: C.string, relation: C.string }),
+          C.intersect(C.partial({ resource_type: C.string })),
+        ),
+      ),
     }),
   ),
   C.intersect(UploadTypeC),

test-d/index.ts

@@ -56,6 +56,9 @@ expectTypeOf(depositMetadata.creators).toEqualTypeOf<
   }>
 >()
 expectTypeOf(depositMetadata.description).toEqualTypeOf<string>()
+expectTypeOf(depositMetadata.related_identifiers).toEqualTypeOf<
+  NonEmptyArray<{ scheme: string; identifier: string; relation: string; resource_type?: string }> | undefined
+>()
 expectTypeOf(depositMetadata.title).toEqualTypeOf<string>()
 
 //

test/fc.ts

@@ -183,6 +183,20 @@ export const zenodoDepositMetadata = (): fc.Arbitrary<_.DepositMetadata> =>
               { minLength: 1 },
             )
             .filter(isNonEmpty),
+          related_identifiers: fc
+            .array(
+              fc.record(
+                {
+                  scheme: fc.string(),
+                  identifier: fc.string(),
+                  relation: fc.string(),
+                  resource_type: fc.string(),
+                },
+                { requiredKeys: ['scheme', 'identifier', 'relation'] },
+              ),
+              { minLength: 1 },
+            )
+            .filter(isNonEmpty),
         },
         { withDeletedKeys: true },
       ),