@postman-enricher/core 1.0.0 → 1.1.0

package/dist/enrichers/organize.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Organize enricher - Reorganizes collection by REST resource hierarchy
+ */
+import type { PostmanCollection, OrganizeConfig } from '@postman-enricher/shared';
+export declare function organizeByResources(collection: PostmanCollection, config: OrganizeConfig): PostmanCollection;

package/dist/enrichers/organize.js

@@ -0,0 +1,53 @@
+/**
+ * Organize enricher - Reorganizes collection by REST resource hierarchy
+ */
+import { getUrlPath, isRequest } from '@postman-enricher/shared';
+export function organizeByResources(collection, config) {
+    if (!config?.enabled || config.strategy !== 'resources') {
+        return collection;
+    }
+    const excludePathParams = config.excludePathParams ?? true;
+    const maxDepth = config.nestingLevel || Infinity;
+    const organized = buildResourceHierarchy(collection.item, excludePathParams, maxDepth);
+    return {
+        ...collection,
+        item: organized.length > 0 ? organized : collection.item,
+    };
+}
+function buildResourceHierarchy(items, excludePathParams, maxDepth) {
+    const folderMap = new Map();
+    items.forEach((item) => {
+        if (!isRequest(item) || !item.request?.url)
+            return;
+        const path = getUrlPath(item.request.url);
+        const segments = extractSegments(path, excludePathParams).slice(0, maxDepth);
+        if (segments.length === 0)
+            return;
+        // Create/get folders for the path hierarchy
+        let folderPath = '';
+        let parentFolder = null;
+        segments.forEach((segment, index) => {
+            folderPath = folderPath ? `${folderPath}/${segment}` : segment;
+            if (!folderMap.has(folderPath)) {
+                const folder = { name: segment, item: [] };
+                folderMap.set(folderPath, folder);
+                if (parentFolder) {
+                    parentFolder.item.push(folder);
+                }
+            }
+            parentFolder = folderMap.get(folderPath);
+            // Add item to deepest folder
+            if (index === segments.length - 1) {
+                parentFolder.item.push(item);
+            }
+        });
+    });
+    // Return only top-level folders
+    return Array.from(folderMap.values()).filter((folder) => !folder.name.includes('/'));
+}
+function extractSegments(path, excludePathParams) {
+    return path
+        .split('/')
+        .filter((seg) => seg && !seg.endsWith(':'))
+        .filter((seg) => !excludePathParams || (!seg.startsWith(':') && !seg.startsWith('{')));
+}

package/dist/enrichers/pathVariables.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Path Variables enricher - Ensures path parameters reference collection/environment variables
+ */
+import type { PostmanCollection, PathVariablesConfig } from '@postman-enricher/shared';
+export declare function setupPathVariables(collection: PostmanCollection, config: PathVariablesConfig): PostmanCollection;

package/dist/enrichers/pathVariables.js

@@ -0,0 +1,29 @@
+/**
+ * Path Variables enricher - Ensures path parameters reference collection/environment variables
+ */
+import { walkCollection, isRequest } from '@postman-enricher/shared';
+export function setupPathVariables(collection, config) {
+    if (!config?.enabled) {
+        return collection;
+    }
+    walkCollection(collection.item, (item) => {
+        if (!isRequest(item) || !item.request?.url)
+            return;
+        const url = item.request.url;
+        if (typeof url === 'string' || !url.variable)
+            return;
+        // Update path variables with mappings
+        url.variable = url.variable.map((variable) => {
+            const mapping = config.mapping?.[variable.key];
+            if (mapping) {
+                return {
+                    ...variable,
+                    value: mapping.reference,
+                    description: mapping.description || variable.description,
+                };
+            }
+            return variable;
+        });
+    });
+    return collection;
+}

package/dist/enrichers/preserveIds.d.ts

@@ -0,0 +1,5 @@
+/**
+ * ID Preservation - Maintains IDs across collection regenerations
+ */
+import type { PostmanCollection } from '@postman-enricher/shared';
+export declare function preserveIds(collection: PostmanCollection, existingPath?: string): PostmanCollection;

package/dist/enrichers/preserveIds.js

@@ -0,0 +1,47 @@
+/**
+ * ID Preservation - Maintains IDs across collection regenerations
+ */
+import { walkCollection, isRequest, getRequestMethod, } from '@postman-enricher/shared';
+import { readFileSync, existsSync } from 'fs';
+export function preserveIds(collection, existingPath) {
+    if (!existingPath || !existsSync(existingPath)) {
+        return collection;
+    }
+    try {
+        const existing = JSON.parse(readFileSync(existingPath, 'utf8'));
+        const idMap = buildIdMap(existing);
+        // Restore collection ID
+        if (existing.info?._postman_id) {
+            collection.info._postman_id = existing.info._postman_id;
+        }
+        // Restore item IDs
+        walkCollection(collection.item, (item) => {
+            const key = getItemKey(item);
+            const existingId = idMap.get(key);
+            if (existingId) {
+                item.id = existingId;
+            }
+        });
+        return collection;
+    }
+    catch {
+        return collection; // Silently fail if existing collection is invalid
+    }
+}
+function buildIdMap(collection) {
+    const map = new Map();
+    walkCollection(collection.item, (item) => {
+        if (item.id) {
+            const key = getItemKey(item);
+            map.set(key, item.id);
+        }
+    });
+    return map;
+}
+function getItemKey(item) {
+    if (isRequest(item)) {
+        const method = getRequestMethod(item);
+        return `${method}_${item.name}`;
+    }
+    return `folder_${item.name}`;
+}

