@stonecrop/graphql-client 0.31.0 → 0.33.0

package/dist/src/client.js

@@ -1,172 +0,0 @@
-import { GET_META_QUERY, GET_ALL_META_QUERY, RUN_ACTION_MUTATION } from './queries';
-/**
- * Client for interacting with Stonecrop GraphQL API.
- *
- * Acts as a transport layer for stonecropRecord/stonecropRecords/stonecropAction.
- *
- * @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);
-        }
-        if (json.data === undefined) {
-            throw new Error('GraphQL response missing data field');
-        }
-        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(GET_META_QUERY, {
-            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(GET_ALL_META_QUERY);
-        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
-				$includeTotal: Boolean
-			) {
-				stonecropRecords(
-					doctype: $doctype
-					filters: $filters
-					orderBy: $orderBy
-					limit: $limit
-					offset: $offset
-					includeTotal: $includeTotal
-				) {
-					data
-					hasMore
-					count
-				}
-			}
-			`, {
-            doctype: doctype.name,
-            ...options,
-        });
-        const { data, hasMore, count } = result.stonecropRecords;
-        // `count` is null unless includeTotal was set. Omitting the key rather than passing null
-        // through keeps "not asked for" and "asked for, and it is zero" distinguishable.
-        return count == null ? { data, hasMore } : { data, hasMore, count };
-    }
-    /**
-     * 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(RUN_ACTION_MUTATION, {
-            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/src/index.d.ts

@@ -1,4 +0,0 @@
-export type { DoctypeMeta } from '@stonecrop/schema';
-export { StonecropClient, type StonecropClientOptions, type DoctypeContext } from './client';
-export type { GetRecordResult } from './types';
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAEpD,OAAO,EAAE,eAAe,EAAE,KAAK,sBAAsB,EAAE,KAAK,cAAc,EAAE,MAAM,UAAU,CAAA;AAC5F,YAAY,EAAE,eAAe,EAAE,MAAM,SAAS,CAAA"}

package/dist/src/index.js

@@ -1 +0,0 @@
-export { StonecropClient } from './client';

package/dist/src/queries.d.ts

@@ -1,23 +0,0 @@
-/**
- * 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 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\tdisplayField\n\t\t\tfields {\n\t\t\t\tkind\n\t\t\t\tfieldname\n\t\t\t\tcomponent\n\t\t\t\tprimaryKey\n\t\t\t\tcomputed\n\t\t\t\tlanguage\n\t\t\t\tdoctype\n\t\t\t\tlabel\n\t\t\t\twidth\n\t\t\t\theight\n\t\t\t\talign\n\t\t\t\tedit\n\t\t\t\tmask\n\t\t\t\tformat\n\t\t\t\tmode\n\t\t\t\toptions\n\t\t\t\trequired\n\t\t\t\treadOnly\n\t\t\t\thidden\n\t\t\t\tdefault\n\t\t\t\tvalidation\n\t\t\t\tcardinality\n\t\t\t\tsource\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\tnextState\n\t\t\t\t\tstateless\n\t\t\t\t\tselfTransition\n\t\t\t\t\tclientHandler\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\tdisplayField\n\t\t\tfields {\n\t\t\t\tkind\n\t\t\t\tfieldname\n\t\t\t\tcomponent\n\t\t\t\tprimaryKey\n\t\t\t\tcomputed\n\t\t\t\tlanguage\n\t\t\t\tdoctype\n\t\t\t\tlabel\n\t\t\t\twidth\n\t\t\t\theight\n\t\t\t\talign\n\t\t\t\tedit\n\t\t\t\tmask\n\t\t\t\tformat\n\t\t\t\tmode\n\t\t\t\toptions\n\t\t\t\trequired\n\t\t\t\treadOnly\n\t\t\t\thidden\n\t\t\t\tdefault\n\t\t\t\tvalidation\n\t\t\t\tcardinality\n\t\t\t\tsource\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\tnextState\n\t\t\t\t\tstateless\n\t\t\t\t\tselfTransition\n\t\t\t\t\tclientHandler\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 +0,0 @@
-{"version":3,"file":"queries.d.ts","sourceRoot":"","sources":["../../src/queries.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,cAAc,myBA8C1B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,6MAQ/B,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,mwBA8C9B,CAAA"}

package/dist/src/queries.js

@@ -1,122 +0,0 @@
-/**
- * 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
-			displayField
-			fields {
-				kind
-				fieldname
-				component
-				primaryKey
-				computed
-				language
-				doctype
-				label
-				width
-				height
-				align
-				edit
-				mask
-				format
-				mode
-				options
-				required
-				readOnly
-				hidden
-				default
-				validation
-				cardinality
-				source
-			}
-			workflow {
-				states
-				actions {
-					label
-					requiredFields
-					allowedStates
-					nextState
-					stateless
-					selfTransition
-					clientHandler
-				}
-			}
-			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
-			displayField
-			fields {
-				kind
-				fieldname
-				component
-				primaryKey
-				computed
-				language
-				doctype
-				label
-				width
-				height
-				align
-				edit
-				mask
-				format
-				mode
-				options
-				required
-				readOnly
-				hidden
-				default
-				validation
-				cardinality
-				source
-			}
-			workflow {
-				states
-				actions {
-					label
-					requiredFields
-					allowedStates
-					nextState
-					stateless
-					selfTransition
-					clientHandler
-				}
-			}
-			inherits
-		}
-	}
-`;

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

@@ -1,14 +0,0 @@
-/**
- * @file Types for the GraphQL client.
- * @public
- */
-import type { GetRecordResult as SchemaGetRecordResult } from '@stonecrop/schema';
-/**
- * Result from getRecord - includes the record data and any unknown links requested
- * @public
- */
-export interface GetRecordResult extends SchemaGetRecordResult {
-    /** Link names that were requested but don't exist in the doctype schema */
-    unknownLinks?: string[];
-}
-//# sourceMappingURL=index.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,eAAe,IAAI,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AAEjF;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,qBAAqB;IAC7D,2EAA2E;IAC3E,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;CACvB"}

