data: individual custom additional name list props

8 files changed, 133 insertions, 138 deletions

diff --git a/src/data/composite/things/track/index.js b/src/data/composite/things/track/index.js
index b5f1e3e2..cc723a24 100644
--- a/src/data/composite/things/track/index.js
+++ b/src/data/composite/things/track/index.js
@@ -1,12 +1,11 @@
 export {default as exitWithoutUniqueCoverArt} from './exitWithoutUniqueCoverArt.js';
+export {default as inferredAdditionalNameList} from './inferredAdditionalNameList.js';
 export {default as inheritFromOriginalRelease} from './inheritFromOriginalRelease.js';
-export {default as trackAdditionalNameList} from './trackAdditionalNameList.js';
+export {default as sharedAdditionalNameList} from './sharedAdditionalNameList.js';
 export {default as trackReverseReferenceList} from './trackReverseReferenceList.js';
 export {default as withAlbum} from './withAlbum.js';
 export {default as withAlwaysReferenceByDirectory} from './withAlwaysReferenceByDirectory.js';
 export {default as withContainingTrackSection} from './withContainingTrackSection.js';
 export {default as withHasUniqueCoverArt} from './withHasUniqueCoverArt.js';
-export {default as withInferredAdditionalNames} from './withInferredAdditionalNames.js';
 export {default as withOtherReleases} from './withOtherReleases.js';
 export {default as withPropertyFromAlbum} from './withPropertyFromAlbum.js';
