Added fromValibot to Result (#15363)

Allows us to convert Valibot's result into our internal `Result` type,
for ease of use with other code.

Co-authored-by: James M <1166188+jamesmockett@users.noreply.github.com>
Co-authored-by: Marjan K <15894063+marjisound@users.noreply.github.com>

Author: 3 people

dotcom-rendering/src/lib/result.test.ts

@@ -1,4 +1,5 @@
-import { error, ok, type Result } from './result';
+import { literal, safeParse } from 'valibot';
+import { error, fromValibot, ok, type Result } from './result';
 
 describe('ok', () => {
 	it('creates an instance of Ok', () => {
@@ -160,3 +161,26 @@ describe('getErrorOrThrow', () => {
 		);
 	});
 });
+
+describe('fromValibot', () => {
+	const schema = literal('string literal');
+
+	it('creates an Ok from a successful parse result', () => {
+		const valibotResult = safeParse(schema, 'string literal');
+
+		const result = fromValibot(valibotResult);
+		const value = result.getOrThrow('Expected an Ok');
+
+		expect(value).toBe('string literal');
+	});
+
+	it('creates an Err from an unsuccessful parse result', () => {
+		const valibotResult = safeParse(schema, 'invalid literal');
+
+		const result = fromValibot(valibotResult);
+		const err = result.getErrorOrThrow('Expected an Err');
+
+		expect(err[0].reason).toBe('type');
+		expect(err[0].context).toBe('literal');
+	});
+});

dotcom-rendering/src/lib/result.ts

@@ -1,3 +1,11 @@
+import type {
+	BaseSchema,
+	BaseSchemaAsync,
+	Output,
+	SafeParseResult,
+	SchemaIssues,
+} from 'valibot';
+
 /**
  * Represents a value or an error; it's either a {@linkcode Ok} or an
  * {@linkcode Err}. Can be constructed with {@linkcode ok} or {@linkcode error}.
@@ -168,4 +176,16 @@ const ok = <E, A>(value: A): Result<E, A> => new Ok(value);
  */
 const error = <E, A>(err: E): Result<E, A> => new Err(err);
 
+/**
+ * Constructs an instance of a {@linkcode Result} from a Valibot
+ * {@linkcode SafeParseResult}, i.e. the output from Valibot `safeParse`.
+ * @example
+ * const valibotResult = safeParse(schema, input);
+ * const result = fromValibot(valibotResult);
+ */
+export const fromValibot = <Schema extends BaseSchema | BaseSchemaAsync>(
+	result: SafeParseResult<Schema>,
+): Result<SchemaIssues, Output<Schema>> =>
+	result.success ? ok(result.output) : error(result.issues);
+
 export { Result, ok, error };