@stonecrop/graphql-client 0.8.10 → 0.8.11

package/dist/index.js

@@ -58,3 +58,4 @@ const methods = {
     },
 };
 export { queries, typeDefs, methods };
+export { StonecropClient } from './client';

package/dist/src/client.d.ts

@@ -0,0 +1,76 @@
+import type { DoctypeMeta, RouteContext } from '@stonecrop/schema';
+export type { RouteContext };
+/**
+ * Options for creating a Stonecrop client
+ * @public
+ */
+export interface StonecropClientOptions {
+    /** GraphQL endpoint URL */
+    endpoint: string;
+    /** Additional HTTP headers to include in requests */
+    headers?: Record<string, string>;
+}
+/**
+ * Client for interacting with Stonecrop GraphQL API
+ * @public
+ */
+export declare class StonecropClient {
+    private endpoint;
+    private headers;
+    private metaCache;
+    constructor(options: StonecropClientOptions);
+    /**
+     * Execute a GraphQL query
+     * @param query - GraphQL query string
+     * @param variables - Query variables
+     */
+    query<T = unknown>(query: string, variables?: Record<string, unknown>): Promise<T>;
+    /**
+     * Execute a GraphQL mutation
+     * @param mutation - GraphQL mutation string
+     * @param variables - Mutation variables
+     */
+    mutate<T = unknown>(mutation: string, variables?: Record<string, unknown>): Promise<T>;
+    /**
+     * Get doctype metadata
+     * @param context - Route context containing doctype name
+     */
+    getMeta(context: RouteContext): Promise<DoctypeMeta | null>;
+    /**
+     * Get all doctype metadata
+     */
+    getAllMeta(): Promise<DoctypeMeta[]>;
+    /**
+     * Get a single record by ID
+     * @param doctype - Doctype metadata
+     * @param recordId - Record ID to fetch
+     */
+    getRecord(doctype: DoctypeMeta, recordId: string): Promise<Record<string, unknown> | null>;
+    /**
+     * Get multiple records with optional filtering and pagination
+     * @param doctype - Doctype metadata
+     * @param options - Query options (filters, orderBy, limit, offset)
+     */
+    getRecords(doctype: DoctypeMeta, options?: {
+        filters?: Record<string, unknown>;
+        orderBy?: string;
+        limit?: number;
+        offset?: number;
+    }): Promise<Record<string, unknown>[]>;
+    /**
+     * Execute a doctype action
+     * @param doctype - Doctype metadata
+     * @param action - Action name to execute
+     * @param args - Action arguments
+     */
+    runAction(doctype: DoctypeMeta, action: string, args?: unknown[]): Promise<{
+        success: boolean;
+        data: unknown;
+        error: string | null;
+    }>;
+    /**
+     * Clear the cached doctype metadata
+     */
+    clearMetaCache(): void;
+}
+//# sourceMappingURL=client.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAElE,YAAY,EAAE,YAAY,EAAE,CAAA;AAE5B;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACtC,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAA;IAChB,qDAAqD;IACrD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAChC;AAED;;;GAGG;AACH,qBAAa,eAAe;IAC3B,OAAO,CAAC,QAAQ,CAAQ;IACxB,OAAO,CAAC,OAAO,CAAwB;IACvC,OAAO,CAAC,SAAS,CAAsC;gBAE3C,OAAO,EAAE,sBAAsB;IAQ3C;;;;OAIG;IACG,KAAK,CAAC,CAAC,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAmBxF;;;;OAIG;IACG,MAAM,CAAC,CAAC,GAAG,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAI5F;;;OAGG;IACG,OAAO,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC;IA0CjE;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;IAsC1C;;;;OAIG;IACG,SAAS,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAiBhG;;;;OAIG;IACG,UAAU,CACf,OAAO,EAAE,WAAW,EACpB,OAAO,CAAC,EAAE;QACT,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QACjC,OAAO,CAAC,EAAE,MAAM,CAAA;QAChB,KAAK,CAAC,EAAE,MAAM,CAAA;QACd,MAAM,CAAC,EAAE,MAAM,CAAA;KACf,GACC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC;IAiCrC;;;;;OAKG;IACG,SAAS,CACd,OAAO,EAAE,WAAW,EACpB,MAAM,EAAE,MAAM,EACd,IAAI,CAAC,EAAE,OAAO,EAAE,GACd,OAAO,CAAC;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,IAAI,EAAE,OAAO,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;IAuBrE;;OAEG;IACH,cAAc,IAAI,IAAI;CAGtB"}

