@commitspark/graphql-api 0.10.0 → 0.11.0

package/src/graphql/field-resolver/fieldResolver.ts

@@ -1,5 +1,5 @@
 import { GraphQLFieldResolver } from 'graphql/type/definition'
-import { Entry } from '../../persistence/persistence.service'
+import { EntryData } from '@commitspark/git-adapter'
 import { GitAdapter } from '@commitspark/git-adapter'
 
 export interface FieldResolverContext {
@@ -11,7 +11,7 @@ export interface FieldResolver<
   TSource,
   TContext = FieldResolverContext,
   TArgs = any,
-  TResult = Promise<ResolvedEntryData<Entry | Entry[] | null>>,
+  TResult = Promise<ResolvedEntryData<EntryData | EntryData[] | null>>,
 > {
   resolve: GraphQLFieldResolver<TSource, TContext, TArgs, TResult>
 }

package/src/graphql/field-resolver/union-value-resolver.ts

@@ -1,5 +1,5 @@
 import { GraphQLFieldResolver } from 'graphql/type/definition'
-import { Entry } from '../../persistence/persistence.service'
+import { EntryData } from '@commitspark/git-adapter'
 import {
   FieldResolver,
   ResolvedEntryData,
@@ -12,7 +12,7 @@ export class UnionValueResolver implements FieldResolver<any> {
     any,
     FieldResolverContext,
     any,
-    Promise<ResolvedEntryData<Entry | Entry[] | null>>
+    Promise<ResolvedEntryData<EntryData | EntryData[] | null>>
   >
 
   constructor(private readonly unionTypeUtil: UnionTypeUtil) {
@@ -21,13 +21,13 @@ export class UnionValueResolver implements FieldResolver<any> {
       args,
       context,
       info,
-    ): Promise<ResolvedEntryData<Entry | Entry[] | null>> =>
+    ): Promise<ResolvedEntryData<EntryData | EntryData[] | null>> =>
       this.resolveFieldValue(fieldValue)
   }
 
   private resolveFieldValue(
     fieldValue: any,
-  ): Promise<ResolvedEntryData<Entry | Entry[] | null>> {
+  ): Promise<ResolvedEntryData<EntryData | EntryData[] | null>> {
     const typeName =
       this.unionTypeUtil.getUnionTypeNameFromFieldValue(fieldValue)
     const unionValue = this.unionTypeUtil.getUnionValue(fieldValue)
@@ -36,7 +36,7 @@ export class UnionValueResolver implements FieldResolver<any> {
     // with this actual data and add a `__typename` field, so that our output data
     // corresponds to the output schema provided by the user (i.e. there is
     // no additional nesting level there).
-    const res: Entry = {
+    const res: EntryData = {
       ...unionValue,
       __typename: typeName,
     }

package/src/graphql/queries-mutations-generator.service.ts

@@ -1,4 +1,4 @@
-import { Entry } from '../persistence/persistence.service'
+import { EntryData } from '@commitspark/git-adapter'
 import { ApolloContext } from '../app/api.service'
 import { GraphQLFieldResolver } from 'graphql/type/definition'
 import { GraphQLObjectType } from 'graphql/type'
@@ -33,7 +33,7 @@ export class QueriesMutationsGeneratorService {
         any,
         ApolloContext,
         any,
-        Promise<Entry[]>
+        Promise<EntryData[]>
       > = this.queryAllResolverGenerator.createResolver(typeName)
 
       const queryAllMetaName = `_${queryAllName}Meta`
@@ -51,7 +51,7 @@ export class QueriesMutationsGeneratorService {
         any,
         ApolloContext,
         any,
-        Promise<Entry>
+        Promise<EntryData>
       > = this.queryByIdResolverGenerator.createResolver(typeName)
 
       const inputTypeName = `${typeName}Input`
@@ -61,7 +61,7 @@ export class QueriesMutationsGeneratorService {
         any,
         ApolloContext,
         any,
-        Promise<Entry>
+        Promise<EntryData>
       > = this.mutationCreateResolverGenerator.createResolver(typeName)
 
       const updateMutationName = `update${typeName}`
@@ -70,7 +70,7 @@ export class QueriesMutationsGeneratorService {
         any,
         ApolloContext,
         any,
-        Promise<Entry>
+        Promise<EntryData>
       > = this.mutationUpdateResolverGenerator.createResolver(typeName)
 
       const deleteMutationName = `delete${typeName}`
@@ -79,7 +79,7 @@ export class QueriesMutationsGeneratorService {
         any,
         ApolloContext,
         any,
-        Promise<Entry>
+        Promise<EntryData>
       > = this.mutationDeleteResolverGenerator.createResolver(typeName)
 
       return {
@@ -118,9 +118,9 @@ export class QueriesMutationsGeneratorService {
   }
 
   public generateTypeNameQuery(): IGeneratedQuery<Promise<string>> {
-    const contentTypeQueryName = '_typeName'
-    const contentTypeQueryString = `${contentTypeQueryName}(id: ID!): String`
-    const contentTypeQueryResolver: GraphQLFieldResolver<
+    const entryTypeQueryName = '_typeName'
+    const entryTypeQueryString = `${entryTypeQueryName}(id: ID!): String`
+    const entryTypeQueryResolver: GraphQLFieldResolver<
       any,
       ApolloContext,
       any,
@@ -128,20 +128,20 @@ export class QueriesMutationsGeneratorService {
     > = this.queryTypeByIdResolverGenerator.createResolver()
 
     return {
-      name: contentTypeQueryName,
-      schemaString: contentTypeQueryString,
-      resolver: contentTypeQueryResolver,
+      name: entryTypeQueryName,
+      schemaString: entryTypeQueryString,
+      resolver: entryTypeQueryResolver,
     }
   }
 }
 
 export interface IGeneratedSchema {
-  queryAll: IGeneratedQuery<Promise<Entry[]>>
+  queryAll: IGeneratedQuery<Promise<EntryData[]>>
   queryAllMeta: IGeneratedQuery<Promise<TypeCount>>
-  queryById: IGeneratedQuery<Promise<Entry>>
-  createMutation: IGeneratedQuery<Promise<Entry>>
-  updateMutation: IGeneratedQuery<Promise<Entry>>
-  deleteMutation: IGeneratedQuery<Promise<Entry>>
+  queryById: IGeneratedQuery<Promise<EntryData>>
+  createMutation: IGeneratedQuery<Promise<EntryData>>
+  updateMutation: IGeneratedQuery<Promise<EntryData>>
+  deleteMutation: IGeneratedQuery<Promise<EntryData>>
 }
 
 export interface IGeneratedQuery<T> {

package/src/graphql/resolver-generators/mutation-create-resolver-generator.ts

@@ -1,14 +1,12 @@
 import { GraphQLFieldResolver } from 'graphql/type/definition'
 import { ApolloContext } from '../../app/api.service'
-import {
-  Entry,
-  PersistenceService,
-} from '../../persistence/persistence.service'
+import { PersistenceService } from '../../persistence/persistence.service'
 import { GraphQLError } from 'graphql/error/GraphQLError'
 import { EntryReferenceUtil } from '../schema-utils/entry-reference-util'
 import { isObjectType } from 'graphql'
 import {
-  ContentEntryDraft,
+  EntryDraft,
+  EntryData,
   ENTRY_ID_INVALID_CHARACTERS,
 } from '@commitspark/git-adapter'
 
@@ -20,13 +18,13 @@ export class MutationCreateResolverGenerator {
 
   public createResolver(
     typeName: string,
-  ): GraphQLFieldResolver<any, ApolloContext, any, Promise<Entry>> {
+  ): GraphQLFieldResolver<any, ApolloContext, any, Promise<EntryData>> {
     return async (
       source,
       args,
       context: ApolloContext,
       info,
-    ): Promise<Entry> => {
+    ): Promise<EntryData> => {
       if (!isObjectType(info.returnType)) {
         throw new Error('Expected to create an ObjectType')
       }
@@ -70,7 +68,7 @@ export class MutationCreateResolverGenerator {
           args.data,
         )
 
-      const referencedEntryUpdates: ContentEntryDraft[] = []
+      const referencedEntryUpdates: EntryDraft[] = []
       for (const referencedEntryId of referencedEntryIds) {
         const referencedEntry = await this.persistence.findById(
           context.gitAdapter,
@@ -81,7 +79,7 @@ export class MutationCreateResolverGenerator {
           ...(referencedEntry.metadata.referencedBy ?? []),
           args.id,
         ].sort()
-        const newReferencedEntryDraft: ContentEntryDraft = {
+        const newReferencedEntryDraft: EntryDraft = {
           ...referencedEntry,
           metadata: {
             ...referencedEntry.metadata,
@@ -92,7 +90,7 @@ export class MutationCreateResolverGenerator {
         referencedEntryUpdates.push(newReferencedEntryDraft)
       }
 
-      const newEntryDraft: ContentEntryDraft = {
+      const newEntryDraft: EntryDraft = {
         id: args.id,
         metadata: {
           type: typeName,
@@ -105,7 +103,7 @@ export class MutationCreateResolverGenerator {
       const commit = await context.gitAdapter.createCommit({
         ref: context.branch,
         parentSha: context.getCurrentRef(),
-        contentEntries: [newEntryDraft, ...referencedEntryUpdates],
+        entries: [newEntryDraft, ...referencedEntryUpdates],
         message: args.message,
       })
       context.setCurrentRef(commit.ref)

package/src/graphql/resolver-generators/mutation-delete-resolver-generator.ts

@@ -1,11 +1,8 @@
-import {
-  Entry,
-  PersistenceService,
-} from '../../persistence/persistence.service'
+import { PersistenceService } from '../../persistence/persistence.service'
 import { GraphQLFieldResolver } from 'graphql/type/definition'
 import { ApolloContext } from '../../app/api.service'
 import { GraphQLError } from 'graphql/error/GraphQLError'
-import { ContentEntry, ContentEntryDraft } from '@commitspark/git-adapter'
+import { Entry, EntryData, EntryDraft } from '@commitspark/git-adapter'
 import { EntryReferenceUtil } from '../schema-utils/entry-reference-util'
 import { isObjectType } from 'graphql'
 
@@ -17,14 +14,14 @@ export class MutationDeleteResolverGenerator {
 
   public createResolver(
     typeName: string,
-  ): GraphQLFieldResolver<any, ApolloContext, any, Promise<Entry>> {
+  ): GraphQLFieldResolver<any, ApolloContext, any, Promise<EntryData>> {
     return async (
       source,
       args,
       context: ApolloContext,
       info,
-    ): Promise<Entry> => {
-      const entry: ContentEntry = await this.persistence.findByTypeId(
+    ): Promise<EntryData> => {
+      const entry: Entry = await this.persistence.findByTypeId(
         context.gitAdapter,
         context.getCurrentRef(),
         typeName,
@@ -62,7 +59,7 @@ export class MutationDeleteResolverGenerator {
           entryType,
           entry.data,
         )
-      const referencedEntryUpdates: ContentEntryDraft[] = []
+      const referencedEntryUpdates: EntryDraft[] = []
       for (const referencedEntryId of referencedEntryIds) {
         const noLongerReferencedEntry = await this.persistence.findById(
           context.gitAdapter,
@@ -84,7 +81,7 @@ export class MutationDeleteResolverGenerator {
       const commit = await context.gitAdapter.createCommit({
         ref: context.branch,
         parentSha: context.getCurrentRef(),
-        contentEntries: [
+        entries: [
           {
             ...entry,
             deletion: true,

package/src/graphql/resolver-generators/mutation-update-resolver-generator.ts

@@ -1,12 +1,9 @@
-import {
-  Entry,
-  PersistenceService,
-} from '../../persistence/persistence.service'
+import { PersistenceService } from '../../persistence/persistence.service'
 import { GraphQLFieldResolver } from 'graphql/type/definition'
 import { ApolloContext } from '../../app/api.service'
 import { EntryReferenceUtil } from '../schema-utils/entry-reference-util'
 import { isObjectType } from 'graphql'
-import { ContentEntryData, ContentEntryDraft } from '@commitspark/git-adapter'
+import { EntryData, EntryDraft } from '@commitspark/git-adapter'
 
 export class MutationUpdateResolverGenerator {
   constructor(
@@ -16,13 +13,13 @@ export class MutationUpdateResolverGenerator {
 
   public createResolver(
     typeName: string,
-  ): GraphQLFieldResolver<any, ApolloContext, any, Promise<Entry>> {
+  ): GraphQLFieldResolver<any, ApolloContext, any, Promise<EntryData>> {
     return async (
       source,
       args,
       context: ApolloContext,
       info,
-    ): Promise<Entry> => {
+    ): Promise<EntryData> => {
       if (!isObjectType(info.returnType)) {
         throw new Error('Expected to update an ObjectType')
       }
@@ -60,7 +57,7 @@ export class MutationUpdateResolverGenerator {
         (entryId) => !existingReferencedEntryIds.includes(entryId),
       )
 
-      const referencedEntryUpdates: ContentEntryDraft[] = []
+      const referencedEntryUpdates: EntryDraft[] = []
       for (const noLongerReferencedEntryId of noLongerReferencedIds) {
         const noLongerReferencedEntry = await this.persistence.findById(
           context.gitAdapter,
@@ -101,7 +98,7 @@ export class MutationUpdateResolverGenerator {
       const commit = await context.gitAdapter.createCommit({
         ref: context.branch,
         parentSha: context.getCurrentRef(),
-        contentEntries: [
+        entries: [
           { ...existingEntry, data: mergedData, deletion: false },
           ...referencedEntryUpdates,
         ],
@@ -120,9 +117,9 @@ export class MutationUpdateResolverGenerator {
   }
 
   private mergeData(
-    existingEntryData: ContentEntryData,
-    updateData: ContentEntryData,
-  ): ContentEntryData {
+    existingEntryData: EntryData,
+    updateData: EntryData,
+  ): EntryData {
     return {
       ...existingEntryData,
       ...updateData,

package/src/graphql/resolver-generators/object-type-field-default-value-resolver-generator.ts

@@ -3,7 +3,7 @@ import {
   GraphQLOutputType,
 } from 'graphql/type/definition'
 import { ApolloContext } from '../../app/api.service'
-import { Entry } from '../../persistence/persistence.service'
+import { EntryData } from '@commitspark/git-adapter'
 import {
   GraphQLField,
   GraphQLObjectType,
@@ -31,7 +31,7 @@ export class ObjectTypeFieldDefaultValueResolverGenerator {
         any,
         ApolloContext,
         any,
-        Promise<ResolvedEntryData<Entry | Entry[] | null>>
+        Promise<ResolvedEntryData<EntryData | EntryData[] | null>>
       >
     >
   > {
@@ -43,7 +43,7 @@ export class ObjectTypeFieldDefaultValueResolverGenerator {
           any,
           ApolloContext,
           any,
-          Promise<ResolvedEntryData<Entry | Entry[] | null>>
+          Promise<ResolvedEntryData<EntryData | EntryData[] | null>>
         >
       >
     > = {}
@@ -62,7 +62,7 @@ export class ObjectTypeFieldDefaultValueResolverGenerator {
           any,
           ApolloContext,
           any,
-          Promise<ResolvedEntryData<Entry | Entry[] | null>>
+          Promise<ResolvedEntryData<EntryData | EntryData[] | null>>
         >
       > = {}
       for (const field of fieldsForCustomDefaultValueResolver) {
@@ -71,7 +71,7 @@ export class ObjectTypeFieldDefaultValueResolverGenerator {
           args,
           context,
           info,
-        ): Promise<ResolvedEntryData<Entry | Entry[] | null>> =>
+        ): Promise<ResolvedEntryData<EntryData | EntryData[] | null>> =>
           this.fieldDefaultValueResolver.resolve(
             field.name in obj ? obj[field.name] : undefined,
             args,

package/src/graphql/resolver-generators/query-all-resolver-generator.ts

@@ -1,8 +1,6 @@
 import { ApolloContext } from '../../app/api.service'
-import {
-  Entry,
-  PersistenceService,
-} from '../../persistence/persistence.service'
+import { EntryData } from '@commitspark/git-adapter'
+import { PersistenceService } from '../../persistence/persistence.service'
 import { GraphQLFieldResolver } from 'graphql/type/definition'
 
 export class QueryAllResolverGenerator {
@@ -10,13 +8,13 @@ export class QueryAllResolverGenerator {
 
   public createResolver(
     typeName: string,
-  ): GraphQLFieldResolver<any, ApolloContext, any, Promise<Entry[]>> {
+  ): GraphQLFieldResolver<any, ApolloContext, any, Promise<EntryData[]>> {
     return async (
       obj,
       args,
       context: ApolloContext,
       info,
-    ): Promise<Entry[]> => {
+    ): Promise<EntryData[]> => {
       const entries = await this.persistence.findByType(
         context.gitAdapter,
         context.getCurrentRef(),

package/src/graphql/resolver-generators/query-by-id-resolver-generator.ts

@@ -1,7 +1,5 @@
-import {
-  Entry,
-  PersistenceService,
-} from '../../persistence/persistence.service'
+import { EntryData } from '@commitspark/git-adapter'
+import { PersistenceService } from '../../persistence/persistence.service'
 import { GraphQLFieldResolver } from 'graphql/type/definition'
 import { ApolloContext } from '../../app/api.service'
 
@@ -10,8 +8,8 @@ export class QueryByIdResolverGenerator {
 
   public createResolver(
     typeName: string,
-  ): GraphQLFieldResolver<any, ApolloContext, any, Promise<Entry>> {
-    return async (obj, args, context, info): Promise<Entry> => {
+  ): GraphQLFieldResolver<any, ApolloContext, any, Promise<EntryData>> {
+    return async (obj, args, context, info): Promise<EntryData> => {
       const entry = await this.persistence.findByTypeId(
         context.gitAdapter,
         context.getCurrentRef(),

package/src/graphql/schema-generator.service.ts

@@ -14,7 +14,7 @@ import {
   GraphQLTypeResolver,
 } from 'graphql/type/definition'
 import { SchemaValidator } from './schema-validator'
-import { Entry } from '../persistence/persistence.service'
+import { EntryData } from '@commitspark/git-adapter'
 import { ObjectTypeFieldDefaultValueResolverGenerator } from './resolver-generators/object-type-field-default-value-resolver-generator'
 
 export class SchemaGeneratorService {
@@ -65,7 +65,7 @@ export class SchemaGeneratorService {
           Record<string, any>,
           ApolloContext,
           any,
-          Promise<Entry | Entry[] | null>
+          Promise<EntryData | EntryData[] | null>
         >
       >
     > = {}

package/src/graphql/schema-utils/union-type-util.ts

@@ -1,4 +1,4 @@
-import { Entry } from '../../persistence/persistence.service'
+import { EntryData } from '@commitspark/git-adapter'
 
 export class UnionTypeUtil {
   public getUnionTypeNameFromFieldValue(fieldValue: any): string {
@@ -12,7 +12,7 @@ export class UnionTypeUtil {
     return firstKey.slice(0, 1).toUpperCase() + firstKey.slice(1)
   }
 
-  public getUnionValue(fieldValue: any): Entry {
+  public getUnionValue(fieldValue: any): EntryData {
     if (typeof fieldValue !== 'object') {
       throw new Error('Expected object as union value')
     }

package/src/persistence/persistence.service.ts

@@ -1,4 +1,4 @@
-import { ContentEntry, GitAdapter } from '@commitspark/git-adapter'
+import { Entry, GitAdapter } from '@commitspark/git-adapter'
 import { GraphQLError } from 'graphql/error/GraphQLError'
 
 export class PersistenceService {
@@ -7,10 +7,8 @@ export class PersistenceService {
     commitHash: string,
     id: string,
   ): Promise<string> {
-    const allEntries = await gitAdapter.getContentEntries(commitHash)
-    const requestedEntry = allEntries.find(
-      (contentEntry: ContentEntry) => contentEntry.id === id,
-    )
+    const allEntries = await gitAdapter.getEntries(commitHash)
+    const requestedEntry = allEntries.find((entry: Entry) => entry.id === id)
     if (requestedEntry === undefined) {
       throw new GraphQLError(`Not found: ${id}`, {
         extensions: {
@@ -26,11 +24,9 @@ export class PersistenceService {
     gitAdapter: GitAdapter,
     commitHash: string,
     id: string,
-  ): Promise<ContentEntry> {
-    const allEntries = await gitAdapter.getContentEntries(commitHash)
-    const requestedEntry = allEntries.find(
-      (contentEntry: ContentEntry) => contentEntry.id === id,
-    )
+  ): Promise<Entry> {
+    const allEntries = await gitAdapter.getEntries(commitHash)
+    const requestedEntry = allEntries.find((entry: Entry) => entry.id === id)
     if (requestedEntry === undefined) {
       throw new GraphQLError(`Not found: ${id}`, {
         extensions: {
@@ -46,11 +42,9 @@ export class PersistenceService {
     gitAdapter: GitAdapter,
     commitHash: string,
     type: string,
-  ): Promise<ContentEntry[]> {
-    const allEntries = await gitAdapter.getContentEntries(commitHash)
-    return allEntries.filter(
-      (contentEntry: ContentEntry) => contentEntry.metadata.type === type,
-    )
+  ): Promise<Entry[]> {
+    const allEntries = await gitAdapter.getEntries(commitHash)
+    return allEntries.filter((entry: Entry) => entry.metadata.type === type)
   }
 
   public async findByTypeId(
@@ -58,11 +52,10 @@ export class PersistenceService {
     commitHash: string,
     type: string,
     id: string,
-  ): Promise<ContentEntry> {
-    const allEntries = await gitAdapter.getContentEntries(commitHash)
+  ): Promise<Entry> {
+    const allEntries = await gitAdapter.getEntries(commitHash)
     const requestedEntry = allEntries.find(
-      (contentEntry: ContentEntry) =>
-        contentEntry.id === id && contentEntry.metadata.type === type,
+      (entry: Entry) => entry.id === id && entry.metadata.type === type,
     )
     if (requestedEntry === undefined) {
       throw new GraphQLError(
@@ -79,9 +72,3 @@ export class PersistenceService {
     return requestedEntry
   }
 }
-
-export interface CommitResult {
-  ref: string // commit sha
-}
-
-export type Entry = Record<string, unknown>