@constructive-io/graphql-codegen 4.0.2 → 4.1.1

package/esm/core/codegen/cli/table-command-generator.d.ts

@@ -0,0 +1,7 @@
+import type { CleanTable } from '../../../types/schema';
+import type { GeneratedFile } from './executor-generator';
+export interface TableCommandOptions {
+    targetName?: string;
+    executorImportPath?: string;
+}
+export declare function generateTableCommand(table: CleanTable, options?: TableCommandOptions): GeneratedFile;

package/esm/core/codegen/cli/table-command-generator.js

@@ -0,0 +1,287 @@
+import * as t from '@babel/types';
+import { toKebabCase } from 'komoji';
+import { generateCode } from '../babel-ast';
+import { getGeneratedFileHeader, getPrimaryKeyInfo, getScalarFields, getTableNames, ucFirst, } from '../utils';
+function createImportDeclaration(moduleSpecifier, namedImports, typeOnly = false) {
+    const specifiers = namedImports.map((name) => t.importSpecifier(t.identifier(name), t.identifier(name)));
+    const decl = t.importDeclaration(specifiers, t.stringLiteral(moduleSpecifier));
+    decl.importKind = typeOnly ? 'type' : 'value';
+    return decl;
+}
+function buildSelectObject(table) {
+    const fields = getScalarFields(table);
+    return t.objectExpression(fields.map((f) => t.objectProperty(t.identifier(f.name), t.booleanLiteral(true))));
+}
+function buildJsonLog(expr) {
+    return t.expressionStatement(t.callExpression(t.memberExpression(t.identifier('console'), t.identifier('log')), [
+        t.callExpression(t.memberExpression(t.identifier('JSON'), t.identifier('stringify')), [expr, t.nullLiteral(), t.numericLiteral(2)]),
+    ]));
+}
+function buildOrmCall(singularName, methodName, args) {
+    return t.callExpression(t.memberExpression(t.callExpression(t.memberExpression(t.memberExpression(t.identifier('client'), t.identifier(singularName)), t.identifier(methodName)), [args]), t.identifier('execute')), []);
+}
+function buildErrorCatch(errorMessage) {
+    return t.catchClause(t.identifier('error'), t.blockStatement([
+        t.expressionStatement(t.callExpression(t.memberExpression(t.identifier('console'), t.identifier('error')), [t.stringLiteral(errorMessage)])),
+        t.ifStatement(t.binaryExpression('instanceof', t.identifier('error'), t.identifier('Error')), t.blockStatement([
+            t.expressionStatement(t.callExpression(t.memberExpression(t.identifier('console'), t.identifier('error')), [
+                t.memberExpression(t.identifier('error'), t.identifier('message')),
+            ])),
+        ])),
+        t.expressionStatement(t.callExpression(t.memberExpression(t.identifier('process'), t.identifier('exit')), [t.numericLiteral(1)])),
+    ]));
+}
+function buildGetClientStatement(targetName) {
+    const args = targetName
+        ? [t.stringLiteral(targetName)]
+        : [];
+    return t.variableDeclaration('const', [
+        t.variableDeclarator(t.identifier('client'), t.callExpression(t.identifier('getClient'), args)),
+    ]);
+}
+function buildArgvType() {
+    return t.tsTypeAnnotation(t.tsTypeReference(t.identifier('Partial'), t.tsTypeParameterInstantiation([
+        t.tsTypeReference(t.identifier('Record'), t.tsTypeParameterInstantiation([
+            t.tsStringKeyword(),
+            t.tsUnknownKeyword(),
+        ])),
+    ])));
+}
+function buildSubcommandSwitch(subcommands, handlerPrefix, usageVarName) {
+    const cases = subcommands.map((sub) => t.switchCase(t.stringLiteral(sub), [
+        t.returnStatement(t.callExpression(t.identifier(`${handlerPrefix}${ucFirst(sub)}`), [
+            t.identifier('argv'),
+            t.identifier('prompter'),
+        ])),
+    ]));
+    cases.push(t.switchCase(null, [
+        t.expressionStatement(t.callExpression(t.memberExpression(t.identifier('console'), t.identifier('log')), [t.identifier(usageVarName)])),
+        t.expressionStatement(t.callExpression(t.memberExpression(t.identifier('process'), t.identifier('exit')), [t.numericLiteral(1)])),
+    ]));
+    return t.switchStatement(t.identifier('subcommand'), cases);
+}
+function buildListHandler(table, targetName) {
+    const { singularName } = getTableNames(table);
+    const selectObj = buildSelectObject(table);
+    const tryBody = [
+        buildGetClientStatement(targetName),
+        t.variableDeclaration('const', [
+            t.variableDeclarator(t.identifier('result'), t.awaitExpression(buildOrmCall(singularName, 'findMany', t.objectExpression([
+                t.objectProperty(t.identifier('select'), selectObj),
+            ])))),
+        ]),
+        buildJsonLog(t.identifier('result')),
+    ];
+    const argvParam = t.identifier('_argv');
+    argvParam.typeAnnotation = buildArgvType();
+    const prompterParam = t.identifier('_prompter');
+    prompterParam.typeAnnotation = t.tsTypeAnnotation(t.tsTypeReference(t.identifier('Inquirerer')));
+    return t.functionDeclaration(t.identifier('handleList'), [argvParam, prompterParam], t.blockStatement([
+        t.tryStatement(t.blockStatement(tryBody), buildErrorCatch('Failed to list records.')),
+    ]), false, true);
+}
+function buildGetHandler(table, targetName) {
+    const { singularName } = getTableNames(table);
+    const pkFields = getPrimaryKeyInfo(table);
+    const pk = pkFields[0];
+    const selectObj = buildSelectObject(table);
+    const promptQuestion = t.objectExpression([
+        t.objectProperty(t.identifier('type'), t.stringLiteral('text')),
+        t.objectProperty(t.identifier('name'), t.stringLiteral(pk.name)),
+        t.objectProperty(t.identifier('message'), t.stringLiteral(pk.name)),
+        t.objectProperty(t.identifier('required'), t.booleanLiteral(true)),
+    ]);
+    const ormArgs = t.objectExpression([
+        t.objectProperty(t.identifier(pk.name), t.memberExpression(t.identifier('answers'), t.identifier(pk.name))),
+        t.objectProperty(t.identifier('select'), selectObj),
+    ]);
+    const tryBody = [
+        t.variableDeclaration('const', [
+            t.variableDeclarator(t.identifier('answers'), t.awaitExpression(t.callExpression(t.memberExpression(t.identifier('prompter'), t.identifier('prompt')), [t.identifier('argv'), t.arrayExpression([promptQuestion])]))),
+        ]),
+        buildGetClientStatement(targetName),
+        t.variableDeclaration('const', [
+            t.variableDeclarator(t.identifier('result'), t.awaitExpression(buildOrmCall(singularName, 'findOne', ormArgs))),
+        ]),
+        buildJsonLog(t.identifier('result')),
+    ];
+    const argvParam = t.identifier('argv');
+    argvParam.typeAnnotation = buildArgvType();
+    const prompterParam = t.identifier('prompter');
+    prompterParam.typeAnnotation = t.tsTypeAnnotation(t.tsTypeReference(t.identifier('Inquirerer')));
+    return t.functionDeclaration(t.identifier('handleGet'), [argvParam, prompterParam], t.blockStatement([
+        t.tryStatement(t.blockStatement(tryBody), buildErrorCatch('Record not found.')),
+    ]), false, true);
+}
+function buildMutationHandler(table, operation, targetName) {
+    const { singularName } = getTableNames(table);
+    const pkFields = getPrimaryKeyInfo(table);
+    const pk = pkFields[0];
+    const editableFields = getScalarFields(table).filter((f) => f.name !== pk.name &&
+        f.name !== 'nodeId' &&
+        f.name !== 'createdAt' &&
+        f.name !== 'updatedAt');
+    const questions = [];
+    if (operation === 'update' || operation === 'delete') {
+        questions.push(t.objectExpression([
+            t.objectProperty(t.identifier('type'), t.stringLiteral('text')),
+            t.objectProperty(t.identifier('name'), t.stringLiteral(pk.name)),
+            t.objectProperty(t.identifier('message'), t.stringLiteral(pk.name)),
+            t.objectProperty(t.identifier('required'), t.booleanLiteral(true)),
+        ]));
+    }
+    if (operation !== 'delete') {
+        for (const field of editableFields) {
+            questions.push(t.objectExpression([
+                t.objectProperty(t.identifier('type'), t.stringLiteral('text')),
+                t.objectProperty(t.identifier('name'), t.stringLiteral(field.name)),
+                t.objectProperty(t.identifier('message'), t.stringLiteral(field.name)),
+                t.objectProperty(t.identifier('required'), t.booleanLiteral(operation === 'create')),
+            ]));
+        }
+    }
+    const selectObj = operation === 'delete'
+        ? t.objectExpression([
+            t.objectProperty(t.identifier(pk.name), t.booleanLiteral(true)),
+        ])
+        : buildSelectObject(table);
+    let ormArgs;
+    if (operation === 'create') {
+        const dataProps = editableFields.map((f) => t.objectProperty(t.identifier(f.name), t.memberExpression(t.identifier('answers'), t.identifier(f.name)), false, true));
+        ormArgs = t.objectExpression([
+            t.objectProperty(t.identifier('data'), t.objectExpression(dataProps)),
+            t.objectProperty(t.identifier('select'), selectObj),
+        ]);
+    }
+    else if (operation === 'update') {
+        const dataProps = editableFields.map((f) => t.objectProperty(t.identifier(f.name), t.memberExpression(t.identifier('answers'), t.identifier(f.name)), false, true));
+        ormArgs = t.objectExpression([
+            t.objectProperty(t.identifier(pk.name), t.memberExpression(t.identifier('answers'), t.identifier(pk.name))),
+            t.objectProperty(t.identifier('data'), t.objectExpression(dataProps)),
+            t.objectProperty(t.identifier('select'), selectObj),
+        ]);
+    }
+    else {
+        ormArgs = t.objectExpression([
+            t.objectProperty(t.identifier(pk.name), t.memberExpression(t.identifier('answers'), t.identifier(pk.name))),
+            t.objectProperty(t.identifier('select'), selectObj),
+        ]);
+    }
+    const tryBody = [
+        t.variableDeclaration('const', [
+            t.variableDeclarator(t.identifier('answers'), t.awaitExpression(t.callExpression(t.memberExpression(t.identifier('prompter'), t.identifier('prompt')), [t.identifier('argv'), t.arrayExpression(questions)]))),
+        ]),
+        buildGetClientStatement(targetName),
+        t.variableDeclaration('const', [
+            t.variableDeclarator(t.identifier('result'), t.awaitExpression(buildOrmCall(singularName, operation, ormArgs))),
+        ]),
+        buildJsonLog(t.identifier('result')),
+    ];
+    const argvParam = t.identifier('argv');
+    argvParam.typeAnnotation = buildArgvType();
+    const prompterParam = t.identifier('prompter');
+    prompterParam.typeAnnotation = t.tsTypeAnnotation(t.tsTypeReference(t.identifier('Inquirerer')));
+    const handlerName = `handle${ucFirst(operation)}`;
+    return t.functionDeclaration(t.identifier(handlerName), [argvParam, prompterParam], t.blockStatement([
+        t.tryStatement(t.blockStatement(tryBody), buildErrorCatch(`Failed to ${operation} record.`)),
+    ]), false, true);
+}
+export function generateTableCommand(table, options) {
+    const { singularName } = getTableNames(table);
+    const commandName = toKebabCase(singularName);
+    const statements = [];
+    const executorPath = options?.executorImportPath ?? '../executor';
+    statements.push(createImportDeclaration('inquirerer', [
+        'CLIOptions',
+        'Inquirerer',
+        'extractFirst',
+    ]));
+    statements.push(createImportDeclaration(executorPath, ['getClient']));
+    const subcommands = ['list', 'get', 'create', 'update', 'delete'];
+    const usageLines = [
+        '',
+        `${commandName} <command>`,
+        '',
+        'Commands:',
+        `  list                  List all ${singularName} records`,
+        `  get                   Get a ${singularName} by ID`,
+        `  create                Create a new ${singularName}`,
+        `  update                Update an existing ${singularName}`,
+        `  delete                Delete a ${singularName}`,
+        '',
+        '  --help, -h            Show this help message',
+        '',
+    ];
+    statements.push(t.variableDeclaration('const', [
+        t.variableDeclarator(t.identifier('usage'), t.stringLiteral(usageLines.join('\n'))),
+    ]));
+    const argvParam = t.identifier('argv');
+    argvParam.typeAnnotation = buildArgvType();
+    const prompterParam = t.identifier('prompter');
+    prompterParam.typeAnnotation = t.tsTypeAnnotation(t.tsTypeReference(t.identifier('Inquirerer')));
+    const optionsParam = t.identifier('_options');
+    optionsParam.typeAnnotation = t.tsTypeAnnotation(t.tsTypeReference(t.identifier('CLIOptions')));
+    const mainBody = [
+        t.ifStatement(t.logicalExpression('||', t.memberExpression(t.identifier('argv'), t.identifier('help')), t.memberExpression(t.identifier('argv'), t.identifier('h'))), t.blockStatement([
+            t.expressionStatement(t.callExpression(t.memberExpression(t.identifier('console'), t.identifier('log')), [t.identifier('usage')])),
+            t.expressionStatement(t.callExpression(t.memberExpression(t.identifier('process'), t.identifier('exit')), [t.numericLiteral(0)])),
+        ])),
+        t.variableDeclaration('const', [
+            t.variableDeclarator(t.objectPattern([
+                t.objectProperty(t.identifier('first'), t.identifier('subcommand')),
+                t.objectProperty(t.identifier('newArgv'), t.identifier('newArgv'), false, true),
+            ]), t.callExpression(t.identifier('extractFirst'), [
+                t.identifier('argv'),
+            ])),
+        ]),
+        t.ifStatement(t.unaryExpression('!', t.identifier('subcommand')), t.blockStatement([
+            t.variableDeclaration('const', [
+                t.variableDeclarator(t.identifier('answer'), t.awaitExpression(t.callExpression(t.memberExpression(t.identifier('prompter'), t.identifier('prompt')), [
+                    t.identifier('argv'),
+                    t.arrayExpression([
+                        t.objectExpression([
+                            t.objectProperty(t.identifier('type'), t.stringLiteral('autocomplete')),
+                            t.objectProperty(t.identifier('name'), t.stringLiteral('subcommand')),
+                            t.objectProperty(t.identifier('message'), t.stringLiteral('What do you want to do?')),
+                            t.objectProperty(t.identifier('options'), t.arrayExpression(subcommands.map((s) => t.stringLiteral(s)))),
+                        ]),
+                    ]),
+                ]))),
+            ]),
+            t.returnStatement(t.callExpression(t.identifier('handleTableSubcommand'), [
+                t.memberExpression(t.identifier('answer'), t.identifier('subcommand')),
+                t.identifier('newArgv'),
+                t.identifier('prompter'),
+            ])),
+        ])),
+        t.returnStatement(t.callExpression(t.identifier('handleTableSubcommand'), [
+            t.identifier('subcommand'),
+            t.identifier('newArgv'),
+            t.identifier('prompter'),
+        ])),
+    ];
+    statements.push(t.exportDefaultDeclaration(t.arrowFunctionExpression([argvParam, prompterParam, optionsParam], t.blockStatement(mainBody), true)));
+    const subcmdParam = t.identifier('subcommand');
+    subcmdParam.typeAnnotation = t.tsTypeAnnotation(t.tsStringKeyword());
+    const argvParam2 = t.identifier('argv');
+    argvParam2.typeAnnotation = buildArgvType();
+    const prompterParam2 = t.identifier('prompter');
+    prompterParam2.typeAnnotation = t.tsTypeAnnotation(t.tsTypeReference(t.identifier('Inquirerer')));
+    statements.push(t.functionDeclaration(t.identifier('handleTableSubcommand'), [subcmdParam, argvParam2, prompterParam2], t.blockStatement([
+        buildSubcommandSwitch(subcommands, 'handle', 'usage'),
+    ]), false, true));
+    const tn = options?.targetName;
+    statements.push(buildListHandler(table, tn));
+    statements.push(buildGetHandler(table, tn));
+    statements.push(buildMutationHandler(table, 'create', tn));
+    statements.push(buildMutationHandler(table, 'update', tn));
+    statements.push(buildMutationHandler(table, 'delete', tn));
+    const header = getGeneratedFileHeader(`CLI commands for ${table.name}`);
+    const code = generateCode(statements);
+    return {
+        fileName: options?.targetName
+            ? `commands/${options.targetName}/${commandName}.ts`
+            : `commands/${commandName}.ts`,
+        content: header + '\n' + code,
+    };
+}