-export {default as withSharedAdditionalNames} from './withSharedAdditionalNames.js';
diff --git a/src/data/composite/things/track/inferredAdditionalNameList.js b/src/data/composite/things/track/inferredAdditionalNameList.js
new file mode 100644
index 00000000..9cf158c6
--- /dev/null
+++ b/src/data/composite/things/track/inferredAdditionalNameList.js
@@ -0,0 +1,67 @@
+// Infers additional name entries from other releases that were titled
+// differently; the corresponding releases are stored in eacn entry's "from"
+// array, which will include multiple items, if more than one other release
+// shares the same name differing from this one's.
+
+import {input, templateCompositeFrom} from '#composite';
+import {chunkByProperties} from '#wiki-data';
+
+import {exitWithoutDependency} from '#composite/control-flow';
+import {withFilteredList, withPropertyFromList} from '#composite/data';
+import {withThingsSortedAlphabetically} from '#composite/wiki-data';
+
+import withOtherReleases from './withOtherReleases.js';
+
+export default templateCompositeFrom({
+  annotation: `inferredAdditionalNameList`,
+
+  compose: false,
+
+  steps: () => [
+    withOtherReleases(),
+
+    exitWithoutDependency({
+      dependency: '#otherReleases',
+      mode: input.value('empty'),
+      value: input.value([]),
+    }),
+
+    withPropertyFromList({
+      list: '#otherReleases',
+      property: input.value('name'),
+    }),
+
+    {
+      dependencies: ['#otherReleases.name', 'name'],
+      compute: (continuation, {
+        ['#otherReleases.name']: releaseNames,
+        ['name']: ownName,
+      }) => continuation({
+        ['#nameFilter']:
+          releaseNames.map(name => name !== ownName),
+      }),
+    },
+
+    withFilteredList({
+      list: '#otherReleases',
+      filter: '#nameFilter',
+    }).outputs({
+      '#filteredList': '#differentlyNamedReleases',
+    }),
+
+    withThingsSortedAlphabetically({
+      things: '#differentlyNamedReleases',
+    }).outputs({
+      '#sortedThings': '#differentlyNamedReleases',
+    }),
+
+    {
+      dependencies: ['#differentlyNamedReleases'],
+      compute: ({
+        ['#differentlyNamedReleases']: releases,
+      }) =>
+        chunkByProperties(releases, ['name'])
+          .map(({name, chunk}) => ({name, from: chunk})),
+    },
+  ],
+});
diff --git a/src/data/composite/things/track/sharedAdditionalNameList.js b/src/data/composite/things/track/sharedAdditionalNameList.js
new file mode 100644
index 00000000..1806ec80
--- /dev/null
+++ b/src/data/composite/things/track/sharedAdditionalNameList.js
@@ -0,0 +1,38 @@
+// Compiles additional names directly provided by other releases.
+
+import {input, templateCompositeFrom} from '#composite';
+
+import {exitWithoutDependency, exposeDependency}
+  from '#composite/control-flow';
+import {withFlattenedList, withPropertyFromList} from '#composite/data';
+
+import withOtherReleases from './withOtherReleases.js';
+
+export default templateCompositeFrom({
+  annotation: `sharedAdditionalNameList`,
+
+  compose: false,
+
+  steps: () => [
+    withOtherReleases(),
+
+    exitWithoutDependency({
+      dependency: '#otherReleases',
+      mode: input.value('empty'),
+      value: input.value([]),
+    }),
+
+    withPropertyFromList({
+      list: '#otherReleases',
+      property: input.value('additionalNames'),
+    }),
+
+    withFlattenedList({
+      list: '#otherReleases.additionalNames',
+    }),
+
+    exposeDependency({
+      dependency: '#flattenedList',
+    }),
+  ],
+});
diff --git a/src/data/composite/things/track/withInferredAdditionalNames.js b/src/data/composite/things/track/withInferredAdditionalNames.js
deleted file mode 100644
index 659d6b8f..00000000
--- a/src/data/composite/things/track/withInferredAdditionalNames.js
+++ /dev/null
@@ -1,80 +0,0 @@
-// Infers additional name entries from other releases that were titled
-// differently, linking to the respective release via annotation.
-
-import {input, templateCompositeFrom} from '#composite';
-import {stitchArrays} from '#sugar';
-
-import {raiseOutputWithoutDependency} from '#composite/control-flow';
-import {withPropertiesFromList, withPropertyFromList} from '#composite/data';
-
-import withOtherReleases from './withOtherReleases.js';
-
-export default templateCompositeFrom({
-  annotation: `withInferredAdditionalNames`,
-
-  outputs: ['#inferredAdditionalNames'],
-
-  steps: () => [
-    withOtherReleases(),
-
-    raiseOutputWithoutDependency({
-      dependency: '#otherReleases',
-      mode: input.value('empty'),
-      output: input.value({'#inferredAdditionalNames': []}),
-    }),
-
-    {
-      dependencies: ['#otherReleases', 'name'],
-      compute: (continuation, {
-        ['#otherReleases']: otherReleases,
-        ['name']: name,
-      }) => continuation({
-        ['#differentlyNamedReleases']:
-          otherReleases.filter(release => release.name !== name),
-      }),
-    },
-
-    withPropertiesFromList({
-      list: '#differentlyNamedReleases',
-      properties: input.value(['name', 'directory', 'album']),
-    }),
-
-    withPropertyFromList({
-      list: '#differentlyNamedReleases.album',
-      property: input.value('name'),
-    }),
-
-    {
-      dependencies: [
-        '#differentlyNamedReleases.directory',
-        '#differentlyNamedReleases.album.name',
-      ],
-
-      compute: (continuation, {
-        ['#differentlyNamedReleases.directory']: trackDirectories,
-        ['#differentlyNamedReleases.album.name']: albumNames,
-      }) => continuation({
-        ['#annotations']:
-          stitchArrays({
-            trackDirectory: trackDirectories,
-            albumName: albumNames,
-          }).map(({trackDirectory, albumName}) =>
-              `[[track:${trackDirectory}|on ${albumName}]]`)
-      })
-    },
-
-    {
-      dependencies: ['#differentlyNamedReleases.name', '#annotations'],
-      compute: (continuation, {
-        ['#differentlyNamedReleases.name']: names,
-        ['#annotations']: annotations,
-      }) => continuation({
-        ['#inferredAdditionalNames']:
-          stitchArrays({
-            name: names,
-            annotation: annotations,
-          }),
-      }),
-    },
-  ],
-});
diff --git a/src/data/composite/things/track/withSharedAdditionalNames.js b/src/data/composite/things/track/withSharedAdditionalNames.js
deleted file mode 100644
index bba675c9..00000000
--- a/src/data/composite/things/track/withSharedAdditionalNames.js
+++ /dev/null
@@ -1,46 +0,0 @@
-// Compiles additional names directly provided on other releases.
-
-import {input, templateCompositeFrom} from '#composite';
-
-import {raiseOutputWithoutDependency} from '#composite/control-flow';
-import {withFlattenedList} from '#composite/data';
-
-import CacheableObject from '#cacheable-object';
-
-import withOtherReleases from './withOtherReleases.js';
-
-export default templateCompositeFrom({
-  annotation: `withSharedAdditionalNames`,
-
-  outputs: ['#sharedAdditionalNames'],
-
-  steps: () => [
-    withOtherReleases(),
-
-    raiseOutputWithoutDependency({
-      dependency: '#otherReleases',
-      mode: input.value('empty'),
-      output: input.value({'#sharedAdditionalNames': []}),
-    }),
-
-    // TODO: Using getUpdateValue is always a bit janky.
-
-    {
-      dependencies: ['#otherReleases'],
-      compute: (continuation, {
-        ['#otherReleases']: otherReleases,
-      }) => continuation({
-        ['#otherReleases.additionalNames']:
-          otherReleases.map(release =>
-            CacheableObject.getUpdateValue(release, 'additionalNames')
-              ?? []),
-      }),
-    },
-
-    withFlattenedList({
-      list: '#otherReleases.additionalNames',
-    }).outputs({
-      '#flattenedList': '#sharedAdditionalNames',
-    }),
-  ],
-});
diff --git a/src/data/composite/wiki-properties/additionalNameList.js b/src/data/composite/wiki-properties/additionalNameList.js
index d1302224..c5971d4a 100644
--- a/src/data/composite/wiki-properties/additionalNameList.js
+++ b/src/data/composite/wiki-properties/additionalNameList.js
@@ -9,5 +9,6 @@ export default function() {
   return {
     flags: {update: true, expose: true},
     update: {validate: isAdditionalNameList},
+    expose: {transform: value => value ?? []},
   };
 }