package/dist/src/types/index.js

@@ -1,4 +0,0 @@
-/**
- * @file Types for the GraphQL client.
- * @public
- */

package/src/client.ts

@@ -1,233 +0,0 @@
-import type {
-	DataClient,
-	DoctypeMeta,
-	DoctypeContext,
-	DoctypeRef,
-	GetRecordOptions,
-	GetRecordsOptions,
-	GetRecordsResult,
-} 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, GetRecordsResult }
-
-/**
- * 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.
- *
- * Acts as a transport layer for stonecropRecord/stonecropRecords/stonecropAction.
- *
- * @public
- */
-export class StonecropClient implements DataClient {
-	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 against the configured endpoint.
-	 *
-	 * @param query - GraphQL query string
-	 * @param variables - Query variables
-	 * @throws Error if the GraphQL response contains errors
-	 */
-	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: { data?: T; errors?: Array<{ message: string }> } = await response.json()
-
-		if (json.errors?.length) {
-			throw new Error(json.errors[0].message)
-		}
-
-		if (json.data === undefined) {
-			throw new Error('GraphQL response missing data field')
-		}
-
-		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<T = unknown>(mutation: string, variables?: Record<string, unknown>): Promise<T> {
-		return this.query<T>(mutation, variables)
-	}
-
-	/**
-	 * Get doctype metadata
-	 * @param context - Doctype context containing doctype name
-	 */
-	async getMeta(context: DoctypeContext): Promise<DoctypeMeta | null> {
-		const cached = this.metaCache.get(context.doctype)
-		if (cached) return cached
-
-		const result = await this.query<{ stonecropMeta: DoctypeMeta | null }>(GET_META_QUERY, {
-			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[] }>(GET_ALL_META_QUERY)
-
-		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: DoctypeRef, recordId: string, options?: GetRecordOptions): Promise<GetRecordResult> {
-		const result = await this.query<{
-			stonecropRecord: { data: Record<string, unknown> | null; unknownLinks?: string[] }
-		}>(
-			`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: DoctypeRef, options?: GetRecordsOptions): Promise<GetRecordsResult> {
-		const result = await this.query<{
-			stonecropRecords: { data: Record<string, unknown>[]; hasMore: boolean; count: number | null }
-		}>(
-			`
-			query GetRecords(
-				$doctype: String!
-				$filters: JSON
-				$orderBy: String
-				$limit: Int
-				$offset: Int
-				$includeTotal: Boolean
-			) {
-				stonecropRecords(
-					doctype: $doctype
-					filters: $filters
-					orderBy: $orderBy
-					limit: $limit
-					offset: $offset
-					includeTotal: $includeTotal
-				) {
-					data
-					hasMore
-					count
-				}
-			}
-			`,
-			{
-				doctype: doctype.name,
-				...options,
-			}
-		)
-
-		const { data, hasMore, count } = result.stonecropRecords
-		// `count` is null unless includeTotal was set. Omitting the key rather than passing null
-		// through keeps "not asked for" and "asked for, and it is zero" distinguishable.
-		return count == null ? { data, hasMore } : { data, hasMore, count }
-	}
-
-	/**
-	 * 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: DoctypeRef,
-		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 }
-		}>(RUN_ACTION_MUTATION, {
-			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(): void {
-		this.metaCache.clear()
-	}
-}

package/src/index.ts

@@ -1,4 +0,0 @@
-export type { DoctypeMeta } from '@stonecrop/schema'
-
-export { StonecropClient, type StonecropClientOptions, type DoctypeContext } from './client'
-export type { GetRecordResult } from './types'