@stonecrop/graphql-client 0.11.1 → 0.11.3

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;

package/dist/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/query.js

@@ -1,231 +0,0 @@
-import { toPascalCase } from '@stonecrop/schema';
-import pluralize from 'pluralize';
-/**
- * Default sync limit for many-cardinality links
- */
-const DEFAULT_SYNC_LIMIT = 50;
-/**
- * Field types that are not scalar queryable fields.
- * Link fields are handled separately via sub-selections; relationship fields live in `links`.
- */
-const RELATION_FIELDTYPES = new Set(['Link']);
-/**
- * Build a GraphQL connection query to fetch a list of records.
- *
- * Only declares variables ($limit, $offset, $orderBy) that are actually used,
- * avoiding GraphQL spec violations from unused variable declarations.
- *
- * @param meta - Doctype metadata
- * @param connectionFieldName - Function to derive the connection field name from a table name
- * @param orderByTypeName - Function to derive the order-by type name from a table name
- * @param options - Query options (limit, offset, orderBy)
- * @returns GraphQL query string
- *
- * @public
- */
-export function buildListQuery(meta, connectionFieldName, orderByTypeName, options) {
-    const fieldNames = queryableFieldNames(meta);
-    const connectionName = connectionFieldName(meta.tableName);
-    const orderByType = orderByTypeName(meta.tableName);
-    const varDecls = [];
-    const queryArgs = [];
-    if (options?.limit) {
-        varDecls.push('$limit: Int');
-        queryArgs.push(`first: $limit`);
-    }
-    if (options?.offset) {
-        varDecls.push('$offset: Int');
-        queryArgs.push(`offset: $offset`);
-    }
-    if (options?.orderBy) {
-        varDecls.push(`$orderBy: [${orderByType}!]`);
-        queryArgs.push(`orderBy: $orderBy`);
-    }
-    const varStr = varDecls.length > 0 ? `(${varDecls.join(', ')})` : '';
-    const argsStr = queryArgs.length > 0 ? `(${queryArgs.join(', ')})` : '';
-    return `
-		query GetRecords${varStr} {
-			${connectionName}${argsStr} {
-				nodes {
-				${fieldNames}
-				}
-			}
-		}
-	`;
-}
-/**
- * Build a GraphQL query string from doctype metadata.
- *
- * Generates scalar field selections. When `includeNested` is set,
- * recursively includes descendant link sub-selections derived from
- * the doctype's `links` object.
- *
- * @param meta - Doctype metadata to build the query from
- * @param recordFieldName - Function to derive the query field name from a table name
- * @param recordArgName - Function to derive the argument name from a table name
- * @param recordArgType - Function to derive the argument type from a table name
- * @param registry - Doctype registry for resolving link targets. Required when includeNested is set.
- * @param options - Query options (includeNested, maxDepth)
- * @returns GraphQL query string
- *
- * @public
- */
-export function buildRecordQuery(meta, recordFieldName, recordArgName, recordArgType, registry, options) {
-    const queryName = recordFieldName(meta.tableName);
-    const argName = recordArgName(meta.tableName);
-    const argType = recordArgType(meta.tableName);
-    const seen = new Set([meta.slug || meta.name]);
-    let selection = queryableFieldNames(meta);
-    if (options?.includeNested && meta.links && registry) {
-        const includeSet = Array.isArray(options.includeNested) ? new Set(options.includeNested) : null;
-        const nestedSelections = buildNestedSelections(meta.links, meta.tableName, includeSet, registry, seen, 0, options.maxDepth);
-        if (nestedSelections) {
-            selection += '\n      ' + nestedSelections;
-        }
-    }
-    return `
-		query GetRecord($${argName}: ${argType}) {
-			${queryName}(${argName}: $${argName}) {
-				${selection}
-			}
-		}
-	`;
-}
-/**
- * Build nested sub-selections for descendant links
- * @internal
- */
-function buildNestedSelections(links, parentTableName, includeSet, registry, seen, depth, maxDepth) {
-    if (maxDepth !== undefined && depth >= maxDepth)
-        return '';
-    const selections = [];
-    for (const [fieldname, link] of Object.entries(links)) {
-        if (maxDepth !== undefined && depth >= maxDepth)
-            break;
-        // Check blockWorkflows first - if true, it overrides the includeSet filter
-        const effectiveBlockWorkflows = getEffectiveBlockWorkflows(link);
-        const linkBlockWorkflowsExplicitTrue = link.blockWorkflows === true;
-        // Check includeSet filter - but blockWorkflows: true bypasses this filter
-        if (includeSet && !includeSet.has(fieldname) && !linkBlockWorkflowsExplicitTrue) {
-            continue;
-        }
-        // Check fetch strategy - skip if not sync (unless blockWorkflows overrides)
-        const effectiveFetch = getEffectiveFetchStrategy(link);
-        const shouldSkip = effectiveBlockWorkflows === false || (effectiveFetch.method !== 'sync' && !linkBlockWorkflowsExplicitTrue);
-        if (shouldSkip) {
-            continue;
-        }
-        // TODO: When blockWorkflows is true with custom fetch, this currently forces the link into
-        // GraphQL queries, bypassing the custom handler. This is a workaround — custom handlers
-        // should be able to satisfy blockWorkflows on their own schedule. Future enhancement:
-        // - Option: Add SchemaValidator error for custom + blockWorkflows (blocking is impossible)
-        // - Option: Track pending custom fetches and only unblock when all custom handlers complete
-        // See: relationships.md Phase 6 "Open Question: blockWorkflows + custom fetch"
-        const targetMeta = registry.get(link.target);
-        if (!targetMeta)
-            continue;
-        const alreadySeen = seen.has(link.target);
-        if (alreadySeen) {
-            // Self-referential: include scalar fields only, don't modify seen
-        }
-        else {
-            seen.add(link.target);
-        }
-        const scalarFields = queryableFieldNames(targetMeta);
-        let nestedLinks = '';
-        if (!alreadySeen && targetMeta.links && targetMeta.tableName && (maxDepth === undefined || depth + 1 < maxDepth)) {
-            const innerSelections = buildNestedSelections(targetMeta.links, targetMeta.tableName, null, registry, seen, depth + 1, maxDepth);
-            if (innerSelections) {
-                nestedLinks = '\n          ' + innerSelections;
-            }
-            seen.delete(link.target);
-        }
-        const fullSelection = scalarFields + nestedLinks;
-        if (isManyCardinality(link.cardinality)) {
-            const connectionField = getConnectionFieldName(targetMeta, parentTableName);
-            const limitArg = effectiveFetch.method === 'sync' && effectiveFetch.limit !== undefined
-                ? `first: ${effectiveFetch.limit}`
-                : effectiveFetch.method === 'sync'
-                    ? `first: ${DEFAULT_SYNC_LIMIT}`
-                    : '';
-            selections.push(`
-			${connectionField}${limitArg ? `(${limitArg})` : ''} {
-				nodes {
-					${fullSelection}
-				}
-			}`);
-        }
-        else {
-            selections.push(`
-			${fieldname} {
-				${fullSelection}
-			}`);
-        }
-    }
-    return selections.join('');
-}
-/**
- * Get the effective fetch strategy for a link, applying cardinality-based defaults.
- *
- * - `fetch` explicitly set → use it
- * - `fetch` absent → apply defaults:
- *   - `noneOrMany`/`atLeastOne` → `{ method: 'sync', limit: 50 }`
- *   - `one`/`atMostOne` → `{ method: 'lazy' }`
- *
- * @internal
- */
-function getEffectiveFetchStrategy(link) {
-    if (link.fetch !== undefined) {
-        return link.fetch;
-    }
-    // Apply cardinality-based defaults
-    if (isManyCardinality(link.cardinality)) {
-        return { method: 'sync', limit: DEFAULT_SYNC_LIMIT };
-    }
-    else {
-        return { method: 'lazy' };
-    }
-}
-/**
- * Get the effective blockWorkflows value for a link.
- * Returns true if blockWorkflows is explicitly true, or if it's absent and fetch method is 'sync'.
- * @internal
- */
-function getEffectiveBlockWorkflows(link) {
-    if (link.blockWorkflows !== undefined) {
-        return link.blockWorkflows;
-    }
-    const effectiveFetch = getEffectiveFetchStrategy(link);
-    return effectiveFetch.method === 'sync';
-}
-/**
- * Get scalar field names for a doctype, excluding Link and Doctype fields
- * @internal
- */
-function queryableFieldNames(meta) {
-    return meta.fields
-        .filter(f => !RELATION_FIELDTYPES.has(f.fieldtype))
-        .map(f => f.fieldname)
-        .join('\n      ');
-}
-/**
- * Check if a cardinality value represents a 1:many relationship
- * @internal
- */
-function isManyCardinality(cardinality) {
-    return cardinality === 'noneOrMany' || cardinality === 'atLeastOne';
-}
-/**
- * Derive a PostGraphile connection field name from a target doctype and parent table name.
- *
- * PostGraphile convention: `{targetPlural}By{ParentTablePascal}Id`
- * Example: recipe_task with parent recipe → `recipeTasksByRecipeId`
- *
- * @internal
- */
-function getConnectionFieldName(targetMeta, parentTableName) {
-    const targetPlural = pluralize.plural(targetMeta.tableName);
-    const targetPascal = toPascalCase(targetPlural);
-    const fkPascal = toPascalCase(parentTableName) + 'Id';
-    return `${targetPascal}By${fkPascal}`;
-}

