Anteek by ZiCenter  

Node.js CLI Framework for GraphQL to NestJS Server Conversion

Introduction

This Node.js CLI framework simplifies the process of converting GraphQL schema types into a fully-fledged NestJS GraphQL server using Prisma as the ORM. The framework introduces two essential files: schema.graphqls for defining database entity types and policies.graphqls for specifying security access policies. Additionally, it provides custom GraphQL directives to enhance schema generation.

Installation

Install the framework globally using npm or yarn:

npm install -g @zicenter/anteek

yarn global add anteek

Getting Started

1. Create a new anteek project

anteek new sample-project

2. Start the dev server

npm run start:dev

Open localhost:3000 in your browser

1. Update the src/schema.graphqls file to define your database entity types.
2. Update src/policies.graphqls file to specify security access policies.

Custom GraphQL Directives

1. @mapsTo(field: String)

Maps a field in a GraphQL type to a field in another type for Prisma schema generation.

Example:

type User {
    externalId: String @prisma(attributes: ["unique"])
    collaboratingTeams: [Team!] @mapsTo(field: "members")
}

2. @prisma(attributes: [String!])

Adds extra Prisma attributes during database schema generation.

Example:

type User {
    externalId: String @prisma(attributes: ["unique"])
}

3. @http(input: String = "String", request: HttpRequest!, name: String)

Generates GraphQL operations that proxy to an HTTP upstream.

Example:

type GitProvider
@http(input: "String", request: { method: POST, url: "https://example.com/api" }, name: "proxyGitProvider")

4. @database(create: Boolean, list: Boolean, aggregate: Boolean, single: Boolean, update: Boolean, delete: Boolean)

Generates database-related GraphQL operations based on allowed actions.

Example:

type Project
@database(create: true, list: true, single: true, delete: true)

5. @function(name: String!, operation: Operation!, input: String)

Generates a Node.js operation that calls a custom JavaScript function for its logic.

Example:

type GitProvider
@function(name: "retrieveGitToken", input: "RetrieveTokenInput", operation: Query)

Sample Files

schema.graphqls

enum ProjectStatus {
    creating destroying ready maintenance
}

enum GitProviderName {
    github gitlab bitbucket
}

# ... Other types ...

type Team
@database(list: true)
{
    name: String
    members: [User!] @mapsTo(field: "collaboratingTeams")
    owner: User! @mapsTo(field: "ownedTeams")
}

type Project
@database(create: true, list: true, single: true, delete: true)
{
    name: String
    # ... Other fields ...
}

policies.graphqls

extend type GitProvider
@policy(name: "owned-by-user_id")
    @actions
        @owner(userIdField: "user.id")
        @hide(fields: ["items.token", "token"])

extend type Project
@policy(name: "owned-by-owner_id")
    @actions
        @owner(userIdField: "owner.id")

extend type Team
@policy(useExisting: "owned-by-owner_id")

CLI Commands

• [Anteek by ZiCenter   ](#anteek-by-zicenter-nbsp-oclifhttpsavatarsgithubusercontentcomu68411174s26v4httpswwwzicentercom)
• ... Other types ...
• Usage
• Commands

Usage

$ npm install -g @zicenter/anteek
$ anteek COMMAND
running command...
$ anteek (--version)
@zicenter/anteek/6.1.15 linux-x64 node-v14.21.3
$ anteek --help [COMMAND]
USAGE
  $ anteek COMMAND
...

Commands

• anteek compile
• anteek function [FILE]
• anteek help [COMMAND]
• anteek new FILE
• anteek plugins
• anteek plugins:install PLUGIN...
• anteek plugins:inspect PLUGIN...
• anteek plugins:install PLUGIN...
• anteek plugins:link PLUGIN
• anteek plugins:uninstall PLUGIN...
• anteek plugins:uninstall PLUGIN...
• anteek plugins:uninstall PLUGIN...
• anteek plugins update

anteek compile

compile a graphql schema

USAGE
  $ anteek compile -c <value> [-p <value>] [--watch]

FLAGS
  -c, --config=<value>  (required) [default: anteek.config.js] path to project config
  -p, --policy=<value>  path to policy yaml
  --watch

DESCRIPTION
  compile a graphql schema

EXAMPLES
  $ anteek compile

See code: dist/commands/compile.ts

anteek function [FILE]

describe the command here

USAGE
  $ anteek function [FILE] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ anteek function

See code: dist/commands/function.ts

anteek help [COMMAND]

Display help for anteek.

USAGE
  $ anteek help [COMMAND] [-n]

ARGUMENTS
  COMMAND  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for anteek.

See code: @oclif/plugin-help

anteek new FILE

create new anteek graph project

USAGE
  $ anteek new [FILE]

DESCRIPTION
  create new anteek graph project

EXAMPLES
  $ anteek new

See code: dist/commands/new.ts

anteek plugins

List installed plugins.

USAGE
  $ anteek plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ anteek plugins

See code: @oclif/plugin-plugins

anteek plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ anteek plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ anteek plugins add

EXAMPLES
  $ anteek plugins:install myplugin 

  $ anteek plugins:install https://github.com/someuser/someplugin

  $ anteek plugins:install someuser/someplugin

anteek plugins:inspect PLUGIN...

Displays installation properties of a plugin.

USAGE
  $ anteek plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ anteek plugins:inspect myplugin

anteek plugins:install PLUGIN...

Installs a plugin into the CLI.

USAGE
  $ anteek plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ anteek plugins add

EXAMPLES
  $ anteek plugins:install myplugin 

  $ anteek plugins:install https://github.com/someuser/someplugin

  $ anteek plugins:install someuser/someplugin

anteek plugins:link PLUGIN

Links a plugin into the CLI for development.

USAGE
  $ anteek plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ anteek plugins:link myplugin

anteek plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ anteek plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ anteek plugins unlink
  $ anteek plugins remove

anteek plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ anteek plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ anteek plugins unlink
  $ anteek plugins remove

anteek plugins:uninstall PLUGIN...

Removes a plugin from the CLI.

USAGE
  $ anteek plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ anteek plugins unlink
  $ anteek plugins remove

anteek plugins update

Update installed plugins.

USAGE
  $ anteek plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.