[#81] Add documentType to transformName and transformEntry context.

Author: Fyorl

CHANGELOG.md

@@ -1,7 +1,8 @@
 ## 3.0.2
 
 ### Improvements
- - Add support for processing ActiveEffect primary Documents.
+ - Added support for processing ActiveEffect primary Documents.
+ - Added `documentType` to the context objects passed to `transformEntry` and `transformName`.
 
 ## 3.0.1
 

README.md

@@ -210,8 +210,8 @@ Extract the contents of a compendium pack into individual source files for each
     * **log:** *boolean = false* Whether to log operation progress to the console.
     * **folders:** *boolean = false* Create a directory structure that matches the pack's Folder documents. Folder documents are written to their matching directory with the name `_Folder.{yml|json}`.
     * **documentType:** *string* For NeDB operations, a **documentType** must be provided. This should be the same as the pack's *type* field in the *module.json* or *system.json*.
-    * **transformEntry:** *(entry: object): Promise<false|void>* A function that is called on every entry. Returning *false* indicates that the entry should be discarded.
-    * **transformName:** *(entry: object): Promise<string|void>* A function that is called on every entry. The value returned from this will be used as the entry's filename and must include the appropriate file extension. If nothing is returned, an auto-generated name will be used instead.
+    * **transformEntry:** *(entry: object, context: object): Promise<false|void>* A function that is called on every entry. Returning *false* indicates that the entry should be discarded.
+    * **transformName:** *(entry: object, context: object): Promise<string|void>* A function that is called on every entry. The value returned from this will be used as the entry's filename and must include the appropriate file extension. If nothing is returned, an auto-generated name will be used instead.
     * **transformFolderName:** *(entry: object): Promise<string|void>* A function used to generate a directory name for an extracted Folder document when the `folders` option is used.
     * **expandAdventures:** *boolean* Write documents embedded in Adventures to their own files. If the `folders` option is also supplied, the Adventure is treated like a folder, and written to `_Adventure.{yml|json}` instead of `_Folder.{yml|json}`. Additionally, all its entries are grouped into sub-folders by Document type.
     * **omitVolatile:** *boolean* When unpacking, diff the candidate entry against an existing one and only write it if non-volatile fields have changed. Currently, `_stats.createdTime`, `_stats.modifiedTime`, `_stats.lastModifiedBy`, `_stats.systemVersion`, and `_stats.coreVersion` are considered volatile.

lib/package.mjs

@@ -12,15 +12,15 @@ import { ClassicLevel } from "classic-level";
 
 /**
  * @typedef {
- *   "Actor"|"Adventure"|"Cards"|"ChatMessage"|"Combat"|"FogExploration"|"Folder"|"Item"|"JournalEntry"|"Macro"|
- *   "Playlist"|"RollTable"|"Scene"|"Setting"|"User"
+ *   "ActiveEffect"|"Actor"|"Adventure"|"Cards"|"ChatMessage"|"Combat"|"FogExploration"|"Folder"|"Item"|"JournalEntry"|
+ *   "Macro"|"Playlist"|"RollTable"|"Scene"|"Setting"|"User"
  * } DocumentType
  */
 
 /**
  * @typedef {
- *   "actors"|"adventures"|"cards"|"messages"|"combats"|"fog"|"folders"|"items"|"journal"|"macros"|"playlists"|"tables"|
- *   "scenes"|"settings"|"users"
+ *   "actors"|"adventures"|"cards"|"messages"|"combats"|"effects"|"fog"|"folders"|"items"|"journal"|"macros"|
+ *   "playlists"|"tables"|"scenes"|"settings"|"users"
  * } DocumentCollection
  */
 
@@ -107,6 +107,7 @@ import { ClassicLevel } from "classic-level";
  * @property {object} [adventure.doc]   The entire adventure document.
  * @property {string} [adventure.path]  The path where the adventure will be extracted.
  * @property {string} [folder]          Folder path if this entry is in a folder and the folders option is enabled.
+ * @property {string} [documentType]    The type of the Document being extracted.
  */
 
 /**
@@ -294,9 +295,11 @@ async function compileNedb(pack, files, { log, transformEntry }={}) {
       });
       const key = doc._key;
       const [, collection] = key.split("!");
+      const documentType = COLLECTION_TYPE_MAP[collection];
+      const context = { documentType };
       // If the key starts with !folders, we should skip packing it as NeDB doesn't support folders.
       if ( key.startsWith("!folders") ) continue;
-      if ( await transformEntry?.(doc) === false ) continue;
+      if ( await transformEntry?.(doc, context) === false ) continue;
       await packDoc(doc, collection);
       await db.insert(doc);
       if ( log ) console.log(`Packed ${chalk.blue(doc._id)}${chalk.blue(doc.name ? ` (${doc.name})` : "")}`);
@@ -353,7 +356,9 @@ async function compileClassicLevel(pack, files, { log, transformEntry }={}) {
         transformEntry, log
       });
       const [, collection] = doc._key.split("!");
-      if ( await transformEntry?.(doc) === false ) continue;
+      const documentType = COLLECTION_TYPE_MAP[collection];
+      const context = { documentType };
+      if ( await transformEntry?.(doc, context) === false ) continue;
       await packDoc(doc, collection);
       if ( log ) console.log(`Packed ${chalk.blue(doc._id)}${chalk.blue(doc.name ? ` (${doc.name})` : "")}`);
     } catch ( err ) {
@@ -385,7 +390,7 @@ async function compileClassicLevel(pack, files, { log, transformEntry }={}) {
  * @returns {Promise<void>}
  */
 async function reconstructAdventure(src, doc, { transformEntry, log }={}) {
-  const context = { adventure: doc };
+  const context = { adventure: { doc } };
   for ( const embeddedCollectionName of ADVENTURE_DOCS ) {
     const entries = [];
     for ( let entry of doc[embeddedCollectionName] ?? [] ) {
@@ -400,8 +405,9 @@ async function reconstructAdventure(src, doc, { transformEntry, log }={}) {
         }
         const ext = path.extname(file);
         const isYaml = ext === ".yml" || ext === ".yaml";
+        const documentType = COLLECTION_TYPE_MAP[embeddedCollectionName];
         entry = isYaml ? YAML.load(contents) : JSON.parse(contents);
-        if ( await transformEntry?.(entry, context) === false ) continue;
+        if ( await transformEntry?.(entry, { ...context, documentType }) === false ) continue;
       }
       entries.push(entry);
     }
@@ -500,8 +506,10 @@ async function extractNedb(pack, dest, {
   const docs = await db.find({});
   for ( const doc of docs ) {
     await unpackDoc(doc, collection);
-    if ( await transformEntry?.(doc) === false ) continue;
-    let name = await transformName?.(doc);
+    const documentType = COLLECTION_TYPE_MAP[collection];
+    const context = { documentType };
+    if ( await transformEntry?.(doc, context) === false ) continue;
+    let name = await transformName?.(doc, context);
     if ( !name ) {
       name = `${doc.name ? `${getSafeFilename(doc.name)}_${doc._id}` : doc._id}.${yaml ? "yml" : "json"}`;
     }
@@ -552,15 +560,17 @@ async function extractClassicLevel(pack, dest, {
     const [, collection, id] = key.split("!");
     if ( collection.includes(".") ) continue; // This is not a primary document, skip it.
     await unpackDoc(doc, collection);
-    if ( await transformEntry?.(doc) === false ) continue;
+    const documentType = COLLECTION_TYPE_MAP[collection];
+    const context = { documentType };
+    if ( await transformEntry?.(doc, context) === false ) continue;
     if ( key.startsWith("!adventures") && expandAdventures ) {
       await extractAdventure(doc, dest, { folderMap }, {
         yaml, yamlOptions, jsonOptions, log, folders, omitVolatile, transformEntry, transformName, existing
       });
       continue;
     }
     const folder = folderMap.get(doc.folder)?.path;
-    let name = await transformName?.(doc, { folder });
+    let name = await transformName?.(doc, { documentType, folder });
     if ( !name ) {
       if ( key.startsWith("!folders") && folderMap.has(doc._id) ) {
         const folder = folderMap.get(doc._id);
@@ -598,7 +608,7 @@ async function extractAdventure(doc, dest, { folderMap }={}, {
 
   // Prepare name for the adventure
   const folder = folderMap?.get(doc.folder)?.path;
-  let name = await transformName?.(doc, { folder });
+  let name = await transformName?.(doc, { documentType: "Adventure", folder });
   adventureFolder = folders ? path.join(folder ?? "", `${getSafeFilename(doc.name)}_${doc._id}`) : folder;
   if ( !name ) {
     if ( folders ) {
@@ -618,11 +628,12 @@ async function extractAdventure(doc, dest, { folderMap }={}, {
   // Write all documents contained in the adventure
   for ( const embeddedCollectionName of ADVENTURE_DOCS ) {
     const paths = [];
-    const typeSuffix = folders ? "" : `_${COLLECTION_TYPE_MAP[embeddedCollectionName]}`;
+    const documentType = COLLECTION_TYPE_MAP[embeddedCollectionName];
+    const typeSuffix = folders ? "" : `_${documentType}`;
     for ( const embeddedDoc of doc[embeddedCollectionName] ?? [] ) {
-      if ( await transformEntry?.(embeddedDoc, context) === false ) continue;
+      if ( await transformEntry?.(embeddedDoc, { ...context, documentType }) === false ) continue;
       let embeddedFolder = path.join(adventureFolder ?? "", embeddedFolderMap.get(embeddedDoc.folder)?.path ?? "");
-      let embeddedName = await transformName?.(embeddedDoc, { ...context, folder: embeddedFolder });
+      let embeddedName = await transformName?.(embeddedDoc, { ...context, documentType, folder: embeddedFolder });
       if ( !embeddedName ) {
         const { name, _id: id } = embeddedDoc;
         if ( (embeddedCollectionName === "folders") && embeddedFolderMap.has(embeddedDoc._id) ) {