docusaurus-plugin-generate-schema-docs 1.8.4 → 1.8.5

package/helpers/trackingTargets.js

@@ -10,6 +10,28 @@ export const SUPPORTED_TRACKING_TARGETS = [
 
 const TARGET_ID_PATTERN = /^[a-z0-9]+(?:-[a-z0-9]+){2,}$/;
 
+function isReferenceAggregatorSchema(schema) {
+  if (!schema || typeof schema !== 'object') {
+    return false;
+  }
+
+  const hasChoiceAggregation =
+    Array.isArray(schema.oneOf) || Array.isArray(schema.anyOf);
+  const hasPropertiesKeyword = Object.hasOwn(schema, 'properties');
+  const hasValidPropertiesMap =
+    hasPropertiesKeyword &&
+    schema.properties &&
+    typeof schema.properties === 'object' &&
+    !Array.isArray(schema.properties);
+  const hasOwnProperties =
+    hasValidPropertiesMap && Object.keys(schema.properties).length > 0;
+
+  return (
+    hasChoiceAggregation &&
+    (!hasPropertiesKeyword || (hasValidPropertiesMap && !hasOwnProperties))
+  );
+}
+
 export function resolveTrackingTargets(
   schema,
   { schemaFile = 'schema', isQuiet = false } = {},
@@ -17,9 +39,10 @@ export function resolveTrackingTargets(
   const configuredTargets = schema?.['x-tracking-targets'];
 
   if (configuredTargets == null) {
-    const warning = isQuiet
-      ? null
-      : `Schema ${schemaFile} is missing x-tracking-targets. Falling back to "${DEFAULT_TRACKING_TARGET}".`;
+    const warning =
+      isQuiet || isReferenceAggregatorSchema(schema)
+        ? null
+        : `Schema ${schemaFile} is missing x-tracking-targets. Falling back to "${DEFAULT_TRACKING_TARGET}".`;
     return {
       targets: [DEFAULT_TRACKING_TARGET],
       warning,

package/helpers/validator.js

@@ -9,14 +9,29 @@ import { promises as fs } from 'fs';
 import { URL } from 'url';
 import { resolveConstraintSchemaPath } from './constraintSchemaPaths.js';
 
+const schemaFileCache = new Map();
+
+export function clearSchemaFileCache() {
+  schemaFileCache.clear();
+}
+
+function readSchemaFile(filePath) {
+  if (!schemaFileCache.has(filePath)) {
+    schemaFileCache.set(
+      filePath,
+      fs.readFile(filePath, 'utf-8').then(JSON.parse),
+    );
+  }
+  return schemaFileCache.get(filePath);
+}
+
 function createAjvInstance(schemas, mainSchema, schemaPath) {
   const schemaVersion = mainSchema?.$schema;
 
   const loadSchema = async (uri) => {
     const constraintPath = resolveConstraintSchemaPath(uri);
     if (constraintPath) {
-      const schemaContent = await fs.readFile(constraintPath, 'utf-8');
-      return JSON.parse(schemaContent);
+      return readSchemaFile(constraintPath);
     }
 
     let localPath;
@@ -29,8 +44,7 @@ function createAjvInstance(schemas, mainSchema, schemaPath) {
     } else {
       localPath = path.resolve(schemaPath, uri);
     }
-    const schemaContent = await fs.readFile(localPath, 'utf-8');
-    return JSON.parse(schemaContent);
+    return readSchemaFile(localPath);
   };
 
   const options = {

package/index.js

@@ -7,8 +7,7 @@ import path from 'path';
 import { execSync } from 'child_process';
 import { fileURLToPath } from 'url';
 
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
 export default async function (context, options) {
   const { siteDir } = context;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-generate-schema-docs",
-  "version": "1.8.4",
+  "version": "1.8.5",
   "description": "Docusaurus plugin to generate documentation from JSON schemas.",
   "main": "index.js",
   "license": "MIT",

package/scripts/sync-gtm.js

@@ -137,10 +137,10 @@ async function getVariablesFromSchemas(
   for (const file of jsonFiles) {
     try {
       let schema = await RefParser.bundle(file);
-      schema = mergeAllOf(schema);
       if (!shouldIncludeSchemaForGtm(schema)) {
         continue;
       }
+      schema = mergeAllOf(schema);
       const fileVariables = parseSchema(schema, { skipArraySubProperties });
       for (const variable of fileVariables) {
         if (!allVariables.has(variable.name)) {
@@ -217,19 +217,27 @@ function createGtmVariables(variablesToCreate) {
 
 function deleteGtmVariables(variablesToDelete) {
   logger.log(`Found ${variablesToDelete.length} variables to delete.`);
+  const deleted = [];
+  const failedDeletes = [];
   for (const v of variablesToDelete) {
     const command = `gtm variables delete --variable-id ${v.variableId} --force --quiet`;
     logger.log(`Executing: ${command}`);
-    execSync(command, { stdio: 'inherit' });
+    try {
+      execSync(command, { stdio: 'inherit' });
+      deleted.push(v.parameter.find((p) => p.key === 'name').value);
+    } catch {
+      failedDeletes.push({
+        name: v.parameter.find((p) => p.key === 'name').value,
+        variableId: v.variableId,
+      });
+    }
   }
-  return variablesToDelete.map(
-    (v) => v.parameter.find((p) => p.key === 'name').value,
-  );
+  return { deleted, failedDeletes };
 }
 
 async function syncGtmVariables(
   schemaVariables,
-  { skipArraySubProperties = false },
+  { skipArraySubProperties = false } = {},
 ) {
   const gtmVariables = getGtmVariables();
 
@@ -247,12 +255,13 @@ async function syncGtmVariables(
   );
 
   const created = createGtmVariables(toCreate);
-  const deleted = deleteGtmVariables(toDelete);
+  const { deleted, failedDeletes } = deleteGtmVariables(toDelete);
 
   logger.log('GTM variable synchronization complete.');
   return {
     created,
     deleted,
+    failedDeletes,
     inSync: inSync.map((v) => v.name),
   };
 }
@@ -360,6 +369,14 @@ async function main(argv, deps) {
         ),
       );
     } else {
+      if (summary.failedDeletes?.length > 0) {
+        log.log(
+          `Skipped deleting ${summary.failedDeletes.length} GTM variables (GTM rejected the delete, they may still be referenced):`,
+        );
+        for (const failed of summary.failedDeletes) {
+          log.log(`- ${failed.name} (ID: ${failed.variableId})`);
+        }
+      }
       log.log('Synchronization successful!');
       log.log(
         `All changes applied in GTM workspace: "${workspaceName}" (ID: ${workspaceId})`,
@@ -397,6 +414,7 @@ module.exports = {
   main,
   getVariablesToCreate,
   getVariablesToDelete,
+  getGtmVariables,
   createGtmVariables,
   deleteGtmVariables,
   parseSchema,