merge: resolve conflicts with main (ltree rename)

Author: pyramation

graphile/graphile-ltree/src/__tests__/ltree.test.ts

@@ -4,17 +4,14 @@ import { getConnections, seed } from 'graphile-test';
 import { join } from 'path';
 import type { PgTestClient } from 'pgsql-test';
 
-import { createLtreeOperatorFactory } from '../plugins/connection-filter-operators';
-import { LtreeExtensionDetectionPlugin } from '../plugins/detect-ltree';
-import { LtreeFolderFieldPlugin } from '../plugins/folder-field';
 import { createFolderOperatorFactory } from '../plugins/folder-filter-operators';
+import { LtreeExtensionDetectionPlugin } from '../plugins/detect-ltree';
 import { LtreeCodecPlugin } from '../plugins/ltree-codec';
 
 interface FileNode {
   id: number;
   filename: string;
   path: string;
-  pathTree: string;
 }
 
 interface AllFilesResult {
@@ -27,7 +24,6 @@ interface CategoryNode {
   id: number;
   name: string;
   treePath: string;
-  treePathTree: string;
 }
 
 interface AllCategoriesResult {
@@ -53,12 +49,10 @@ describe('graphile-ltree', () => {
       ],
       plugins: [
         LtreeExtensionDetectionPlugin,
-        LtreeCodecPlugin,
-        LtreeFolderFieldPlugin
+        LtreeCodecPlugin
       ],
       schema: {
         connectionFilterOperatorFactories: [
-          createLtreeOperatorFactory(),
           createFolderOperatorFactory()
         ]
       }
@@ -101,35 +95,20 @@ describe('graphile-ltree', () => {
     await db.afterEach();
   });
 
-  // ─── Field naming ─────────────────────────────────────────────────────
+  // ─── File-path output ──────────────────────────────────────────────────
 
-  describe('field naming', () => {
-    it('renames ltree column to pathTree (dot-delimited)', async () => {
+  describe('file-path output', () => {
+    it('returns path as slash-delimited file path', async () => {
       const result = await query<AllFilesResult>(`{
         allFiles {
-          nodes { id filename pathTree }
+          nodes { id filename path }
         }
       }`);
       expect(result.errors).toBeUndefined();
       const nodes = result.data!.allFiles.nodes;
       expect(nodes.length).toBe(10);
       const docsFile = nodes.find(n => n.filename === 'contract.pdf');
       expect(docsFile).toBeDefined();
-      expect(docsFile!.pathTree).toBe('projects.alpha.docs');
-    });
-
-    it('exposes path as slash-delimited folder field', async () => {
-      const result = await query<AllFilesResult>(`{
-        allFiles {
-          nodes { filename path pathTree }
-        }
-      }`);
-      expect(result.errors).toBeUndefined();
-      const docsFile = result.data!.allFiles.nodes.find(
-        n => n.filename === 'contract.pdf'
-      );
-      expect(docsFile).toBeDefined();
-      expect(docsFile!.pathTree).toBe('projects.alpha.docs');
       expect(docsFile!.path).toBe('/projects/alpha/docs');
     });
 
@@ -150,26 +129,25 @@ describe('graphile-ltree', () => {
     it('works on other tables with ltree columns', async () => {
       const result = await query<AllCategoriesResult>(`{
         allCategories {
-          nodes { name treePath treePathTree }
+          nodes { name treePath }
         }
       }`);
       expect(result.errors).toBeUndefined();
       const laptops = result.data!.allCategories.nodes.find(
         n => n.name === 'Laptops'
       );
       expect(laptops).toBeDefined();
-      expect(laptops!.treePathTree).toBe('shop.electronics.laptops');
       expect(laptops!.treePath).toBe('/shop/electronics/laptops');
     });
   });
 
-  // ─── Raw ltree operators (on pathTree) ────────────────────────────────
+  // ─── Filter operators (slash-delimited input) ──────────────────────────
 
-  describe('isAncestorOf filter', () => {
-    it('finds files under a given path', async () => {
+  describe('within filter', () => {
+    it('finds files within a folder using slash paths', async () => {
       const result = await query<AllFilesResult>(`{
-        allFiles(where: { pathTree: { isAncestorOf: "projects.alpha" } }) {
-          nodes { filename }
+        allFiles(where: { path: { within: "/projects/alpha" } }) {
+          nodes { filename path }
         }
       }`);
       expect(result.errors).toBeUndefined();
@@ -184,37 +162,37 @@ describe('graphile-ltree', () => {
 
     it('includes the exact path itself', async () => {
       const result = await query<AllFilesResult>(`{
-        allFiles(where: { pathTree: { isAncestorOf: "projects.alpha" } }) {
-          nodes { filename pathTree }
+        allFiles(where: { path: { within: "/projects/alpha" } }) {
+          nodes { filename path }
         }
       }`);
       expect(result.errors).toBeUndefined();
-      const paths = result.data!.allFiles.nodes.map(n => n.pathTree);
-      expect(paths).toContain('projects.alpha');
+      const paths = result.data!.allFiles.nodes.map(n => n.path);
+      expect(paths).toContain('/projects/alpha');
     });
   });
 
-  describe('isDescendantOf filter', () => {
-    it('finds ancestors of a given path', async () => {
+  describe('ancestorOf filter', () => {
+    it('finds ancestor folders using slash paths', async () => {
       const result = await query<AllFilesResult>(`{
-        allFiles(where: { pathTree: { isDescendantOf: "projects.alpha.docs.images" } }) {
-          nodes { filename pathTree }
+        allFiles(where: { path: { ancestorOf: "/projects/alpha/docs/images" } }) {
+          nodes { filename path }
         }
       }`);
       expect(result.errors).toBeUndefined();
-      const paths = result.data!.allFiles.nodes.map(n => n.pathTree);
-      expect(paths).toContain('projects.alpha.docs.images');
-      expect(paths).toContain('projects.alpha.docs');
-      expect(paths).toContain('projects.alpha');
-      expect(paths).toContain('projects');
+      const paths = result.data!.allFiles.nodes.map(n => n.path);
+      expect(paths).toContain('/projects/alpha/docs/images');
+      expect(paths).toContain('/projects/alpha/docs');
+      expect(paths).toContain('/projects/alpha');
+      expect(paths).toContain('/projects');
     });
   });
 
-  describe('matchesGlob filter', () => {
-    it('matches single-level wildcard', async () => {
+  describe('glob filter', () => {
+    it('matches single-level wildcard with slash paths', async () => {
       const result = await query<AllFilesResult>(`{
-        allFiles(where: { pathTree: { matchesGlob: "projects.*" } }) {
-          nodes { filename pathTree }
+        allFiles(where: { path: { glob: "/projects/*" } }) {
+          nodes { filename path }
         }
       }`);
       expect(result.errors).toBeUndefined();
@@ -224,10 +202,10 @@ describe('graphile-ltree', () => {
       expect(filenames).not.toContain('contract.pdf');
     });
 
-    it('matches multi-level wildcard', async () => {
+    it('matches multi-level wildcard with slash paths', async () => {
       const result = await query<AllFilesResult>(`{
-        allFiles(where: { pathTree: { matchesGlob: "projects.*.docs" } }) {
-          nodes { filename pathTree }
+        allFiles(where: { path: { glob: "/projects/*/docs" } }) {
+          nodes { filename path }
         }
       }`);
       expect(result.errors).toBeUndefined();
@@ -238,67 +216,31 @@ describe('graphile-ltree', () => {
     });
   });
 
-  // ─── Folder operators (slash-path interface, on pathTree) ─────────────
+  // ─── Slash-to-ltree conversion (round-trip) ────────────────────────────
 
-  describe('within filter (folder operator)', () => {
-    it('finds files within a folder using slash paths', async () => {
+  describe('slash-to-ltree conversion', () => {
+    it('accepts slash paths on input and stores as ltree', async () => {
       const result = await query<AllFilesResult>(`{
-        allFiles(where: { pathTree: { within: "/projects/alpha" } }) {
+        allFiles(where: { path: { within: "/users" } }) {
           nodes { filename path }
         }
       }`);
       expect(result.errors).toBeUndefined();
       const filenames = result.data!.allFiles.nodes.map(n => n.filename);
-      expect(filenames).toContain('alpha-spec.pdf');
-      expect(filenames).toContain('contract.pdf');
-      expect(filenames).toContain('design.png');
-      expect(filenames).toContain('budget.xlsx');
-      expect(filenames).not.toContain('beta-spec.pdf');
-      expect(filenames).not.toContain('root.txt');
+      expect(filenames).toContain('avatar.jpg');
+      expect(filenames).toContain('notes.txt');
     });
-  });
 
-  describe('ancestorOf filter (folder operator)', () => {
-    it('finds ancestor folders using slash paths', async () => {
+    it('dot-delimited input still works (backward compat)', async () => {
       const result = await query<AllFilesResult>(`{
-        allFiles(where: { pathTree: { ancestorOf: "/projects/alpha/docs/images" } }) {
-          nodes { filename path }
-        }
-      }`);
-      expect(result.errors).toBeUndefined();
-      const folders = result.data!.allFiles.nodes.map(n => n.path);
-      expect(folders).toContain('/projects/alpha/docs/images');
-      expect(folders).toContain('/projects/alpha/docs');
-      expect(folders).toContain('/projects/alpha');
-      expect(folders).toContain('/projects');
-    });
-  });
-
-  describe('glob filter (folder operator)', () => {
-    it('matches single-level wildcard with slash paths', async () => {
-      const result = await query<AllFilesResult>(`{
-        allFiles(where: { pathTree: { glob: "/projects/*" } }) {
+        allFiles(where: { path: { within: "projects.alpha" } }) {
           nodes { filename path }
         }
       }`);
       expect(result.errors).toBeUndefined();
       const filenames = result.data!.allFiles.nodes.map(n => n.filename);
       expect(filenames).toContain('alpha-spec.pdf');
-      expect(filenames).toContain('beta-spec.pdf');
-      expect(filenames).not.toContain('contract.pdf');
-    });
-
-    it('matches multi-level wildcard with slash paths', async () => {
-      const result = await query<AllFilesResult>(`{
-        allFiles(where: { pathTree: { glob: "/projects/*/docs" } }) {
-          nodes { filename path }
-        }
-      }`);
-      expect(result.errors).toBeUndefined();
-      const filenames = result.data!.allFiles.nodes.map(n => n.filename);
       expect(filenames).toContain('contract.pdf');
-      expect(filenames).toContain('proposal.docx');
-      expect(filenames).not.toContain('design.png');
     });
   });
 });

graphile/graphile-ltree/src/index.ts

@@ -1,17 +1,12 @@
 /**
  * graphile-ltree — PostGraphile v5 ltree Plugin
  *
- * Two presets:
- *
- * - `GraphileLtreePreset` — base ltree operators (isAncestorOf, isDescendantOf, matchesGlob)
- * - `GraphileFolderPreset` — folder-oriented layer (within, ancestorOf, glob) + pathFolder fields
+ * File-path syntax for ltree columns. The LTree scalar auto-converts between
+ * slash-delimited file paths ("/projects/alpha/docs") in the GraphQL API and
+ * dot-delimited ltree ("projects.alpha.docs") in PostgreSQL.
  *
  * @example
  * ```typescript
- * // For folder-style interface (recommended):
- * import { GraphileFolderPreset } from 'graphile-ltree';
- *
- * // For raw ltree operators only:
  * import { GraphileLtreePreset } from 'graphile-ltree';
  * ```
  */
@@ -22,9 +17,12 @@ export { GraphileFolderPreset, GraphileLtreePreset } from './preset';
 // Individual plugins
 export type { LtreeExtensionInfo } from './plugins/detect-ltree';
 export { LtreeExtensionDetectionPlugin } from './plugins/detect-ltree';
-export { LtreeFolderFieldPlugin } from './plugins/folder-field';
-export { LTREE_SCALAR_NAME, LtreeCodecPlugin } from './plugins/ltree-codec';
+export { ltreeToSlash, LTREE_SCALAR_NAME, LtreeCodecPlugin, slashToLtree } from './plugins/ltree-codec';
 
 // Connection filter operator factories
-export { createLtreeOperatorFactory } from './plugins/connection-filter-operators';
 export { createFolderOperatorFactory } from './plugins/folder-filter-operators';
+
+// Deprecated — folder field plugin is no longer needed (scalar handles conversion)
+export { LtreeFolderFieldPlugin } from './plugins/folder-field';
+// Deprecated — use createFolderOperatorFactory instead (better operator names)
+export { createLtreeOperatorFactory } from './plugins/connection-filter-operators';