package/esm/core/codegen/docs-utils.d.ts

@@ -0,0 +1,30 @@
+import type { DocsConfig } from '../../types/config';
+import type { CleanField, CleanOperation, CleanTable } from '../../types/schema';
+export interface GeneratedDocFile {
+    fileName: string;
+    content: string;
+}
+export interface McpTool {
+    name: string;
+    description: string;
+    inputSchema: Record<string, unknown>;
+    _meta?: Record<string, unknown>;
+}
+export interface SkillDefinition {
+    name: string;
+    description: string;
+    usage: string[];
+    examples: {
+        description: string;
+        code: string[];
+    }[];
+    language?: string;
+}
+export declare function getReadmeHeader(title: string): string[];
+export declare function getReadmeFooter(): string[];
+export declare function resolveDocsConfig(docs: DocsConfig | boolean | undefined): DocsConfig;
+export declare function formatArgType(arg: CleanOperation['args'][number]): string;
+export declare function formatTypeRef(t: CleanOperation['args'][number]['type']): string;
+export declare function getEditableFields(table: CleanTable): CleanField[];
+export declare function gqlTypeToJsonSchemaType(gqlType: string): string;
+export declare function buildSkillFile(skill: SkillDefinition): string;

package/esm/core/codegen/docs-utils.js

