refactor!: renamed validateSchema to buildSchema

BREAKING CHANGE: the function validateSchema is now buildSchema

src/index.ts

@@ -1,4 +1,4 @@
-export { validateSchema, withIndex, InvalidSchemaError } from './indexedKeysSchema'
+export { buildSchema, withIndex, InvalidSchemaError } from './indexedKeysSchema'
 export { get, set } from "./raw";
 export { toPlainObject, toIndexedKeysMessage } from "./convenient";
 

src/indexedKeysSchema.ts

@@ -38,7 +38,7 @@ export type ValidIndexedKeysMessageSchema<TSchema> = {
   [K in keyof TSchema]: TSchema[K] extends ValidSchemaLeaf<infer TField>
       ? ValidSchemaLeaf<TField>
       : TSchema[K] extends SchemaLeaf<unknown> 
-          ? Invalid<"Schema needs to be validated before you use it, did you forget to call validateSchema()?">
+          ? Invalid<"Schema needs to be built before you use it, did you forget to call buildSchema()?">
           : ToValidIndexedKeysMessageSchema<TSchema[K]>;
 };
 
@@ -54,7 +54,7 @@ export class InvalidSchemaError extends Error {
   }
 }
 
-export function validateSchema<TSchema extends IndexedKeysMessageSchema<TSchemaInner>, TSchemaInner>(schema: TSchema) {
+export function buildSchema<TSchema extends IndexedKeysMessageSchema<TSchemaInner>, TSchemaInner>(schema: TSchema) {
   validateSchemaRecursively(schema, schema, [], 0);
   return schema as unknown as ToValidIndexedKeysMessageSchema<TSchema>;
 }

test/indexedKeysSchema.test.ts

@@ -5,7 +5,7 @@ import {
   set,
   toPlainObject,
   toIndexedKeysMessage,
-  validateSchema, 
+  buildSchema, 
   InvalidSchemaError
 } from "../src/index";
 
@@ -222,18 +222,18 @@ describe("toIndexedKeysMessage", () => {
   });
 });
 
-describe("validateSchema", () => {
-  it("shouldn't throw if schema is correct", () => {
+describe("buildSchema", () => {
+  it("shouldn't throw if schema is valid", () => {
     createTestSchema();
   });
 
   it("should throw if there are duplicate indexes-paths in the schema", () => {
-    expect(() => validateSchema({
+    expect(() => buildSchema({
       someField: i(0)<number>(),
       anotherFieldWithSameIndex: i(0)<number>(),
     })).toThrowError(new InvalidSchemaError());
 
-    expect(() => validateSchema({
+    expect(() => buildSchema({
       nestedThing: i(0)({
         someNestedField: i(0)<string>()
       }),
@@ -261,7 +261,7 @@ describe("validateSchema", () => {
       someBool: i(3)<boolean>()
     };
 
-    expect(() => validateSchema(schema))
+    expect(() => buildSchema(schema))
         .toThrowError(new InvalidSchemaError());
 
     const schema2 = {
@@ -281,7 +281,7 @@ describe("validateSchema", () => {
       someBool: i(3)<boolean>()
     };
 
-    expect(() => validateSchema(schema2))
+    expect(() => buildSchema(schema2))
         .toThrowError(new InvalidSchemaError());
   });
 })
@@ -305,5 +305,5 @@ export function createTestSchema() {
     someBool: i(3)<boolean>()
   };
 
-  return validateSchema(schema);
+  return buildSchema(schema);
 }