diff --git a/src/data/things/track.js b/src/data/things/track.js
index 1f99ef53..08891719 100644
--- a/src/data/things/track.js
+++ b/src/data/things/track.js
@@ -24,6 +24,7 @@ import {
 
 import {
   additionalFiles,
+  additionalNameList,
   commentary,
   commentatorArtists,
   contributionList,
@@ -42,8 +43,9 @@ import {
 
 import {
   exitWithoutUniqueCoverArt,
+  inferredAdditionalNameList,
   inheritFromOriginalRelease,
-  trackAdditionalNameList,
+  sharedAdditionalNameList,
   trackReverseReferenceList,
   withAlbum,
   withAlwaysReferenceByDirectory,
@@ -64,7 +66,10 @@ export class Track extends Thing {
 
     name: name('Unnamed Track'),
     directory: directory(),
-    additionalNames: trackAdditionalNameList(),
+
+    additionalNames: additionalNameList(),
+    sharedAdditionalNames: sharedAdditionalNameList(),
+    inferredAdditionalNames: inferredAdditionalNameList(),
 
     duration: duration(),
     urls: urls(),
diff --git a/src/data/things/validators.js b/src/data/things/validators.js
index 55eedbcf..ac91b456 100644
--- a/src/data/things/validators.js
+++ b/src/data/things/validators.js
@@ -429,13 +429,6 @@ export function isURL(string) {
   return true;
 }
 
-export const isAdditionalName = validateProperties({
-  name: isName,
-  annotation: optional(isStringNonEmpty),
-});
-
-export const isAdditionalNameList = validateArrayItems(isAdditionalName);
-
 export function validateReference(type = 'track') {
   return (ref) => {
     isStringNonEmpty(ref);
@@ -557,6 +550,24 @@ export function validateWikiData({
   };
 }
 
+export const isAdditionalName = validateProperties({
+  name: isName,
+  annotation: optional(isStringNonEmpty),
+
+  // TODO: This only allows indicating sourcing from a track.
+  // That's okay for the current limited use of "from", but
+  // could be expanded later.
+  from:
+    // Double TODO: Explicitly allowing both references and
+    // live objects to co-exist is definitely weird, and
+    // altogether questions the way we define validators...
+    optional(oneOf(
+      validateReferenceList('track'),
+      validateWikiData({referenceType: 'track'}))),
+});
+
+export const isAdditionalNameList = validateArrayItems(isAdditionalName);
+
 // Compositional utilities
 
 export function oneOf(...checks) {