@stonecrop/graphql-client 0.11.0 → 0.11.1

package/dist/src/client.js

@@ -1,221 +0,0 @@
-/**
- * Client for interacting with Stonecrop GraphQL API
- * @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
-     * @param query - GraphQL query string
-     * @param variables - Query variables
-     */
-    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
-     * @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
-					listDoctype
-					parentDoctype
-				}
-			}
-			`, { 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
-					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 reference (name and optional slug)
-     * @param recordId - Record ID to fetch
-     */
-    async getRecord(doctype, recordId) {
-        const result = await this.query(`
-			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 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
-     */
-    clearMetaCache() {
-        this.metaCache.clear();
-    }
-}

package/dist/src/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;

package/dist/src/index.js

@@ -1,61 +0,0 @@
-import { Decimal } from 'decimal.js';
-import { GraphQLClient } from 'graphql-request';
-import { queries } from './queries';
-import typeDefs from './gql/schema';
-/**
- * Parse the response from the GraphQL server. Converts the stringified JSON to JSON and converts the stringified numbers to Decimal.
- * @param obj - The response from the GraphQL server
- * @returns The parsed response
- * @example
- * const response = '{"data":{"getMeta":{"id":"Issue","name":"Issue","workflow":"{\"machineId\":null,\"name\":\"save\",\"id\":\"1\"}","schema":"[{\"label\":\"Subject\",\"id\":\"1\"}]","actions":"[{\"eventName\":\"save\",\"id\":\"1\"}]"}}}'
- * const parsedResponse = metaParser(response)
- * console.log(parsedResponse)
- * /* Output: {"id": "Issue", "name": "Issue", "workflow": { "machineId": null, "name": "save", "id": "1" }, "schema": [{ "label": "Subject", "id": "1" }], "actions": [{ "eventName": "save", "id": "1" }]}
- */
-const metaParser = (obj) => {
-    return JSON.parse(obj, (key, value) => {
-        if (typeof value === 'string') {
-            try {
-                return JSON.parse(value, (_key, value) => {
-                    if (typeof value === 'string' && !isNaN(Number(value))) {
-                        return new Decimal(value);
-                    }
-                    return value;
-                });
-            }
-            catch {
-                // if the value is not a stringified JSON, return as it is
-                return value;
-            }
-        }
-        else if (!isNaN(Number(value))) {
-            return new Decimal(value);
-        }
-        return value;
-    });
-};
-/**
- * Get meta information for a doctype
- * @param doctype - The doctype to get meta information for
- * @param url - The URL to send the request to
- * @returns The meta information for the doctype
- * @public
- */
-const methods = {
-    getMeta: async (doctype, url) => {
-        const client = new GraphQLClient(url || '/graphql', {
-            fetch: window.fetch,
-            jsonSerializer: {
-                stringify: obj => JSON.stringify(obj), // process the request object before sending; leave as default JSON
-                parse: metaParser, // process the response meta object
-            },
-        });
-        const { getMeta } = await client.request({
-            document: queries.getMeta,
-            variables: { doctype },
-        });
-        return getMeta;
-    },
-};
-export { queries, typeDefs, methods };
-export { StonecropClient } from './client';

package/dist/src/queries.js

@@ -1,19 +0,0 @@
-import { gql } from 'graphql-request';
-/**
- * Queries for the GraphQL API.
- * @public
- */
-const queries = {
-    getMeta: gql `
-		query getDoctype($doctype: String!) {
-			getMeta(doctype: $doctype) {
-				id
-				name
-				workflow
-				schema
-				actions
-			}
-		}
-	`,
-};
-export { queries };

package/dist/src/stonecrop-client.d.ts

@@ -1,87 +0,0 @@
-import type { DoctypeMeta as DoctypeMetaType } from '@stonecrop/schema';
-/**
- * Route context for identifying what doctype/record we're working with
- * @public
- */
-export interface RouteContext {
-    /** Doctype name (e.g., 'Task', 'Customer') */
-    doctype: string;
-    /** Optional record ID for viewing/editing a specific record */
-    recordId?: string;
-    /** Additional context properties */
-    [key: string]: unknown;
-}
-/**
- * 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<DoctypeMetaType | null>;
-    /**
-     * Get all doctype metadata
-     */
-    getAllMeta(): Promise<DoctypeMetaType[]>;
-    /**
-     * Get a single record by ID
-     * @param doctype - Doctype metadata
-     * @param recordId - Record ID to fetch
-     */
-    getRecord(doctype: DoctypeMetaType, 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: DoctypeMetaType, 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: DoctypeMetaType, action: string, args?: unknown[]): Promise<{
-        success: boolean;
-        data: unknown;
-        error: string | null;
-    }>;
-    /**
-     * Clear the cached doctype metadata
-     */
-    clearMetaCache(): void;
-}
-//# sourceMappingURL=stonecrop-client.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"stonecrop-client.d.ts","sourceRoot":"","sources":["../../src/stonecrop-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEvE;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAA;IACf,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,oCAAoC;IACpC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACtB;AAED;;;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,CAA0C;gBAE/C,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,eAAe,GAAG,IAAI,CAAC;IA0CrE;;OAEG;IACG,UAAU,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;IAsC9C;;;;OAIG;IACG,SAAS,CAAC,OAAO,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;IAiBpG;;;;OAIG;IACG,UAAU,CACf,OAAO,EAAE,eAAe,EACxB,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,eAAe,EACxB,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/tsdoc-metadata.json

@@ -1,11 +0,0 @@
-// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
-// It should be published with your NPM package.  It should not be tracked by Git.
-{
-  "tsdocVersion": "0.12",
-  "toolPackages": [
-    {
-      "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.57.0"
-    }
-  ]
-}

package/dist/src/types/index.js

@@ -1,4 +0,0 @@
-/**
- * @file This file contains all the types that are used in the application.
- * @public
- */

package/dist/stonecrop-client.js

@@ -1,191 +0,0 @@
-/**
- * Client for interacting with Stonecrop GraphQL API
- * @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
-     * @param query - GraphQL query string
-     * @param variables - Query variables
-     */
-    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
-     * @param mutation - GraphQL mutation string
-     * @param variables - Mutation variables
-     */
-    async mutate(mutation, variables) {
-        return this.query(mutation, variables);
-    }
-    /**
-     * Get doctype metadata
-     * @param context - Route 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
-						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() {
-        const result = await this.query(`
-			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, recordId) {
-        const result = await this.query(`
-			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, 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 metadata
-     * @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
-     */
-    clearMetaCache() {
-        this.metaCache.clear();
-    }
-}