@hazeljs/graphql 0.2.0-alpha.1

package/dist/schema-builder.js

@@ -0,0 +1,142 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SchemaBuilder = void 0;
+const graphql_1 = require("graphql");
+const core_1 = __importDefault(require("@hazeljs/core"));
+const object_type_decorator_1 = require("./decorators/object-type.decorator");
+const field_decorator_1 = require("./decorators/field.decorator");
+const query_mutation_decorator_1 = require("./decorators/query-mutation.decorator");
+const resolver_decorator_1 = require("./decorators/resolver.decorator");
+const SCALAR_MAP = {
+    String: graphql_1.GraphQLString,
+    Number: graphql_1.GraphQLFloat,
+    number: graphql_1.GraphQLFloat,
+    Boolean: graphql_1.GraphQLBoolean,
+    boolean: graphql_1.GraphQLBoolean,
+    Int: graphql_1.GraphQLInt,
+    Float: graphql_1.GraphQLFloat,
+    ID: graphql_1.GraphQLID,
+};
+class SchemaBuilder {
+    constructor() {
+        this.objectTypeCache = new Map();
+    }
+    buildSchema(resolvers, container) {
+        const queryFields = {};
+        const mutationFields = {};
+        for (const ResolverClass of resolvers) {
+            void (0, resolver_decorator_1.getResolverMetadata)(ResolverClass);
+            const instance = container.resolve(ResolverClass);
+            const queries = (0, query_mutation_decorator_1.getQueryMetadata)(ResolverClass);
+            for (const q of queries) {
+                const args = {};
+                const argMeta = (0, query_mutation_decorator_1.getArgMetadata)(ResolverClass.prototype, q.method);
+                for (const a of argMeta.filter(Boolean)) {
+                    args[a.name] = { type: this.inferType(a.type) };
+                }
+                queryFields[q.name] = {
+                    type: this.inferType(undefined),
+                    args,
+                    resolve: (_, args) => {
+                        const method = instance[q.method];
+                        if (typeof method !== 'function') {
+                            core_1.default.warn(`Query handler ${q.method} not found on ${ResolverClass.name}`);
+                            return null;
+                        }
+                        const orderedArgs = argMeta.map((a) => (a ? args[a.name] : undefined));
+                        return method.apply(instance, orderedArgs);
+                    },
+                };
+            }
+            const mutations = (0, query_mutation_decorator_1.getMutationMetadata)(ResolverClass);
+            for (const m of mutations) {
+                const args = {};
+                const argMeta = (0, query_mutation_decorator_1.getArgMetadata)(ResolverClass.prototype, m.method);
+                for (const a of argMeta.filter(Boolean)) {
+                    args[a.name] = { type: this.inferType(a.type) };
+                }
+                mutationFields[m.name] = {
+                    type: this.inferType(undefined),
+                    args,
+                    resolve: (_, args) => {
+                        const method = instance[m.method];
+                        if (typeof method !== 'function') {
+                            core_1.default.warn(`Mutation handler ${m.method} not found on ${ResolverClass.name}`);
+                            return null;
+                        }
+                        const orderedArgs = argMeta.map((a) => (a ? args[a.name] : undefined));
+                        return method.apply(instance, orderedArgs);
+                    },
+                };
+            }
+        }
+        const queryType = new graphql_1.GraphQLObjectType({
+            name: 'Query',
+            // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+            fields: () => queryFields,
+        });
+        const mutationType = Object.keys(mutationFields).length > 0
+            ? new graphql_1.GraphQLObjectType({
+                name: 'Mutation',
+                // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+                fields: () => mutationFields,
+            })
+            : undefined;
+        return new graphql_1.GraphQLSchema({
+            query: queryType,
+            ...(mutationType && { mutation: mutationType }),
+        });
+    }
+    inferType(tsType, nullable = true) {
+        if (tsType === undefined || tsType === null)
+            return graphql_1.GraphQLString;
+        const type = tsType;
+        const name = type?.name || String(tsType);
+        if (name.endsWith('[]') || name === 'Array') {
+            const inner = this.inferType({ name: name.replace('[]', '') });
+            return nullable
+                ? new graphql_1.GraphQLList(inner)
+                : new graphql_1.GraphQLNonNull(new graphql_1.GraphQLList(inner));
+        }
+        const scalar = SCALAR_MAP[name];
+        if (scalar)
+            return nullable ? scalar : new graphql_1.GraphQLNonNull(scalar);
+        const objMeta = type?.prototype && (0, object_type_decorator_1.getObjectTypeMetadata)(type.prototype);
+        if (objMeta) {
+            let objType = this.objectTypeCache.get(type.prototype);
+            if (!objType) {
+                objType = this.buildObjectType(type);
+                this.objectTypeCache.set(type.prototype, objType);
+            }
+            return nullable ? objType : new graphql_1.GraphQLNonNull(objType);
+        }
+        return graphql_1.GraphQLString;
+    }
+    buildObjectType(cls) {
+        const meta = (0, object_type_decorator_1.getObjectTypeMetadata)(cls.prototype) || { name: cls.name };
+        const fieldsMeta = (0, field_decorator_1.getFieldMetadata)(cls.prototype) || [];
+        const fields = {};
+        for (const f of fieldsMeta) {
+            if (!f)
+                continue;
+            fields[f.name] = {
+                type: this.inferType(f.type),
+                resolve: (source) => {
+                    const val = source?.[f.name];
+                    if (typeof val === 'function')
+                        return val.call(source);
+                    return val;
+                },
+            };
+        }
+        return new graphql_1.GraphQLObjectType({
+            name: meta.name,
+            // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
+            fields: () => fields,
+        });
+    }
+}
+exports.SchemaBuilder = SchemaBuilder;

