@stonecrop/graphql-client 0.13.12 → 0.13.14

package/dist/src/queries.d.ts

@@ -1,9 +1,23 @@
 /**
- * Queries for the GraphQL API.
+ * 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
  */
-declare const queries: {
-    getMeta: string;
-};
-export { queries };
+export declare const GET_META_QUERY = "\n\tquery GetMeta($doctype: String!) {\n\t\tstonecropMeta(doctype: $doctype) {\n\t\t\tname\n\t\t\tslug\n\t\t\tfields {\n\t\t\t\tfieldname\n\t\t\t\tfieldtype\n\t\t\t\tcomponent\n\t\t\t\tlabel\n\t\t\t\twidth\n\t\t\t\talign\n\t\t\t\trequired\n\t\t\t\treadOnly\n\t\t\t\tedit\n\t\t\t\thidden\n\t\t\t\tdefault\n\t\t\t\toptions\n\t\t\t\tmask\n\t\t\t\tprecision\n\t\t\t\tscale\n\t\t\t\tmode\n\t\t\t\tvalidation\n\t\t\t}\n\t\t\tworkflow {\n\t\t\t\tstates\n\t\t\t\tactions {\n\t\t\t\t\tlabel\n\t\t\t\t\trequiredFields\n\t\t\t\t\tallowedStates\n\t\t\t\t}\n\t\t\t}\n\t\t\tinherits\n\t\t}\n\t}\n";
+/**
+ * Mutation document for dispatching a workflow action (the server-owned transition).
+ * @public
+ */
+export declare const RUN_ACTION_MUTATION = "\n\tmutation RunAction($doctype: String!, $action: String!, $args: JSON) {\n\t\tstonecropAction(doctype: $doctype, action: $action, args: $args) {\n\t\t\tsuccess\n\t\t\tdata\n\t\t\terror\n\t\t}\n\t}\n";
+/**
+ * Query document for fetching all doctype metadata.
+ * @public
+ */
+export declare const GET_ALL_META_QUERY = "\n\tquery GetAllMeta {\n\t\tstonecropAllMeta {\n\t\t\tname\n\t\t\tslug\n\t\t\tfields {\n\t\t\t\tfieldname\n\t\t\t\tfieldtype\n\t\t\t\tcomponent\n\t\t\t\tlabel\n\t\t\t\twidth\n\t\t\t\talign\n\t\t\t\trequired\n\t\t\t\treadOnly\n\t\t\t\tedit\n\t\t\t\thidden\n\t\t\t\tdefault\n\t\t\t\toptions\n\t\t\t\tmask\n\t\t\t\tprecision\n\t\t\t\tscale\n\t\t\t\tmode\n\t\t\t\tvalidation\n\t\t\t}\n\t\t\tworkflow {\n\t\t\t\tstates\n\t\t\t\tactions {\n\t\t\t\t\tlabel\n\t\t\t\t\trequiredFields\n\t\t\t\t\tallowedStates\n\t\t\t\t}\n\t\t\t}\n\t\t\tinherits\n\t\t}\n\t}\n";
 //# sourceMappingURL=queries.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../src/queries.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,QAAA,MAAM,OAAO;;CAYZ,CAAA;AAED,OAAO,EAAE,OAAO,EAAE,CAAA"}
+{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../src/queries.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,2kBAmC1B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,6MAQ/B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,2iBAmC9B,CAAA"}

package/dist/src/queries.js

@@ -1,19 +1,100 @@
-import { gql } from 'graphql-request';
 /**
- * Queries for the GraphQL API.
+ * 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
  */
-const queries = {
-    getMeta: gql `
-		query getDoctype($doctype: String!) {
-			getMeta(doctype: $doctype) {
-				id
-				name
-				workflow
-				schema
-				actions
+export const GET_META_QUERY = `
+	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
+					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 {
+				fieldname
+				fieldtype
+				component
+				label
+				width
+				align
+				required
+				readOnly
+				edit
+				hidden
+				default
+				options
+				mask
+				precision
+				scale
+				mode
+				validation
+			}
+			workflow {
+				states
+				actions {
+					label
+					requiredFields
+					allowedStates
+				}
+			}
+			inherits
 		}
-	`,
-};
-export { queries };
+	}
+`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/graphql-client",
-  "version": "0.13.12",
+  "version": "0.13.14",
   "license": "MIT",
   "type": "module",
   "author": {
@@ -32,8 +32,8 @@
   "dependencies": {
     "graphql": "^16.14.0",
     "pluralize": "^8.0.0",
-    "@stonecrop/schema": "0.13.12",
-    "@stonecrop/stonecrop": "0.13.12"
+    "@stonecrop/schema": "0.13.14",
+    "@stonecrop/stonecrop": "0.13.14"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.30.5",