@stonecrop/rockfoil 0.7.0

package/dist/rockfoil.tsbuildinfo

@@ -0,0 +1 @@
+{"version":"5.9.3"}

package/dist/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './middleware/postgraphile';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,2BAA2B,CAAA;AACzC,cAAc,SAAS,CAAA"}

package/dist/src/index.js

@@ -0,0 +1,2 @@
+export * from './middleware/postgraphile';
+export * from './types';

package/dist/src/middleware/postgraphile.d.ts

@@ -0,0 +1,7 @@
+import type { HookConfig } from '../types';
+/**
+ * Creates a PostGraphile plugin that wraps GraphQL query and mutation plans with before/after hooks
+ * @public
+ */
+export declare const createPglRockfoilPlugin: (hookMap: HookConfig) => GraphileConfig.Plugin;
+//# sourceMappingURL=postgraphile.d.ts.map

package/dist/src/middleware/postgraphile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgraphile.d.ts","sourceRoot":"","sources":["../../../src/middleware/postgraphile.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAY,MAAM,UAAU,CAAA;AAEpD;;;GAGG;AACH,eAAO,MAAM,uBAAuB,GAAI,SAAS,UAAU,0BAoD1D,CAAA"}

package/dist/src/middleware/postgraphile.js

@@ -0,0 +1,49 @@
+import { wrapPlans } from 'postgraphile/utils';
+/**
+ * Creates a PostGraphile plugin that wraps GraphQL query and mutation plans with before/after hooks
+ * @public
+ */
+export const createPglRockfoilPlugin = (hookMap) => {
+    const queryPlans = {};
+    const mutationPlans = {};
+    for (const [fieldname, plans] of Object.entries(hookMap)) {
+        if (plans.beforeQuery || plans.afterQuery) {
+            queryPlans[fieldname] = {
+                plan: (plan, $source, fieldArgs, info) => {
+                    // Process before query hooks
+                    if (plans.beforeQuery) {
+                        plans.beforeQuery(plan, $source, fieldArgs, info);
+                    }
+                    // Execute the query plan
+                    let $result = plan();
+                    // Process after query hooks
+                    if (plans.afterQuery) {
+                        $result = plans.afterQuery($result, plan, $source, fieldArgs, info);
+                    }
+                    return $result;
+                },
+            };
+        }
+        if (plans.beforeMutation || plans.afterMutation) {
+            mutationPlans[fieldname] = {
+                plan: (plan, $source, fieldArgs, info) => {
+                    // Process before mutation hooks
+                    if (plans.beforeMutation) {
+                        plans.beforeMutation(plan, $source, fieldArgs, info);
+                    }
+                    // Execute the mutation plan
+                    let $result = plan();
+                    // Process after mutation hooks
+                    if (plans.afterMutation) {
+                        $result = plans.afterMutation($result, plan, $source, fieldArgs, info);
+                    }
+                    return $result;
+                },
+            };
+        }
+    }
+    return wrapPlans({
+        Query: queryPlans,
+        Mutation: mutationPlans,
+    });
+};

package/dist/src/types/index.d.ts

@@ -0,0 +1,32 @@
+import type { ExecutableStep, FieldArgs, FieldInfo } from 'postgraphile/grafast';
+import type { PlanWrapperFn, PlanWrapperRule } from 'postgraphile/utils';
+/**
+ * Configuration object mapping field names to their before/after hooks for queries and mutations
+ * @public
+ */
+export interface HookConfig {
+    /**
+     * Hook configuration for a specific field
+     */
+    [fieldName: string]: {
+        /** Function to execute before a query operation */
+        beforeQuery?: PlanWrapperFn;
+        /** Function to execute after a query operation */
+        afterQuery?: (result: any, plan: any, $source: ExecutableStep, fieldArgs: FieldArgs, info: FieldInfo) => any;
+        /** Function to execute before a mutation operation */
+        beforeMutation?: PlanWrapperFn;
+        /** Function to execute after a mutation operation */
+        afterMutation?: (result: any, plan: any, $source: ExecutableStep, fieldArgs: FieldArgs, info: FieldInfo) => any;
+    };
+}
+/**
+ * Internal mapping of field names to their plan wrapper rules
+ * @public
+ */
+export interface HookPlan {
+    /**
+     * Plan wrapper rule for a specific field
+     */
+    [fieldName: string]: PlanWrapperRule;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/src/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAChF,OAAO,KAAK,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAExE;;;GAGG;AACH,MAAM,WAAW,UAAU;IAC1B;;OAEG;IACH,CAAC,SAAS,EAAE,MAAM,GAAG;QACpB,mDAAmD;QACnD,WAAW,CAAC,EAAE,aAAa,CAAA;QAC3B,kDAAkD;QAClD,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,KAAK,GAAG,CAAA;QAC5G,sDAAsD;QACtD,cAAc,CAAC,EAAE,aAAa,CAAA;QAC9B,qDAAqD;QACrD,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,SAAS,KAAK,GAAG,CAAA;KAC/G,CAAA;CACD;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,CAAC,SAAS,EAAE,MAAM,GAAG,eAAe,CAAA;CACpC"}

package/dist/tests/postgraphile.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=postgraphile.test.d.ts.map

package/dist/tests/postgraphile.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"postgraphile.test.d.ts","sourceRoot":"","sources":["../../tests/postgraphile.test.ts"],"names":[],"mappings":""}