package/dist/schema-builder.test.d.ts

@@ -0,0 +1,2 @@
+import 'reflect-metadata';
+//# sourceMappingURL=schema-builder.test.d.ts.map

package/dist/schema-builder.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-builder.test.d.ts","sourceRoot":"","sources":["../src/schema-builder.test.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,CAAC"}

package/dist/schema-builder.test.js

@@ -0,0 +1,182 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const core_1 = require("@hazeljs/core");
+const core_2 = require("@hazeljs/core");
+const schema_builder_1 = require("./schema-builder");
+const resolver_decorator_1 = require("./decorators/resolver.decorator");
+const query_mutation_decorator_1 = require("./decorators/query-mutation.decorator");
+let TestResolver = class TestResolver {
+    hello() {
+        return 'world';
+    }
+    user(id) {
+        return JSON.stringify({ id, name: `User ${id}` });
+    }
+    createUser(name) {
+        return JSON.stringify({ id: '1', name });
+    }
+};
+__decorate([
+    (0, query_mutation_decorator_1.Query)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", void 0)
+], TestResolver.prototype, "hello", null);
+__decorate([
+    (0, query_mutation_decorator_1.Query)(),
+    __param(0, (0, query_mutation_decorator_1.Arg)('id')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], TestResolver.prototype, "user", null);
+__decorate([
+    (0, query_mutation_decorator_1.Mutation)(),
+    __param(0, (0, query_mutation_decorator_1.Arg)('name')),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", void 0)
+], TestResolver.prototype, "createUser", null);
+TestResolver = __decorate([
+    (0, core_2.Injectable)(),
+    (0, resolver_decorator_1.Resolver)()
+], TestResolver);
+describe('SchemaBuilder', () => {
+    let container;
+    beforeEach(() => {
+        container = core_1.Container.createTestInstance();
+        container.register(TestResolver, new TestResolver());
+    });
+    it('should build schema with queries', () => {
+        const builder = new schema_builder_1.SchemaBuilder();
+        const schema = builder.buildSchema([TestResolver], container);
+        expect(schema.getQueryType()).toBeDefined();
+        expect(schema.getQueryType()?.getFields().hello).toBeDefined();
+        expect(schema.getQueryType()?.getFields().user).toBeDefined();
+    });
+    it('should build schema with mutations', () => {
+        const builder = new schema_builder_1.SchemaBuilder();
+        const schema = builder.buildSchema([TestResolver], container);
+        expect(schema.getMutationType()).toBeDefined();
+        expect(schema.getMutationType()?.getFields().createUser).toBeDefined();
+    });
+    it('should execute query resolvers', async () => {
+        const builder = new schema_builder_1.SchemaBuilder();
+        const schema = builder.buildSchema([TestResolver], container);
+        const { graphql } = await Promise.resolve().then(() => __importStar(require('graphql')));
+        const result = await graphql({ schema, source: '{ hello }' });
+        expect(result.data).toEqual({ hello: 'world' });
+    });
+    it('should execute query with args', async () => {
+        const builder = new schema_builder_1.SchemaBuilder();
+        const schema = builder.buildSchema([TestResolver], container);
+        const { graphql } = await Promise.resolve().then(() => __importStar(require('graphql')));
+        const result = await graphql({ schema, source: '{ user(id: "42") }' });
+        expect(result.errors).toBeUndefined();
+        expect(result.data?.user).toBeDefined();
+        expect(JSON.parse(result.data.user)).toMatchObject({ id: '42', name: 'User 42' });
+    });
+    it('should execute mutation', async () => {
+        const builder = new schema_builder_1.SchemaBuilder();
+        const schema = builder.buildSchema([TestResolver], container);
+        const { graphql } = await Promise.resolve().then(() => __importStar(require('graphql')));
+        const result = await graphql({
+            schema,
+            source: 'mutation { createUser(name: "Alice") }',
+        });
+        expect(result.errors).toBeUndefined();
+        expect(result.data?.createUser).toBeDefined();
+        expect(JSON.parse(result.data.createUser)).toMatchObject({ id: '1', name: 'Alice' });
+    });
+    it('should handle resolver with missing method', async () => {
+        let IncompleteResolver = class IncompleteResolver {
+            hello() {
+                return 'ok';
+            }
+        };
+        __decorate([
+            (0, query_mutation_decorator_1.Query)(),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", []),
+            __metadata("design:returntype", void 0)
+        ], IncompleteResolver.prototype, "hello", null);
+        IncompleteResolver = __decorate([
+            (0, core_2.Injectable)(),
+            (0, resolver_decorator_1.Resolver)()
+        ], IncompleteResolver);
+        const instance = new (class {
+        })();
+        container.register(IncompleteResolver, instance);
+        const builder = new schema_builder_1.SchemaBuilder();
+        const schema = builder.buildSchema([IncompleteResolver], container);
+        const { graphql } = await Promise.resolve().then(() => __importStar(require('graphql')));
+        const result = await graphql({ schema, source: '{ hello }' });
+        expect(result.data?.hello).toBeNull();
+    });
+    it('should build mutation type only when mutations exist', () => {
+        let QueryOnlyResolver = class QueryOnlyResolver {
+            only() {
+                return 'ok';
+            }
+        };
+        __decorate([
+            (0, query_mutation_decorator_1.Query)(),
+            __metadata("design:type", Function),
+            __metadata("design:paramtypes", []),
+            __metadata("design:returntype", void 0)
+        ], QueryOnlyResolver.prototype, "only", null);
+        QueryOnlyResolver = __decorate([
+            (0, core_2.Injectable)(),
+            (0, resolver_decorator_1.Resolver)()
+        ], QueryOnlyResolver);
+        container.register(QueryOnlyResolver, new QueryOnlyResolver());
+        const builder = new schema_builder_1.SchemaBuilder();
+        const schema = builder.buildSchema([QueryOnlyResolver], container);
+        expect(schema.getMutationType()).toBeUndefined();
+    });
+});

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@hazeljs/graphql",
+  "version": "0.2.0-alpha.1",
+  "description": "GraphQL server and client for HazelJS - decorator-based schema and typed client",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc --skipLibCheck",
+    "test": "jest --coverage --passWithNoTests",
+    "lint": "eslint \"src/**/*.ts\"",
+    "lint:fix": "eslint \"src/**/*.ts\" --fix",
+    "clean": "rm -rf dist"
+  },
+  "dependencies": {
+    "graphql": "^16.9.0",
+    "graphql-http": "^1.22.4"
+  },
+  "devDependencies": {
+    "@types/node": "^20.17.50",
+    "@typescript-eslint/eslint-plugin": "^8.18.2",
+    "@typescript-eslint/parser": "^8.18.2",
+    "eslint": "^8.56.0",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.3.3"
+  },
+  "peerDependencies": {
+    "@hazeljs/core": ">=0.2.0-beta.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hazel-js/hazeljs.git",
+    "directory": "packages/graphql"
+  },
+  "keywords": [
+    "hazeljs",
+    "graphql",
+    "decorators",
+    "schema",
+    "client",
+    "server"
+  ],
+  "author": "Muhammad Arslan <muhammad.arslan@hazeljs.com>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/hazeljs/hazel-js/issues"
+  },
+  "homepage": "https://hazeljs.com",
+  "gitHead": "cbc5ee2c12ced28fd0576faf13c5f078c1e8421e"
+}