@svadmin/graphql 0.0.6

package/README.md

@@ -0,0 +1,89 @@
+# @svadmin/graphql
+
+Generic GraphQL DataProvider for `svadmin`.
+
+Because GraphQL APIs do not share a universal convention for CRUD operations (unlike REST), this generic provider requires you to pass your GraphQL queries and mutations via the `meta.query` property in svadmin hooks.
+
+## Installation
+
+```bash
+bun add @svadmin/graphql graphql-request graphql
+```
+
+## Basic Usage
+
+Initialize the provider with a `GraphQLClient`:
+
+```typescript
+import { AdminApp } from '@svadmin/ui';
+import { createGraphQLDataProvider } from '@svadmin/graphql';
+import { GraphQLClient } from 'graphql-request';
+
+const client = new GraphQLClient('https://your-graphql-endpoint/graphql', {
+  headers: {
+    Authorization: `Bearer YOUR_TOKEN`,
+  },
+});
+
+const dataProvider = createGraphQLDataProvider({ client });
+```
+
+## Using Hooks with GraphQL
+
+Pass your `gql` queries into the `meta` prop of your hooks.
+
+### Fetching a List (`useList` / `useTable`)
+
+```typescript
+import { useTable } from '@svadmin/core';
+import { gql } from 'graphql-request';
+
+const POSTS_QUERY = gql`
+  query GetPosts($limit: Int, $offset: Int) {
+    posts(limit: $limit, offset: $offset) {
+      id
+      title
+      content
+    }
+    posts_aggregate {
+      aggregate {
+        count
+      }
+    }
+  }
+`;
+
+// In your Svelte component
+const table = useTable({
+  resource: 'posts',
+  meta: {
+    query: POSTS_QUERY
+  }
+});
+```
+
+*(Note: If your API returns data in a deeply nested structure like `posts_aggregate.aggregate.count`, you may need to wrap this provider or map the response in your data hook overrides).*
+
+### Creating a Record (`useCreate` / `useForm`)
+
+```typescript
+import { useForm } from '@svadmin/core';
+import { gql } from 'graphql-request';
+
+const CREATE_POST_MUTATION = gql`
+  mutation CreatePost($title: String!, $content: String!) {
+    insert_posts_one(object: {title: $title, content: $content}) {
+      id
+      title
+    }
+  }
+`;
+
+const form = useForm({
+  resource: 'posts',
+  action: 'create',
+  meta: {
+    query: CREATE_POST_MUTATION
+  }
+});
+```

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@svadmin/graphql",
+  "version": "0.0.6",
+  "description": "GraphQL DataProvider for svadmin",
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "src/**/*"
+  ],
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    }
+  },
+  "peerDependencies": {
+    "@svadmin/core": "0.0.5"
+  },
+  "dependencies": {
+    "graphql-request": "^7.1.0"
+  },
+  "license": "MIT"
+}

package/src/data-provider.ts

@@ -0,0 +1,92 @@
+import type { DataProvider } from '@svadmin/core';
+import { GraphQLClient } from 'graphql-request';
+
+export interface GraphQLDataProviderOptions {
+  client: GraphQLClient;
+}
+
+/**
+ * Creates a generic GraphQL DataProvider.
+ * Requires queries to be passed in hooks via the `meta.query` property.
+ */
+export function createGraphQLDataProvider(options: GraphQLDataProviderOptions): DataProvider {
+  const { client } = options;
+
+  return {
+    getApiUrl: () => 'graphql',
+
+    getList: async ({ resource, pagination, sorters, filters, meta }) => {
+      if (!meta?.query) {
+        throw new Error(`[svadmin/graphql] getList requires 'meta.query' providing the GraphQL query for resource '${resource}'`);
+      }
+
+      const metaVars = (meta.variables as Record<string, unknown>) || {};
+      const variables = {
+        ...metaVars,
+        limit: pagination?.pageSize,
+        offset: pagination && pagination.current && pagination.pageSize ? (pagination.current - 1) * pagination.pageSize : undefined,
+      };
+
+      const response = await client.request<{ data: any[], total?: number }>(meta.query as any, variables);
+      
+      return {
+        data: response.data || [],
+        total: response.total || 0,
+      };
+    },
+
+    getOne: async ({ resource, id, meta }) => {
+      if (!meta?.query) {
+        throw new Error(`[svadmin/graphql] getOne requires 'meta.query' providing the GraphQL query for resource '${resource}'`);
+      }
+
+      const metaVars = (meta.variables as Record<string, unknown>) || {};
+      const variables = { id, ...metaVars };
+      const response = await client.request<{ data: any }>(meta.query as any, variables);
+
+      return {
+        data: response.data,
+      };
+    },
+
+    create: async ({ resource, variables, meta }) => {
+      if (!meta?.query) {
+        throw new Error(`[svadmin/graphql] create requires 'meta.query' providing the GraphQL mutation`);
+      }
+
+      const metaVars = (meta.variables as Record<string, unknown>) || {};
+      const response = await client.request<{ data: any }>(meta.query as any, { ...variables, ...metaVars });
+      return { data: response.data };
+    },
+
+    update: async ({ resource, id, variables, meta }) => {
+      if (!meta?.query) {
+        throw new Error(`[svadmin/graphql] update requires 'meta.query' providing the GraphQL mutation`);
+      }
+
+      const metaVars = (meta.variables as Record<string, unknown>) || {};
+      const mutationVars = { id, ...variables, ...metaVars };
+      const response = await client.request<{ data: any }>(meta.query as any, mutationVars);
+      return { data: response.data };
+    },
+
+    deleteOne: async ({ resource, id, meta }) => {
+      if (!meta?.query) {
+        throw new Error(`[svadmin/graphql] deleteOne requires 'meta.query' providing the GraphQL mutation`);
+      }
+
+      const metaVars = (meta.variables as Record<string, unknown>) || {};
+      const variables = { id, ...metaVars };
+      const response = await client.request<{ data: any }>(meta.query as any, variables);
+      return { data: response.data };
+    },
+
+    custom: async ({ url, method, filters, sorters, payload, headers, meta }) => {
+      if (!meta?.query) {
+        throw new Error(`[svadmin/graphql] custom requires 'meta.query' providing the GraphQL query/mutation`);
+      }
+      const response = await client.request<any>(meta.query as any, payload as any, headers as any);
+      return { data: response };
+    }
+  };
+}

package/src/index.ts

@@ -0,0 +1 @@
+export { createGraphQLDataProvider } from './data-provider';