package/dist/index.d.ts

@@ -8,13 +8,17 @@ import { addDescriptions } from './enrichers/descriptions.js';
 import { addExamples } from './enrichers/examples.js';
 import { setupVariables } from './enrichers/variables.js';
 import { addTests } from './enrichers/tests.js';
+import { organizeByResources } from './enrichers/organize.js';
+import { setupPathVariables } from './enrichers/pathVariables.js';
+import { preserveIds } from './enrichers/preserveIds.js';
 /**
  * Enrich a Postman collection with additional metadata and functionality
  * @param collection - Postman collection to enrich
  * @param config - Enrichment configuration (object or path to YAML file)
+ * @param existingCollectionPath - Optional path to existing collection for ID preservation
  * @returns Enriched Postman collection
  */
-export declare function enrichCollection(collection: PostmanCollection, config?: EnrichmentConfig | string): PostmanCollection;
+export declare function enrichCollection(collection: PostmanCollection, config?: EnrichmentConfig | string, existingCollectionPath?: string): PostmanCollection;
 /**
  * Load enrichment configuration from a YAML file
  * @param filePath - Path to YAML configuration file
@@ -24,4 +28,4 @@ export declare function loadConfigFromYaml(filePath: string): EnrichmentConfig;
 /**
  * Export individual enrichers for advanced usage
  */
-export { filterEndpoints, addDescriptions, addExamples, setupVariables, addTests, };
+export { filterEndpoints, addDescriptions, addExamples, setupVariables, addTests, organizeByResources, setupPathVariables, preserveIds, };

package/dist/index.js

@@ -9,34 +9,49 @@ import { addDescriptions } from './enrichers/descriptions.js';
 import { addExamples } from './enrichers/examples.js';
 import { setupVariables } from './enrichers/variables.js';
 import { addTests } from './enrichers/tests.js';
+import { organizeByResources } from './enrichers/organize.js';
+import { setupPathVariables } from './enrichers/pathVariables.js';
+import { preserveIds } from './enrichers/preserveIds.js';
 /**
  * Enrich a Postman collection with additional metadata and functionality
  * @param collection - Postman collection to enrich
  * @param config - Enrichment configuration (object or path to YAML file)
+ * @param existingCollectionPath - Optional path to existing collection for ID preservation
  * @returns Enriched Postman collection
  */
-export function enrichCollection(collection, config = {}) {
+export function enrichCollection(collection, config = {}, existingCollectionPath) {
     // Load config from YAML file if string path provided
     const enrichmentConfig = typeof config === 'string' ? loadConfigFromYaml(config) : config;
     let enriched = { ...collection };
-    // Apply enrichments in order
+    // 0. Preserve IDs from existing collection (if provided)
+    if (existingCollectionPath) {
+        enriched = preserveIds(enriched, existingCollectionPath);
+    }
     // 1. Filter endpoints first (reduce what we're working with)
     if (enrichmentConfig.filter) {
         enriched = filterEndpoints(enriched, enrichmentConfig.filter);
     }
-    // 2. Add descriptions (collection, folders, requests)
+    // 2. Organize by resource hierarchy
+    if (enrichmentConfig.organize) {
+        enriched = organizeByResources(enriched, enrichmentConfig.organize);
+    }
+    // 3. Add descriptions (collection, folders, requests)
     if (enrichmentConfig.descriptions) {
         enriched = addDescriptions(enriched, enrichmentConfig.descriptions);
     }
-    // 3. Add examples (request bodies and responses)
+    // 4. Add examples (request bodies and responses)
     if (enrichmentConfig.examples) {
         enriched = addExamples(enriched, enrichmentConfig.examples);
     }
-    // 4. Setup variables (path variables, environment variables)
+    // 5. Setup variables (path variables, environment variables)
     if (enrichmentConfig.variables) {
         enriched = setupVariables(enriched, enrichmentConfig.variables);
     }
-    // 5. Add test scripts
+    // 6. Setup path variables
+    if (enrichmentConfig.pathVariables) {
+        enriched = setupPathVariables(enriched, enrichmentConfig.pathVariables);
+    }
+    // 7. Add test scripts
     if (enrichmentConfig.tests) {
         enriched = addTests(enriched, enrichmentConfig.tests);
     }
@@ -59,4 +74,4 @@ export function loadConfigFromYaml(filePath) {
 /**
  * Export individual enrichers for advanced usage
  */
-export { filterEndpoints, addDescriptions, addExamples, setupVariables, addTests, };
+export { filterEndpoints, addDescriptions, addExamples, setupVariables, addTests, organizeByResources, setupPathVariables, preserveIds, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@postman-enricher/core",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Core enrichment logic for Postman Enricher",
   "type": "module",
   "main": "./dist/index.js",
@@ -16,7 +16,7 @@
   ],
   "dependencies": {
     "yaml": "^2.8.1",
-    "@postman-enricher/shared": "1.0.0"
+    "@postman-enricher/shared": "1.1.0"
   },
   "devDependencies": {
     "@anolilab/semantic-release-pnpm": "^3.0.0",