@leosprograms/vf-graphql-holochain/index.ts

GraphQL schema bindings for the Holochain implementation of ValueFlows

/**
 * HoloREA GraphQL schema interface
 *
 * A GraphQL schema (suitable for use with `apollo-link-schema`) which defines
 * bindings between the ValueFlows protocol and a Holochain backend.
 *
 * @package: HoloREA
 * @since:   2019-05-20
 */

import merge from 'deepmerge'
import { makeExecutableSchema } from '@graphql-tools/schema'

import {
  ResolverOptions,
  ExtensionOptions,
  BindSchemaOptions,
  DEFAULT_VF_MODULES,
  DNAIdMappings,
  CellId,
  VfModule
} from './types.js'
import generateResolvers from './resolvers/index.js'
import * as hreaExtensionSchemas from './schema-extensions.js'
import { mapZomeFn, autoConnect, openConnection, sniffHolochainAppCells, remapCellId } from './connection.js'
// @ts-ignore
import { buildSchema, printSchema } from '@leosprograms/vf-graphql'

export {
  // direct access to resolver callbacks generator for apps that need to bind to other GraphQL schemas
  generateResolvers,
  // schema extensions
  hreaExtensionSchemas,
  // connection handling methods
  autoConnect, openConnection, sniffHolochainAppCells,
  // direct access to Holochain zome method bindings for authoring own custom resolvers bound to non-REA DNAs
  mapZomeFn,
  // types that wrapper libraries may need to manage conductor DNA connection logic
  DNAIdMappings, CellId, BindSchemaOptions, ExtensionOptions, ResolverOptions,
  // valueflows modules and the default configuration
  VfModule, DEFAULT_VF_MODULES,

  // :TODO: remove this. After #266 clients should not need to think about differing IDs between Cells.
  remapCellId,
}

/**
 * Generates a schema ready to be plugged in to a GraphQL client
 *
 * @return GraphQLSchema
 */
const bindSchema = async (options: BindSchemaOptions) => {
  const {
    weaveAppAgentClient,
    // assign the default VfModule set, so that this can be optional
    enabledVFModules = DEFAULT_VF_MODULES,
    dnaConfig,
    conductorUri,
    adminConductorUri,
    appId,
    traceAppSignals,
    extensionSchemas = [],
    extensionResolvers = {},
  } = options

  const coreResolvers = await generateResolvers({
    weaveAppAgentClient,
    enabledVFModules,
    dnaConfig,
    conductorUri,
    adminConductorUri,
    appId,
    traceAppSignals
  })
  const resolvers = merge(coreResolvers, extensionResolvers)

  // extend the base vf-graphql schema with one
  // or more holochain specific schema extensions.
  // add more here if more are added.
  const overriddenExtensionSchemas = [...extensionSchemas, hreaExtensionSchemas.associateMyAgentExtension, hreaExtensionSchemas.recipes, hreaExtensionSchemas.hasIds]

  return makeExecutableSchema({
    typeDefs: printSchema(buildSchema(enabledVFModules, overriddenExtensionSchemas)),
    resolvers,
  })
}

export default bindSchema