package/dist/src/index.d.ts

@@ -11,6 +11,9 @@ import type { MetaResponse } from './types';
 declare const methods: {
     getMeta: (doctype: string, url?: string) => Promise<MetaResponse>;
 };
-export type { Meta, MetaParser, MetaResponse } from './types';
 export { queries, typeDefs, methods };
+export { StonecropClient } from './client';
+export type { StonecropClientOptions, RouteContext } from './client';
+export type { Meta, MetaParser, MetaResponse } from './types';
+export type { DoctypeMeta } from '@stonecrop/schema';
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,QAAQ,MAAM,cAAc,CAAA;AACnC,OAAO,KAAK,EAAoB,YAAY,EAAE,MAAM,SAAS,CAAA;AAkC7D;;;;;;GAMG;AACH,QAAA,MAAM,OAAO;uBACa,MAAM,QAAQ,MAAM,KAAG,OAAO,CAAC,YAAY,CAAC;CAgBrE,CAAA;AAED,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC7D,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,QAAQ,MAAM,cAAc,CAAA;AACnC,OAAO,KAAK,EAAoB,YAAY,EAAE,MAAM,SAAS,CAAA;AAkC7D;;;;;;GAMG;AACH,QAAA,MAAM,OAAO;uBACa,MAAM,QAAQ,MAAM,KAAG,OAAO,CAAC,YAAY,CAAC;CAgBrE,CAAA;AAED,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAA;AACrC,OAAO,EAAE,eAAe,EAAE,MAAM,UAAU,CAAA;AAC1C,YAAY,EAAE,sBAAsB,EAAE,YAAY,EAAE,MAAM,UAAU,CAAA;AACpE,YAAY,EAAE,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAC7D,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stonecrop/graphql-client",
-  "version": "0.8.10",
+  "version": "0.8.11",
   "license": "MIT",
   "type": "module",
   "author": {
@@ -37,7 +37,8 @@
     "decimal.js": "^10.6.0",
     "graphql": "^16.12.0",
     "graphql-request": "^7.4.0",
-    "@stonecrop/stonecrop": "0.8.10"
+    "@stonecrop/schema": "0.8.11",
+    "@stonecrop/stonecrop": "0.8.11"
   },
   "devDependencies": {
     "@eslint/js": "^9.39.2",
@@ -45,6 +46,7 @@
     "@miragejs/graphql": "^0.1.13",
     "@rushstack/heft": "^1.2.0",
     "@vitejs/plugin-vue": "^6.0.3",
+    "@vitest/coverage-istanbul": "^4.0.18",
     "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
     "eslint-plugin-vue": "^10.6.2",
@@ -53,6 +55,7 @@
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.53.0",
     "vite": "^7.3.1",
+    "vitest": "^4.0.18",
     "vue": "^3.5.28",
     "vue-router": "^5.0.2",
     "stonecrop-rig": "0.7.0"
@@ -70,6 +73,9 @@
     "dev": "vite",
     "docs": "bash ../common/scripts/run-docs.sh graphql_client",
     "lint": "eslint .",
-    "preview": "vite preview"
+    "preview": "vite preview",
+    "test": "vitest run --coverage.enabled false",
+    "test:watch": "vitest watch",
+    "test:coverage": "vitest run --coverage"
   }
 }

package/src/client.ts

