Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/decorator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export interface TypeMetadata {
isPagination?: boolean;
explicitType?: any;
beforeMiddleware?: Middleware;
extraParams?: any;
}

export interface ArgumentMetadata extends TypeMetadata {
Expand Down Expand Up @@ -369,10 +370,11 @@ export function Ctx() {
} as Function;
}

export function OrderBy() {
export function OrderBy(extraColumnsToSortBy: string[] = []) {
return function (target: any, propertyKey: any, index: number) {
setArgumentMetadata(target, propertyKey, index, {
name: 'orderBy',
extraParams: extraColumnsToSortBy,
});
} as Function;
}
Expand Down
4 changes: 2 additions & 2 deletions src/object_type_factory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,15 +24,15 @@ export function objectTypeFactory(target: Function, isInput?: boolean) {
}
if (!Reflect.hasMetadata(GQ_FIELDS_KEY, target.prototype)) {
// tslint:disable-next-line:max-line-length
throw new SchemaFactoryError('Class annotated by @ObjectType() should has one or more fields annotated by @Filed()', SchemaFactoryErrorType.NO_FIELD);
throw new SchemaFactoryError('Class annotated by @ObjectType() should has one or more fields annotated by @Field()', SchemaFactoryErrorType.NO_FIELD);
}
const fieldMetadataList = Reflect.getMetadata(GQ_FIELDS_KEY, target.prototype) as FieldTypeMetadata[];
const fields: {[key: string]: any} = {};
fieldMetadataList.forEach(def => {
let field = fieldTypeFactory(target, def, isInput);
if (!field) {
// tslint:disable-next-line:max-line-length
throw new SchemaFactoryError(`@ObjectType()'s ${def.name} is annotated by @Filed() but no type could be inferred`, SchemaFactoryErrorType.NO_FIELD);
throw new SchemaFactoryError(`@ObjectType()'s ${def.name} is annotated by @Field() but no type could be inferred`, SchemaFactoryErrorType.NO_FIELD);
}
fields[def.name] = field;
});
Expand Down
13 changes: 13 additions & 0 deletions src/order-by.type-factory.ts
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,19 @@ export class OrderByTypeFactory {
orderByFieldArray.push(def);
}
});

if (metadata.args &&
metadata.args.length > 0) {

let sortArg = metadata.args.filter(arg => arg.name === 'orderBy')[0];
if ( sortArg && sortArg.extraParams && sortArg.extraParams.constructor === Array) {
sortArg.extraParams.filter((item: any) => item && item.constructor === String)
.forEach((item: string) => orderByFieldArray.push({
name: item,
description: item,
}));
}
}
let orderBySortEnumObject = OrderByTypeFactory.orderByFieldEnumFactory(metadata.name, orderByFieldArray);
let orderByDirectionEnumObject = OrderByTypeFactory.orderByDirectionEnumFactory(metadata.name);
let orderByInputObject = OrderByTypeFactory.orderByInputObjectFactory(metadata.name, orderBySortEnumObject,
Expand Down
35 changes: 35 additions & 0 deletions src/schema_factory.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ import * as graphql from 'graphql';

import { SchemaFactoryError, SchemaFactoryErrorType, schemaFactory } from './schema_factory';

import { GraphQLString } from 'graphql';
import { OrderByItem } from './order-by-item';
import { clearObjectTypeRepository } from './object_type_factory';
import { execute } from 'graphql/execution';
import { parse } from 'graphql/language';
Expand Down Expand Up @@ -130,4 +132,37 @@ describe('schemaFactory', function() {
done();
});

describe('Pagination', function() {

it('returns a GraphQL Pagination object with custom @OrberBy fields', async function() {

@D.ObjectType()
class Obj {
@D.Description('a field')
@D.Field({ type: GraphQLString })
aField: string;
}

@D.ObjectType() class Query {
@D.Field({ type: Obj })
@D.Pagination()
async paginate(
@D.OrderBy(['extraField']) orderBy?: OrderByItem[],
): Promise<[Obj, number]> {
return [{ aField: null }, 0];
}
}
@D.Schema() class Schema { @D.Query() query: Query; }
const schema = schemaFactory(Schema);
const ast = parse(`
query {
paginate(orderBy: [{sort: aField, direction: ASC}, {sort: extraField, direction: DESC}]) {
count
}
}`);
assert.deepEqual(validate(schema, ast), []);
});

});

});