package/dist/tests/postgraphile.test.js

@@ -0,0 +1,58 @@
+import { describe, it, expect, vi } from 'vitest';
+// Mock postgraphile/utils with a simple implementation
+vi.mock('postgraphile/utils', () => ({
+    wrapPlans: (config) => ({
+        name: 'TestPlugin',
+        version: '1.0.0',
+        _config: config, // Store config for testing
+    }),
+}));
+import { createPglRockfoilPlugin } from '../src/middleware/postgraphile';
+describe('Rockfoil PostGraphile Plugin', () => {
+    describe('createPglRockfoilPlugin', () => {
+        it('should create a valid plugin with empty hook map', () => {
+            const plugin = createPglRockfoilPlugin({});
+            expect(plugin).toBeDefined();
+            expect(plugin.name).toBe('TestPlugin');
+            expect(plugin.version).toBe('1.0.0');
+        });
+        it('should create a plugin with query hooks', () => {
+            const hookMap = {
+                testField: {
+                    beforeQuery: vi.fn(),
+                    afterQuery: vi.fn(),
+                },
+            };
+            const plugin = createPglRockfoilPlugin(hookMap);
+            expect(plugin).toBeDefined();
+            expect(plugin.name).toBe('TestPlugin');
+        });
+        it('should create a plugin with mutation hooks', () => {
+            const hookMap = {
+                createTest: {
+                    beforeMutation: vi.fn(),
+                    afterMutation: vi.fn(),
+                },
+            };
+            const plugin = createPglRockfoilPlugin(hookMap);
+            expect(plugin).toBeDefined();
+            expect(plugin.name).toBe('TestPlugin');
+        });
+        it('should handle complex hook map', () => {
+            const hookMap = {
+                field1: {
+                    beforeQuery: vi.fn(),
+                },
+                field2: {
+                    afterQuery: vi.fn(),
+                },
+                field3: {
+                    beforeMutation: vi.fn(),
+                    afterMutation: vi.fn(),
+                },
+            };
+            const plugin = createPglRockfoilPlugin(hookMap);
+            expect(plugin).toBeDefined();
+        });
+    });
+});

package/dist/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.55.2"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@stonecrop/rockfoil",
+  "version": "0.7.0",
+  "license": "MIT",
+  "type": "module",
+  "author": {
+    "name": "Tyler Matteson",
+    "email": "tyler@agritheory.com"
+  },
+  "homepage": "https://github.com/agritheory/rockfoil#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/agritheory/stonecrop",
+    "directory": "rockfoil"
+  },
+  "bugs": {
+    "url": "https://github.com/agritheory/stonecrop/issues"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/src/index.d.ts",
+        "default": "./dist/rockfoil.js"
+      },
+      "require": "./dist/rockfoil.umd.cjs"
+    },
+    "./types": {
+      "import": "./dist/src/types/index.d.ts",
+      "require": "./dist/src/types/index.d.ts"
+    },
+    "./styles": "./dist/assets/index.css"
+  },
+  "typings": "./dist/index.d.ts",
+  "files": [
+    "dist/*",
+    "src/*"
+  ],
+  "dependencies": {
+    "graphql": "^16.12.0",
+    "postgraphile": "^5.0.0-rc.3"
+  },
+  "devDependencies": {
+    "@rushstack/heft": "^1.1.7",
+    "@types/node": "^22.19.5",
+    "@vitest/coverage-istanbul": "^4.0.17",
+    "@vitest/ui": "^4.0.17",
+    "graphile-build": "^5.0.0-rc.2",
+    "jsdom": "^27.4.0",
+    "madr": "^4.0.0",
+    "typescript": "^5.9.3",
+    "vite": "^7.3.1",
+    "vitest": "^4.0.17",
+    "stonecrop-rig": "0.2.22"
+  },
+  "engines": {
+    "node": ">=22.5.0"
+  },
+  "scripts": {
+    "_phase:build": "heft build && vite build && rushx docs",
+    "prepublish": "heft build && vite build && rushx docs",
+    "build": "heft build && vite build && rushx docs",
+    "dev": "vite",
+    "docs": "bash ../common/scripts/run-docs.sh rockfoil",
+    "lint": "eslint .",
+    "preview": "vite preview",
+    "test": "vitest run --coverage.enabled false",
+    "test:watch": "vitest watch",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui"
+  }
+}