@@ -0,0 +1,260 @@
+import type { DoctypeMeta, RouteContext } from '@stonecrop/schema'
+
+export type { RouteContext }
+
+/**
+ * Options for creating a Stonecrop client
+ * @public
+ */
+export interface StonecropClientOptions {
+	/** GraphQL endpoint URL */
+	endpoint: string
+	/** Additional HTTP headers to include in requests */
+	headers?: Record<string, string>
+}
+
+/**
+ * Client for interacting with Stonecrop GraphQL API
+ * @public
+ */
+export class StonecropClient {
+	private endpoint: string
+	private headers: Record<string, string>
+	private metaCache: Map<string, DoctypeMeta> = new Map()
+
+	constructor(options: StonecropClientOptions) {
+		this.endpoint = options.endpoint
+		this.headers = {
+			'Content-Type': 'application/json',
+			...options.headers,
+		}
+	}
+
+	/**
+	 * Execute a GraphQL query
+	 * @param query - GraphQL query string
+	 * @param variables - Query variables
+	 */
+	async query<T = unknown>(query: string, variables?: Record<string, unknown>): Promise<T> {
+		const response = await fetch(this.endpoint, {
+			method: 'POST',
+			headers: this.headers,
+			body: JSON.stringify({ query, variables }),
+		})
+
+		const json = (await response.json()) as {
+			data?: T
+			errors?: Array<{ message: string }>
+		}
+
+		if (json.errors?.length) {
+			throw new Error(json.errors[0].message)
+		}
+
+		return json.data as T
+	}
+
+	/**
+	 * Execute a GraphQL mutation
+	 * @param mutation - GraphQL mutation string
+	 * @param variables - Mutation variables
+	 */
+	async mutate<T = unknown>(mutation: string, variables?: Record<string, unknown>): Promise<T> {
+		return this.query<T>(mutation, variables)
+	}
+
+	/**
+	 * Get doctype metadata
+	 * @param context - Route context containing doctype name
+	 */
+	async getMeta(context: RouteContext): Promise<DoctypeMeta | null> {
+		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
+					tableName
+					fields {
+						fieldname
+						fieldtype
+						component
+						label
+						required
+						readOnly
+						options
+						precision
+						scale
+					}
+					workflow {
+						states
+						actions
+					}
+					inherits
+					listDoctype
+					parentDoctype
+				}
+			}
+			`,
+			{ doctype: context.doctype }
+		)
+
+		if (result.stonecropMeta) {
+			this.metaCache.set(context.doctype, result.stonecropMeta)
+		}
+
+		return result.stonecropMeta
+	}
+
+	/**
+	 * Get all doctype metadata
+	 */
+	async getAllMeta(): Promise<DoctypeMeta[]> {
+		const result = await this.query<{ stonecropAllMeta: DoctypeMeta[] }>(
+			`
+			query GetAllMeta {
+				stonecropAllMeta {
+					name
+					slug
+					tableName
+					fields {
+						fieldname
+						fieldtype
+						component
+						label
+						required
+						readOnly
+						options
+						precision
+						scale
+					}
+					workflow {
+						states
+						actions
+					}
+					inherits
+					listDoctype
+					parentDoctype
+				}
+			}
+			`
+		)
+
+		for (const meta of result.stonecropAllMeta) {
+			this.metaCache.set(meta.name, meta)
+		}
+
+		return result.stonecropAllMeta
+	}
+
+	/**
+	 * Get a single record by ID
+	 * @param doctype - Doctype metadata
+	 * @param recordId - Record ID to fetch
+	 */
+	async getRecord(doctype: DoctypeMeta, recordId: string): Promise<Record<string, unknown> | null> {
+		const result = await this.query<{
+			stonecropRecord: { data: Record<string, unknown> | null }
+		}>(
+			`
+			query GetRecord($doctype: String!, $id: String!) {
+				stonecropRecord(doctype: $doctype, id: $id) {
+					data
+				}
+			}
+			`,
+			{ doctype: doctype.name, id: recordId }
+		)
+
+		return result.stonecropRecord.data
+	}
+
+	/**
+	 * Get multiple records with optional filtering and pagination
+	 * @param doctype - Doctype metadata
+	 * @param options - Query options (filters, orderBy, limit, offset)
+	 */
+	async getRecords(
+		doctype: DoctypeMeta,
+		options?: {
+			filters?: Record<string, unknown>
+			orderBy?: string
+			limit?: number
+			offset?: number
+		}
+	): Promise<Record<string, unknown>[]> {
+		const result = await this.query<{
+			stonecropRecords: { data: Record<string, unknown>[] }
+		}>(
+			`
+			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 metadata
+	 * @param action - Action name to execute
+	 * @param args - Action arguments
+	 */
+	async runAction(
+		doctype: DoctypeMeta,
+		action: string,
+		args?: unknown[]
+	): 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,
+			}
+		)
+
+		return result.stonecropAction
+	}
+
+	/**
+	 * Clear the cached doctype metadata
+	 */
+	clearMetaCache(): void {
+		this.metaCache.clear()
+	}
+}

package/src/index.ts

@@ -63,5 +63,8 @@ const methods = {
 	},
 }
 
-export type { Meta, MetaParser, MetaResponse } from './types'
 export { queries, typeDefs, methods }
+export { StonecropClient } from './client'
+export type { StonecropClientOptions, RouteContext } from './client'
+export type { Meta, MetaParser, MetaResponse } from './types'
+export type { DoctypeMeta } from '@stonecrop/schema'