@contember/client-content 2.1.0-alpha.20 → 2.1.0-alpha.22

package/src/nodes/TypedEntitySelection.ts

@@ -26,6 +26,10 @@ export interface TypedEntitySelection<TSchema extends SchemaTypeLike, TEntityNam
 		[key in TAlias extends null ? TKey : TAlias]: TypedEntitySelectionResult<TEntity, TKey, TNestedValue>
 	}>
 
+	omit<TField extends keyof TValue>(
+		...fields: TField[]
+	): TypedEntitySelection<TSchema, TEntityName, TEntity, Omit<TValue, TField>>
+
 
 	meta<
 		TField extends (keyof TEntity['columns'] | keyof TEntity['hasMany'] | keyof TEntity['hasOne'])

package/src/types/Result.ts

@@ -1,26 +1,58 @@
 import { Result } from '@contember/schema'
 
-export type TransactionResult<V> = {
-	readonly ok: boolean
-	readonly errorMessage: string | null
+export type TransactionOkResult<V> = {
+	readonly ok: true
+	readonly errorMessage: null
+	readonly errors: []
+	readonly validation: ValidationOkResult
+	readonly data: V
+}
+export type TransactionFailResult<V> = {
+	readonly ok: false
+	readonly errorMessage: string
 	readonly errors: MutationError[]
 	readonly validation: ValidationResult
 	readonly data: V
 }
 
-export type MutationResult<Value = unknown> = {
+export type TransactionResult<V> =
+	| TransactionOkResult<V>
+	| TransactionFailResult<V>
+
+export type MutationOkResult<Value = unknown> = {
+	readonly ok: true
+	readonly errorMessage: null
+	readonly errors: []
+	readonly node: Value | null // still may be null
+	readonly validation: ValidationOkResult
+}
+
+export type MutationFailResult = {
 	readonly ok: boolean
-	readonly errorMessage: string | null
+	readonly errorMessage: string
 	readonly errors: MutationError[]
-	readonly node: Value | null
-	readonly validation?: ValidationResult
+	readonly node: null
+	readonly validation: ValidationResult
 }
 
-export type ValidationResult = {
-	readonly valid: boolean
+export type MutationResult<Value = unknown> =
+	| MutationOkResult<Value>
+	| MutationFailResult
+
+export type ValidationOkResult = {
+	readonly valid: true
+	readonly errors: []
+}
+
+export type ValidationFailResult = {
+	readonly valid: false
 	readonly errors: ValidationError[]
 }
 
+export type ValidationResult =
+	| ValidationOkResult
+	| ValidationFailResult
+
 export type ValidationError = {
 	readonly path: Path
 	readonly message: { text: string }

package/tests/cases/unit/__snapshots__/mutation.test.ts.snap

@@ -1196,3 +1196,201 @@ exports[`mutations in trx create trx 2`] = `
   "MutationTransactionOptions_0": {},
 }
 `;
+
+exports[`mutations without trx mutate or fail 1`] = `
+"mutation($MutationTransactionOptions_0: MutationTransactionOptions, $AuthorCreateInput_1: AuthorCreateInput!) {
+	mut: transaction(options: $MutationTransactionOptions_0) {
+		ok
+		errorMessage
+		errors {
+			... MutationError
+		}
+		validation {
+			... ValidationResult
+		}
+		mut: createAuthor(data: $AuthorCreateInput_1) {
+			ok
+			errorMessage
+			errors {
+				... MutationError
+			}
+			validation {
+				... ValidationResult
+			}
+		}
+	}
+}
+fragment MutationError on _MutationError {
+	paths {
+		... on _FieldPathFragment {
+			field
+		}
+		... on _IndexPathFragment {
+			index
+			alias
+		}
+	}
+	message
+	type
+}
+fragment ValidationResult on _ValidationResult {
+	valid
+	errors {
+		path {
+			... on _FieldPathFragment {
+				field
+			}
+			... on _IndexPathFragment {
+				index
+				alias
+			}
+		}
+		message {
+			text
+		}
+	}
+}
+"
+`;
+
+exports[`mutations without trx mutate or fail 2`] = `
+{
+  "AuthorCreateInput_1": {
+    "email": "xx@localhost",
+    "name": "John",
+  },
+  "MutationTransactionOptions_0": {},
+}
+`;
+
+exports[`mutations without trx mutate or fail - fail 1`] = `
+"mutation($MutationTransactionOptions_0: MutationTransactionOptions, $AuthorCreateInput_1: AuthorCreateInput!) {
+	mut: transaction(options: $MutationTransactionOptions_0) {
+		ok
+		errorMessage
+		errors {
+			... MutationError
+		}
+		validation {
+			... ValidationResult
+		}
+		mut: createAuthor(data: $AuthorCreateInput_1) {
+			ok
+			errorMessage
+			errors {
+				... MutationError
+			}
+			validation {
+				... ValidationResult
+			}
+		}
+	}
+}
+fragment MutationError on _MutationError {
+	paths {
+		... on _FieldPathFragment {
+			field
+		}
+		... on _IndexPathFragment {
+			index
+			alias
+		}
+	}
+	message
+	type
+}
+fragment ValidationResult on _ValidationResult {
+	valid
+	errors {
+		path {
+			... on _FieldPathFragment {
+				field
+			}
+			... on _IndexPathFragment {
+				index
+				alias
+			}
+		}
+		message {
+			text
+		}
+	}
+}
+"
+`;
+
+exports[`mutations without trx mutate or fail - fail 2`] = `
+{
+  "AuthorCreateInput_1": {
+    "email": "xx@localhost",
+    "name": "John",
+  },
+  "MutationTransactionOptions_0": {},
+}
+`;
+
+exports[`mutations without trx mutate or fail - ok 1`] = `
+"mutation($MutationTransactionOptions_0: MutationTransactionOptions, $AuthorCreateInput_1: AuthorCreateInput!) {
+	mut: transaction(options: $MutationTransactionOptions_0) {
+		ok
+		errorMessage
+		errors {
+			... MutationError
+		}
+		validation {
+			... ValidationResult
+		}
+		mut: createAuthor(data: $AuthorCreateInput_1) {
+			ok
+			errorMessage
+			errors {
+				... MutationError
+			}
+			validation {
+				... ValidationResult
+			}
+		}
+	}
+}
+fragment MutationError on _MutationError {
+	paths {
+		... on _FieldPathFragment {
+			field
+		}
+		... on _IndexPathFragment {
+			index
+			alias
+		}
+	}
+	message
+	type
+}
+fragment ValidationResult on _ValidationResult {
+	valid
+	errors {
+		path {
+			... on _FieldPathFragment {
+				field
+			}
+			... on _IndexPathFragment {
+				index
+				alias
+			}
+		}
+		message {
+			text
+		}
+	}
+}
+"
+`;
+
+exports[`mutations without trx mutate or fail - ok 2`] = `
+{
+  "AuthorCreateInput_1": {
+    "email": "xx@localhost",
+    "name": "John",
+  },
+  "MutationTransactionOptions_0": {},
+}
+`;

package/tests/cases/unit/__snapshots__/query.test.ts.snap

@@ -223,3 +223,13 @@ exports[`queries nested has-many-by transform 1`] = `
   },
 ]
 `;
+
+exports[`queries omit 1`] = `
+"query {
+	authors: listAuthor {
+		id
+		name
+	}
+}
+"
+`;

package/tests/cases/unit/mutation.test.ts

@@ -1,6 +1,7 @@
 import { describe, expect, test } from 'bun:test'
 import { createClient } from '../../lib'
 import { queryBuilder } from '../../client'
+import { expectTypeOf } from 'expect-type'
 
 const qb = queryBuilder
 describe('mutations in trx', () => {
@@ -518,4 +519,52 @@ describe('mutations without trx', () => {
 		expect(calls[0].variables).toMatchSnapshot()
 	})
 
+	test('mutate or fail - fail', async () => {
+		const [client, calls] = createClient({
+			mut: {
+				ok: false,
+				errorMessage: 'some error',
+				mut: {
+					ok: false,
+				},
+			},
+		})
+		const createAuthor = qb.transaction(qb.create('Author', {
+			data: {
+				name: 'John',
+				email: 'xx@localhost',
+			},
+		}))
+		expect(() => client.mutateOrThrow(createAuthor)).toThrow('some error')
+		expect(calls).toHaveLength(1)
+		expect(calls[0].query).toMatchSnapshot()
+		expect(calls[0].variables).toMatchSnapshot()
+	})
+
+
+	test('mutate or fail - ok', async () => {
+		const [client, calls] = createClient({
+			mut: {
+				ok: true,
+				errorMessage: null,
+				mut: {
+					ok: true,
+				},
+			},
+		})
+		const createAuthor = qb.transaction(qb.create('Author', {
+			data: {
+				name: 'John',
+				email: 'xx@localhost',
+			},
+		}))
+		const result = await client.mutateOrThrow(createAuthor)
+		expect(result.ok).toBe(true)
+		const ok = result.ok
+		expectTypeOf(ok).toEqualTypeOf<true>()
+
+		expect(calls).toHaveLength(1)
+		expect(calls[0].query).toMatchSnapshot()
+		expect(calls[0].variables).toMatchSnapshot()
+	})
 })

package/tests/cases/unit/query.test.ts

@@ -452,4 +452,29 @@ describe('queries', () => {
 		expect(calls).toHaveLength(1)
 	})
 
+	test('omit', async () => {
+		const [client, calls] = createClient({
+			authors: [
+				{
+					id: '1',
+					name: 'John',
+				},
+			],
+		})
+		const result = await client.query({
+			authors: qb.list('Author', {}, it => it.$$().omit('email').$('posts', {}, it => it.$$()).omit('posts')),
+		})
+		expect(result).toStrictEqual({
+			authors: [
+				{
+					id: '1',
+					name: 'John',
+				},
+			],
+		})
+		expect(calls).toHaveLength(1)
+		expect(calls[0].query).toMatchSnapshot()
+		expect(calls[0].variables).toStrictEqual({})
+	})
+
 })

package/tests/cases/unit/types.test.ts

@@ -142,4 +142,10 @@ describe('ts types', () => {
 			)
 		}).toThrow('Field Post.lorem does not exist.')
 	})
+
+	test('omit', async () => {
+		const fragment = qb.fragment('Post', it => it.$$().omit('publishedAt'))
+		type fragmentType = FragmentType<typeof fragment>
+		expectTypeOf<fragmentType>().toEqualTypeOf<{ id: string }>()
+	})
 })