@stonecrop/graphql-client 0.13.14 → 0.15.0

package/src/client.ts

@@ -7,6 +7,7 @@ import type {
 	GetRecordsOptions,
 } from '@stonecrop/schema'
 import type { GetRecordResult } from './types'
+import { GET_META_QUERY, GET_ALL_META_QUERY, RUN_ACTION_MUTATION } from './queries'
 
 export type { DoctypeContext, DoctypeRef }
 export type { GetRecordResult }
@@ -88,48 +89,9 @@ export class StonecropClient implements DataClient {
 		const cached = this.metaCache.get(context.doctype)
 		if (cached) return cached
 
-		const result = await this.query<{ stonecropMeta: DoctypeMeta | null }>(
-			`
-			query GetMeta($doctype: String!) {
-				stonecropMeta(doctype: $doctype) {
-					name
-					slug
-					fields {
-						fieldname
-						fieldtype
-						component
-						label
-						width
-						align
-						required
-						readOnly
-						edit
-						hidden
-						default
-						options
-						mask
-						precision
-						scale
-						mode
-						validation
-					}
-					workflow {
-						states
-						actions {
-							label
-							handler
-							requiredFields
-							allowedStates
-							confirm
-							args
-						}
-					}
-					inherits
-				}
-			}
-			`,
-			{ doctype: context.doctype }
-		)
+		const result = await this.query<{ stonecropMeta: DoctypeMeta | null }>(GET_META_QUERY, {
+			doctype: context.doctype,
+		})
 
 		if (result.stonecropMeta) {
 			this.metaCache.set(context.doctype, result.stonecropMeta)
@@ -142,47 +104,7 @@ export class StonecropClient implements DataClient {
 	 * Get all doctype metadata
 	 */
 	async getAllMeta(): Promise<DoctypeMeta[]> {
-		const result = await this.query<{ stonecropAllMeta: DoctypeMeta[] }>(
-			`
-			query GetAllMeta {
-				stonecropAllMeta {
-					name
-					slug
-					fields {
-						fieldname
-						fieldtype
-						component
-						label
-						width
-						align
-						required
-						readOnly
-						edit
-						hidden
-						default
-						options
-						mask
-						precision
-						scale
-						mode
-						validation
-					}
-					workflow {
-						states
-						actions {
-							label
-							handler
-							requiredFields
-							allowedStates
-							confirm
-							args
-						}
-					}
-					inherits
-				}
-			}
-			`
-		)
+		const result = await this.query<{ stonecropAllMeta: DoctypeMeta[] }>(GET_ALL_META_QUERY)
 
 		for (const meta of result.stonecropAllMeta) {
 			this.metaCache.set(meta.name, meta)
@@ -284,22 +206,11 @@ export class StonecropClient implements DataClient {
 	): Promise<{ success: boolean; data: unknown; error: string | null }> {
 		const result = await this.query<{
 			stonecropAction: { success: boolean; data: unknown; error: string | null }
-		}>(
-			`
-			mutation RunAction($doctype: String!, $action: String!, $args: JSON) {
-				stonecropAction(doctype: $doctype, action: $action, args: $args) {
-					success
-					data
-					error
-				}
-			}
-			`,
-			{
-				doctype: doctype.name,
-				action,
-				args,
-			}
-		)
+		}>(RUN_ACTION_MUTATION, {
+			doctype: doctype.name,
+			action,
+			args,
+		})
 
 		return result.stonecropAction
 	}

package/src/queries.ts

@@ -0,0 +1,106 @@
+/**
+ * GraphQL query documents sent by {@link StonecropClient} to the middleware.
+ *
+ * These are the client's half of the wire contract with `@stonecrop/graphql-middleware`.
+ * They live here as exported constants (rather than inline in the client methods) so the
+ * cross-package contract test can validate the exact strings the client sends against the
+ * middleware's published SDL — a field the server drops while a query still selects it must
+ * fail CI, not production.
+ *
+ * @public
+ */
+export const GET_META_QUERY = `
+	query GetMeta($doctype: String!) {
+		stonecropMeta(doctype: $doctype) {
+			name
+			slug
+			fields {
+				kind
+				fieldname
+				component
+				doctype
+				label
+				width
+				align
+				edit
+				mask
+				format
+				mode
+				options
+				required
+				readOnly
+				hidden
+				default
+				validation
+				cardinality
+				source
+			}
+			workflow {
+				states
+				actions {
+					label
+					requiredFields
+					allowedStates
+				}
+			}
+			inherits
+		}
+	}
+`
+
+/**
+ * Mutation document for dispatching a workflow action (the server-owned transition).
+ * @public
+ */
+export const RUN_ACTION_MUTATION = `
+	mutation RunAction($doctype: String!, $action: String!, $args: JSON) {
+		stonecropAction(doctype: $doctype, action: $action, args: $args) {
+			success
+			data
+			error
+		}
+	}
+`
+
+/**
+ * Query document for fetching all doctype metadata.
+ * @public
+ */
+export const GET_ALL_META_QUERY = `
+	query GetAllMeta {
+		stonecropAllMeta {
+			name
+			slug
+			fields {
+				kind
+				fieldname
+				component
+				doctype
+				label
+				width
+				align
+				edit
+				mask
+				format
+				mode
+				options
+				required
+				readOnly
+				hidden
+				default
+				validation
+				cardinality
+				source
+			}
+			workflow {
+				states
+				actions {
+					label
+					requiredFields
+					allowedStates
+				}
+			}
+			inherits
+		}
+	}
+`

package/dist/client.js

@@ -1,247 +0,0 @@
-/**
- * Client for interacting with Stonecrop GraphQL API.
- *
- * Acts as a transport layer — it passes requests to the middleware and returns
- * merged results. Does not construct queries itself.
- *
- * @public
- */
-export class StonecropClient {
-    endpoint;
-    headers;
-    metaCache = new Map();
-    constructor(options) {
-        this.endpoint = options.endpoint;
-        this.headers = {
-            'Content-Type': 'application/json',
-            ...options.headers,
-        };
-    }
-    /**
-     * Execute a GraphQL query against the configured endpoint.
-     *
-     * @param query - GraphQL query string
-     * @param variables - Query variables
-     * @throws Error if the GraphQL response contains errors
-     */
-    async query(query, variables) {
-        const response = await fetch(this.endpoint, {
-            method: 'POST',
-            headers: this.headers,
-            body: JSON.stringify({ query, variables }),
-        });
-        const json = (await response.json());
-        if (json.errors?.length) {
-            throw new Error(json.errors[0].message);
-        }
-        return json.data;
-    }
-    /**
-     * Execute a GraphQL mutation. Delegates to query() since both use POST.
-     *
-     * @param mutation - GraphQL mutation string
-     * @param variables - Mutation variables
-     */
-    async mutate(mutation, variables) {
-        return this.query(mutation, variables);
-    }
-    /**
-     * Get doctype metadata
-     * @param context - Doctype context containing doctype name
-     */
-    async getMeta(context) {
-        const cached = this.metaCache.get(context.doctype);
-        if (cached)
-            return cached;
-        const result = await this.query(`
-			query GetMeta($doctype: String!) {
-				stonecropMeta(doctype: $doctype) {
-					name
-					slug
-					tableName
-					fields {
-						fieldname
-						fieldtype
-						component
-						label
-						width
-						align
-						required
-						readOnly
-						edit
-						hidden
-						default
-						options
-						mask
-						precision
-						scale
-						mode
-						validation
-					}
-					workflow {
-						states
-						actions {
-							label
-							handler
-							requiredFields
-							allowedStates
-							confirm
-							args
-						}
-					}
-					inherits
-				}
-			}
-			`, { doctype: context.doctype });
-        if (result.stonecropMeta) {
-            this.metaCache.set(context.doctype, result.stonecropMeta);
-        }
-        return result.stonecropMeta;
-    }
-    /**
-     * Get all doctype metadata
-     */
-    async getAllMeta() {
-        const result = await this.query(`
-			query GetAllMeta {
-				stonecropAllMeta {
-					name
-					slug
-					tableName
-					fields {
-						fieldname
-						fieldtype
-						component
-						label
-						width
-						align
-						required
-						readOnly
-						edit
-						hidden
-						default
-						options
-						mask
-						precision
-						scale
-						mode
-						validation
-					}
-					workflow {
-						states
-						actions {
-							label
-							handler
-							requiredFields
-							allowedStates
-							confirm
-							args
-						}
-					}
-					inherits
-				}
-			}
-			`);
-        for (const meta of result.stonecropAllMeta) {
-            this.metaCache.set(meta.name, meta);
-        }
-        return result.stonecropAllMeta;
-    }
-    /**
-     * Get a single record by ID.
-     *
-     * Routes through the stonecropRecord resolver which handles nested data
-     * fetching based on the includeNested option.
-     *
-     * @param doctype - Doctype reference (name and optional slug)
-     * @param recordId - Record ID to fetch
-     * @param options - Query options (includeNested, maxDepth)
-     */
-    async getRecord(doctype, recordId, options) {
-        const result = await this.query(`query GetRecord($doctype: String!, $id: String!, $options: JSON) {
-				stonecropRecord(doctype: $doctype, id: $id, options: $options) {
-					data
-					unknownLinks
-				}
-			}`, {
-            doctype: doctype.name,
-            id: recordId,
-            options: options?.includeNested
-                ? {
-                    includeNested: options.includeNested,
-                    maxDepth: options.maxDepth,
-                }
-                : undefined,
-        });
-        return {
-            record: result.stonecropRecord?.data ?? null,
-            unknownLinks: result.stonecropRecord?.unknownLinks,
-        };
-    }
-    /**
-     * Get multiple records with optional filtering and pagination.
-     *
-     * Returns flat arrays — the middleware merges connection format (\{ nodes: [...] \})
-     * into plain arrays before returning.
-     *
-     * @param doctype - Doctype reference (name and optional slug)
-     * @param options - Query options (filters, orderBy, limit, offset)
-     */
-    async getRecords(doctype, options) {
-        const result = await this.query(`
-			query GetRecords(
-				$doctype: String!
-				$filters: JSON
-				$orderBy: String
-				$limit: Int
-				$offset: Int
-			) {
-				stonecropRecords(
-					doctype: $doctype
-					filters: $filters
-					orderBy: $orderBy
-					limit: $limit
-					offset: $offset
-				) {
-					data
-					count
-				}
-			}
-			`, {
-            doctype: doctype.name,
-            ...options,
-        });
-        return result.stonecropRecords.data;
-    }
-    /**
-     * Execute a doctype action
-     * @param doctype - Doctype reference (name and optional slug)
-     * @param action - Action name to execute
-     * @param args - Action arguments
-     */
-    async runAction(doctype, action, args) {
-        const result = await this.query(`
-			mutation RunAction($doctype: String!, $action: String!, $args: JSON) {
-				stonecropAction(doctype: $doctype, action: $action, args: $args) {
-					success
-					data
-					error
-				}
-			}
-			`, {
-            doctype: doctype.name,
-            action,
-            args,
-        });
-        return result.stonecropAction;
-    }
-    /**
-     * Clear the cached doctype metadata.
-     *
-     * Call this if the server-side doctype schema has changed and you need
-     * to fetch fresh metadata (e.g., after adding a new field).
-     */
-    clearMetaCache() {
-        this.metaCache.clear();
-    }
-}

package/dist/gql/schema.js

@@ -1,53 +0,0 @@
-import { gql } from 'graphql-request';
-/**
- * This is the schema for the GraphQL API.
- * @public
- */
-const typeDefs = gql `
-	type Doctype {
-		id: ID!
-		name: String!
-		workflow: String!
-		schema: String!
-		actions: String!
-	}
-
-	type DoctypeField {
-		id: ID!
-		label: String!
-		fieldtype: String
-		component: String
-		required: Boolean
-		readonly: Boolean
-	}
-
-	type DoctypeWorkflow {
-		name: String!
-		machine: StateMachine!
-	}
-
-	type StateMachine {
-		id: ID!
-	}
-
-	type DoctypeAction {
-		eventName: String!
-		callback: String
-	}
-
-	type Query {
-		getMeta(doctype: String!): Doctype # ∪ error
-		getRecords(doctype: String!, filters: [String]): [String] # ∪ error
-		getRecord(doctype: String!, id: ID!): String # ∪ error
-	}
-
-	type Mutation {
-		runAction(doctype: String!, id: [ID!]!, functionName: String!): [String!]! # ∪ error
-	}
-
-	schema {
-		query: Query
-		mutation: Mutation
-	}
-`;
-export default typeDefs;