@@ -0,0 +1,112 @@
+import { getScalarFields, getPrimaryKeyInfo } from './utils';
+const CONSTRUCTIVE_LOGO_URL = 'https://raw.githubusercontent.com/constructive-io/constructive/refs/heads/main/assets/outline-logo.svg';
+const CONSTRUCTIVE_REPO = 'https://github.com/constructive-io/constructive';
+export function getReadmeHeader(title) {
+    return [
+        `# ${title}`,
+        '',
+        '<p align="center" width="100%">',
+        `  <img height="120" src="${CONSTRUCTIVE_LOGO_URL}" />`,
+        '</p>',
+        '',
+        `> @generated by @constructive-io/graphql-codegen - DO NOT EDIT`,
+        '',
+    ];
+}
+export function getReadmeFooter() {
+    return [
+        '---',
+        '',
+        'Built by the [Constructive](https://constructive.io) team.',
+        '',
+        '## Disclaimer',
+        '',
+        'AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.',
+        '',
+        'No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.',
+        '',
+    ];
+}
+export function resolveDocsConfig(docs) {
+    if (docs === true) {
+        return { readme: true, agents: true, mcp: true, skills: true };
+    }
+    if (docs === false) {
+        return { readme: false, agents: false, mcp: false, skills: false };
+    }
+    if (!docs) {
+        return { readme: true, agents: true, mcp: false, skills: false };
+    }
+    return {
+        readme: docs.readme ?? true,
+        agents: docs.agents ?? true,
+        mcp: docs.mcp ?? false,
+        skills: docs.skills ?? false,
+    };
+}
+export function formatArgType(arg) {
+    const t = arg.type;
+    if (t.kind === 'NON_NULL' && t.ofType) {
+        return `${formatTypeRef(t.ofType)} (required)`;
+    }
+    return formatTypeRef(t);
+}
+export function formatTypeRef(t) {
+    if (t.kind === 'LIST' && t.ofType) {
+        return `[${formatTypeRef(t.ofType)}]`;
+    }
+    if (t.kind === 'NON_NULL' && t.ofType) {
+        return `${formatTypeRef(t.ofType)}!`;
+    }
+    return t.name ?? 'unknown';
+}
+export function getEditableFields(table) {
+    const pk = getPrimaryKeyInfo(table)[0];
+    return getScalarFields(table).filter((f) => f.name !== pk.name &&
+        f.name !== 'nodeId' &&
+        f.name !== 'createdAt' &&
+        f.name !== 'updatedAt');
+}
+export function gqlTypeToJsonSchemaType(gqlType) {
+    switch (gqlType) {
+        case 'Int':
+            return 'integer';
+        case 'Float':
+            return 'number';
+        case 'Boolean':
+            return 'boolean';
+        default:
+            return 'string';
+    }
+}
+export function buildSkillFile(skill) {
+    const lang = skill.language ?? 'bash';
+    const lines = [];
+    lines.push(`# ${skill.name}`);
+    lines.push('');
+    lines.push('> @generated by @constructive-io/graphql-codegen - DO NOT EDIT');
+    lines.push('');
+    lines.push(skill.description);
+    lines.push('');
+    lines.push('## Usage');
+    lines.push('');
+    lines.push(`\`\`\`${lang}`);
+    for (const u of skill.usage) {
+        lines.push(u);
+    }
+    lines.push('```');
+    lines.push('');
+    lines.push('## Examples');
+    lines.push('');
+    for (const ex of skill.examples) {
+        lines.push(`### ${ex.description}`);
+        lines.push('');
+        lines.push(`\`\`\`${lang}`);
+        for (const cmd of ex.code) {
+            lines.push(cmd);
+        }
+        lines.push('```');
+        lines.push('');
+    }
+    return lines.join('\n');
+}

package/esm/core/codegen/hooks-docs-generator.d.ts

@@ -0,0 +1,6 @@
+import type { CleanOperation, CleanTable } from '../../types/schema';
+import type { GeneratedDocFile, McpTool } from './docs-utils';
+export declare function generateHooksReadme(tables: CleanTable[], customOperations: CleanOperation[]): GeneratedDocFile;
+export declare function generateHooksAgentsDocs(tables: CleanTable[], customOperations: CleanOperation[]): GeneratedDocFile;
+export declare function getHooksMcpTools(tables: CleanTable[], customOperations: CleanOperation[]): McpTool[];
+export declare function generateHooksSkills(tables: CleanTable[], customOperations: CleanOperation[]): GeneratedDocFile[];