package/dist/src/gql/schema.d.ts

@@ -1,7 +0,0 @@
-/**
- * This is the schema for the GraphQL API.
- * @public
- */
-declare const typeDefs: string;
-export default typeDefs;
-//# sourceMappingURL=schema.d.ts.map

package/dist/src/gql/schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../../src/gql/schema.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,QAAA,MAAM,QAAQ,QA8Cb,CAAA;AAED,eAAe,QAAQ,CAAA"}

package/dist/src/queries.d.ts

@@ -1,9 +0,0 @@
-/**
- * Queries for the GraphQL API.
- * @public
- */
-declare const queries: {
-    getMeta: string;
-};
-export { queries };
-//# 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":"AAEA;;;GAGG;AACH,QAAA,MAAM,OAAO;;CAYZ,CAAA;AAED,OAAO,EAAE,OAAO,EAAE,CAAA"}

package/dist/src/query.d.ts

@@ -1,35 +0,0 @@
-import type { DoctypeMeta, GetRecordOptions, GetRecordsOptions } from '@stonecrop/schema';
-/**
- * Build a GraphQL connection query to fetch a list of records.
- *
- * Only declares variables ($limit, $offset, $orderBy) that are actually used,
- * avoiding GraphQL spec violations from unused variable declarations.
- *
- * @param meta - Doctype metadata
- * @param connectionFieldName - Function to derive the connection field name from a table name
- * @param orderByTypeName - Function to derive the order-by type name from a table name
- * @param options - Query options (limit, offset, orderBy)
- * @returns GraphQL query string
- *
- * @public
- */
-export declare function buildListQuery(meta: DoctypeMeta, connectionFieldName: (t: string) => string, orderByTypeName: (t: string) => string, options?: GetRecordsOptions): string;
-/**
- * Build a GraphQL query string from doctype metadata.
- *
- * Generates scalar field selections. When `includeNested` is set,
- * recursively includes descendant link sub-selections derived from
- * the doctype's `links` object.
- *
- * @param meta - Doctype metadata to build the query from
- * @param recordFieldName - Function to derive the query field name from a table name
- * @param recordArgName - Function to derive the argument name from a table name
- * @param recordArgType - Function to derive the argument type from a table name
- * @param registry - Doctype registry for resolving link targets. Required when includeNested is set.
- * @param options - Query options (includeNested, maxDepth)
- * @returns GraphQL query string
- *
- * @public
- */
-export declare function buildRecordQuery(meta: DoctypeMeta, recordFieldName: (t: string) => string, recordArgName: (t: string) => string, recordArgType: (t: string) => string, registry?: Map<string, DoctypeMeta>, options?: GetRecordOptions): string;
-//# sourceMappingURL=query.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"query.d.ts","sourceRoot":"","sources":["../../src/query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACX,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EAIjB,MAAM,mBAAmB,CAAA;AAe1B;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC7B,IAAI,EAAE,WAAW,EACjB,mBAAmB,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,EAC1C,eAAe,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,EACtC,OAAO,CAAC,EAAE,iBAAiB,GACzB,MAAM,CAgCR;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gBAAgB,CAC/B,IAAI,EAAE,WAAW,EACjB,eAAe,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,EACtC,aAAa,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,EACpC,aAAa,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,EACpC,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,EACnC,OAAO,CAAC,EAAE,gBAAgB,GACxB,MAAM,CAkCR"}

package/src/gql/index.d.ts

@@ -1,6 +0,0 @@
-declare module '*.gql' {
-	import { DocumentNode } from 'graphql'
-	const Schema: DocumentNode
-
-	export = Schema
-}

package/src/gql/schema.gql

@@ -1,45 +0,0 @@
-type Doctype {
-	id: ID!
-	name: String!
-	workflow: DoctypeWorkflow!
-	schema: [DoctypeField!]!
-	actions: [DoctypeActions!]!
-}
-
-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: Filters): [Record] # ∪ error
-	getRecord(doctype: String!, id: ID!): Record # ∪ error
-}
-
-type Mutation {
-	runAction(doctype: String!, id: [ID!]!, functionName: String!): [Record!]! # ∪ error
-}
-
-schema {
-	query: Query
-	mutation: Mutation
-}

package/src/gql/schema.ts

@@ -1,55 +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/src/queries.ts

@@ -1,21 +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 }