Merge pull request #499 from abraham/specials

Apply overrides from git commits

Author: abraham

config.json

@@ -2,5 +2,7 @@
   "mastodonDocsCommit": "f760ffcdf3371a641ba5d731dd33348fc6eb4fe6",
   "mastodonVersion": "4.4.0",
   "minimumMastodonVersion": "4.2.0",
-  "blockedFiles": ["methods/notifications_alpha.md"]
+  "blockedFiles": ["methods/notifications_alpha.md"],
+  "overridesRepository": "https://github.com/abraham/documentation",
+  "overrideCommits": ["b1d8f95b506e2d734876ef47ec0f4e1feb4f5618"]
 }

dist/schema.json

@@ -35184,6 +35184,28 @@
               "null"
             ],
             "properties": {
+              "small": {
+                "description": "Details about the small preview version of the attachment.",
+                "oneOf": [
+                  {
+                    "$ref": "#/components/schemas/MetaDetails"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
+              "original": {
+                "description": "Details about the original version of the attachment.",
+                "oneOf": [
+                  {
+                    "$ref": "#/components/schemas/MetaDetails"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ]
+              },
               "focus": {
                 "description": "Coordinates that may be used for smart thumbnail cropping -- see [Focal points for cropped media thumbnails]({{< relref \"api/guidelines#focal-points\" >}}) for more.",
                 "type": [
@@ -35241,6 +35263,58 @@
           "description": "Official Mastodon API documentation"
         }
       },
+      "MetaDetails": {
+        "type": "object",
+        "description": "Additional entity definition for MetaDetails",
+        "properties": {
+          "aspect": {
+            "description": "The media aspect ratio of the video or image attachment.",
+            "type": [
+              "number",
+              "null"
+            ]
+          },
+          "bitrate": {
+            "description": "The media bitrate of the video or audio attachment.",
+            "type": [
+              "integer",
+              "null"
+            ]
+          },
+          "duration": {
+            "description": "The duration of the video attachment.",
+            "type": [
+              "number",
+              "null"
+            ]
+          },
+          "frame_rate": {
+            "description": "The frame rate of the video attachment.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "height": {
+            "description": "The height of the attachment in pixels.",
+            "type": [
+              "integer",
+              "null"
+            ]
+          },
+          "width": {
+            "description": "The width of the attachment in pixels.",
+            "type": [
+              "integer",
+              "null"
+            ]
+          }
+        },
+        "externalDocs": {
+          "url": "https://docs.joinmastodon.org/entities/MediaAttachment/#attributes",
+          "description": "Official Mastodon API documentation"
+        }
+      },
       "Notification": {
         "type": "object",
         "description": "Represents a notification of an event relevant to the user.",

scripts/setup-docs.ts

@@ -18,6 +18,8 @@ function setupMastodonDocs(): void {
 
   const config = JSON.parse(fs.readFileSync(configPath, 'utf8'));
   const targetCommit = config.mastodonDocsCommit;
+  const overrideCommits = config.overrideCommits || [];
+  const overridesRepository = config.overridesRepository;
 
   if (!targetCommit) {
     console.error('mastodonDocsCommit not found in config.json');
@@ -52,6 +54,36 @@ function setupMastodonDocs(): void {
       cwd: docsDir,
     });
 
+    // Apply override commits if any
+    if (overrideCommits.length > 0) {
+      console.log(`Adding ${overridesRepository} overrides remote...`);
+      execSync(`git config user.email "[email protected]"`, {
+        stdio: 'inherit',
+        cwd: docsDir,
+      });
+      execSync(`git config user.name "bot"`, {
+        stdio: 'inherit',
+        cwd: docsDir,
+      });
+      execSync(`git remote add overrides ${overridesRepository} || true`, {
+        stdio: 'inherit',
+        cwd: docsDir,
+      });
+      execSync(`git fetch overrides`, {
+        stdio: 'inherit',
+        cwd: docsDir,
+      });
+
+      console.log(`Applying ${overrideCommits.length} override commit(s)...`);
+      for (const commit of overrideCommits) {
+        console.log(`Cherry-picking commit ${commit}...`);
+        execSync(`git cherry-pick ${commit}`, {
+          stdio: 'inherit',
+          cwd: docsDir,
+        });
+      }
+    }
+
     console.log('Mastodon documentation setup complete.');
   } catch (error) {
     console.error(

src/__tests__/parsers/EntityParser.draft.test.ts

@@ -40,6 +40,6 @@ describe('EntityParser - Draft File Handling', () => {
     // This test validates that only explicit draft: true is filtered
     // This is implicitly tested by checking that we still get a reasonable number of entities
     const entities = parser.parseAllEntities();
-    expect(entities.length).toBe(91); // Exact count after removing EncryptedMessage and entities from blocked files (increased due to extracted nested entities + Admin::DimensionData + DiscoverOauthServerConfigurationResponse + OEmbedResponse)
+    expect(entities.length).toBe(92); // Exact count after removing EncryptedMessage and entities from blocked files (increased due to extracted nested entities + Admin::DimensionData + DiscoverOauthServerConfigurationResponse + OEmbedResponse)
   });
 });

src/parsers/EntityFileParser.ts

@@ -157,10 +157,35 @@ export class EntityFileParser {
 
         // Find the content for this entity (from this heading to the next ## heading or end of file)
         const startIndex = match.index + fullMatch.length;
-        const nextSectionMatch = content.substring(startIndex).match(/\n## /);
-        const endIndex = nextSectionMatch
-          ? startIndex + (nextSectionMatch.index || 0)
-          : content.length;
+
+        // Check if the next section is an "## Attributes" heading
+        // If so, we need to include it in the entity content
+        let endIndex = content.length;
+        const remainingContent = content.substring(startIndex);
+        const nextAttributesMatch =
+          remainingContent.match(/\n## Attributes\s*\n/);
+
+        if (nextAttributesMatch && nextAttributesMatch.index !== undefined) {
+          // Found "## Attributes" - find the section after that
+          const afterAttributesStart =
+            startIndex +
+            nextAttributesMatch.index +
+            nextAttributesMatch[0].length;
+          const afterAttributesContent =
+            content.substring(afterAttributesStart);
+          const nextSectionMatch = afterAttributesContent.match(/\n## /);
+
+          if (nextSectionMatch && nextSectionMatch.index !== undefined) {
+            endIndex = afterAttributesStart + nextSectionMatch.index;
+          }
+          // If no next section found, use the rest of the file (endIndex already set to content.length)
+        } else {
+          // No "## Attributes" section found, look for next ## heading
+          const nextSectionMatch = remainingContent.match(/\n## /);
+          if (nextSectionMatch && nextSectionMatch.index !== undefined) {
+            endIndex = startIndex + nextSectionMatch.index;
+          }
+        }
 
         const entityContent = content.substring(startIndex, endIndex);