Grapher Link Executor

This package allows you to define your grapher links along side your collection definitions while avoiding circular imports which cause invalid config errors when the collection key of your link is undefined.

• Support
• Installation
• TypeScript
• Usage
  • addLinks(CollectionInstance, LinkDefinition)
  • executeLinks()

Support

If you find this package useful, please consider supporting my work through Patreon, or Paypal. A few dollars a month on Patreon can help maintain this package and support the additional creation of other packaages and content such as video tutorials demonstrating package usage.

Installation

meteor add copleykj:grapher-link-executor

TypeScript

This package does not require you to use TypeScript, but it is written in TypeScript and includes type definitions in grapher-link-executor.d.ts in case you are.

Unfortunately these aren't automatically picked up by editors such as VSCode and they will need to be copied into your projects type defintions manually.

declare module 'meteor/copleykj:grapher-link-executor' {
  import { Mongo } from 'meteor/mongo';
  import { Grapher } from 'meteor/cultofcoders:grapher';
  export function addLinks<T> (collection: Mongo.Collection<T>, links: Grapher.Link<any>): void;
  export const executeLinks: () => void;
}

Usage

There are 2 functions exported from this package addLinks and executeLinks.

addLinks(CollectionInstance, LinkDefinition)

addLinks is similar to the function added to Mongo.Collection by cultofcoders:grapher except it takes a Collection as it's first argument, and the link definitions as it's second.

// /api/posts.ts
import { addLinks } from "meteor/copleykj:grapher-link-executor";

export interface Post {
    id?: string;
    authorId: string;
    text: string;
}

export const PostsCollection = new Mongo.Collection<Post>('posts');

Meteor.startup(() => {
    addLinks(PostsCollection, {
        'author': {
            type: 'one',
            field: 'authorId',
            collection: Meteor.users,
        }
    });
})

// /api/users.ts

import { Meteor } from 'meteor/meteor';
import { Post, PostsCollection } from './posts';
import { addLinks } from 'meteor/copleykj:grapher-link-executor';

export interface User extends Meteor.User {
    posts: Post[]
}

export const UsersCollection = Meteor.users;

export const Queries = {
    AllUsers: UsersCollection.createQuery('allUsersQuery', {
        _id: 1,
        username: 1,
        posts: {
            text: 1
        }
    }),
}


Meteor.statup(() => {
    addLinks(UsersCollection, {
        'posts': {
            collection: PostsCollection,
            inversedBy: 'author'
        }
    });
});

executeLinks()

executeLinks takes all the links and commits them to your collections by calling Collection.addLinks and ensuring that all the collection keys are defined, and the inverse links are added after the rest of the links. Call this function either from a file that is loaded on both client and server, or from one file in the server and one on the client.

// /api/index.ts

import { executeLinks } from 'meteor/copleykj:grapher-link-executor';

export { Post, PostsCollection } from './posts';
export { User, UsersCollection, Queries } from './users';


executeLinks();