package/src/index.ts

@@ -0,0 +1,2 @@
+export * from './middleware/postgraphile'
+export * from './types'

package/src/middleware/postgraphile.ts

@@ -0,0 +1,61 @@
+import { wrapPlans } from 'postgraphile/utils'
+
+import type { HookConfig, HookPlan } from '../types'
+
+/**
+ * Creates a PostGraphile plugin that wraps GraphQL query and mutation plans with before/after hooks
+ * @public
+ */
+export const createPglRockfoilPlugin = (hookMap: HookConfig) => {
+	const queryPlans: HookPlan = {}
+	const mutationPlans: HookPlan = {}
+
+	for (const [fieldname, plans] of Object.entries(hookMap)) {
+		if (plans.beforeQuery || plans.afterQuery) {
+			queryPlans[fieldname] = {
+				plan: (plan, $source, fieldArgs, info) => {
+					// Process before query hooks
+					if (plans.beforeQuery) {
+						plans.beforeQuery(plan, $source, fieldArgs, info)
+					}
+
+					// Execute the query plan
+					let $result = plan()
+
+					// Process after query hooks
+					if (plans.afterQuery) {
+						$result = plans.afterQuery($result, plan, $source, fieldArgs, info)
+					}
+
+					return $result
+				},
+			}
+		}
+
+		if (plans.beforeMutation || plans.afterMutation) {
+			mutationPlans[fieldname] = {
+				plan: (plan, $source, fieldArgs, info) => {
+					// Process before mutation hooks
+					if (plans.beforeMutation) {
+						plans.beforeMutation(plan, $source, fieldArgs, info)
+					}
+
+					// Execute the mutation plan
+					let $result = plan()
+
+					// Process after mutation hooks
+					if (plans.afterMutation) {
+						$result = plans.afterMutation($result, plan, $source, fieldArgs, info)
+					}
+
+					return $result
+				},
+			}
+		}
+	}
+
+	return wrapPlans({
+		Query: queryPlans,
+		Mutation: mutationPlans,
+	})
+}

package/src/types/index.ts

@@ -0,0 +1,33 @@
+import type { ExecutableStep, FieldArgs, FieldInfo } from 'postgraphile/grafast'
+import type { PlanWrapperFn, PlanWrapperRule } from 'postgraphile/utils'
+
+/**
+ * Configuration object mapping field names to their before/after hooks for queries and mutations
+ * @public
+ */
+export interface HookConfig {
+	/**
+	 * Hook configuration for a specific field
+	 */
+	[fieldName: string]: {
+		/** Function to execute before a query operation */
+		beforeQuery?: PlanWrapperFn
+		/** Function to execute after a query operation */
+		afterQuery?: (result: any, plan: any, $source: ExecutableStep, fieldArgs: FieldArgs, info: FieldInfo) => any
+		/** Function to execute before a mutation operation */
+		beforeMutation?: PlanWrapperFn
+		/** Function to execute after a mutation operation */
+		afterMutation?: (result: any, plan: any, $source: ExecutableStep, fieldArgs: FieldArgs, info: FieldInfo) => any
+	}
+}
+
+/**
+ * Internal mapping of field names to their plan wrapper rules
+ * @public
+ */
+export interface HookPlan {
+	/**
+	 * Plan wrapper rule for a specific field
+	 */
+	[fieldName: string]: PlanWrapperRule
+}