Feature: Allow schema to be free-form #80

package.json

@@ -48,7 +48,7 @@
 		"debounce-fn": "^4.0.0",
 		"dot-prop": "^6.0.1",
 		"env-paths": "^2.2.1",
-		"json-schema-typed": "^7.0.3",
+		"json-schema-typed": "^8.0.0",
 		"onetime": "^5.1.2",
 		"pkg-up": "^3.1.0",
 		"semver": "^7.3.5"

source/index.ts

@@ -14,7 +14,17 @@ import debounceFn = require('debounce-fn');
 import semver = require('semver');
 import onetime = require('onetime');
 import {JSONSchema} from 'json-schema-typed';
-import {Deserialize, Migrations, OnDidChangeCallback, Options, Serialize, Unsubscribe, Schema, OnDidAnyChangeCallback} from './types';
+import {
+	Deserialize,
+	Migrations,
+	OnDidChangeCallback,
+	Options,
+	Serialize,
+	Unsubscribe,
+	Schema,
+	OnDidAnyChangeCallback,
+	ObjectSchema
+} from './types';
 
 const encryptionAlgorithm = 'aes-256-cbc';
 
@@ -49,6 +59,10 @@ const checkValueType = (key: string, value: unknown): void => {
 	}
 };
 
+const isObjectJSONSchema = <T>(schema: Schema<T>): schema is ObjectSchema => {
+	return typeof schema === 'object' && 'type' in schema && schema.type === 'object';
+};
+
 const INTERNAL_KEY = '__internal__';
 const MIGRATION_KEY = `${INTERNAL_KEY}.migrations.version`;
 
@@ -105,15 +119,15 @@ class Conf<T extends Record<string, any> = Record<string, unknown>> implements I
 			});
 			ajvFormats(ajv);
 
-			const schema: JSONSchema = {
+			const schema: JSONSchema = isObjectJSONSchema(options.schema) ? options.schema : {
 				type: 'object',
 				properties: options.schema
 			};
 
 			this.#validator = ajv.compile(schema);
 
-			for (const [key, value] of Object.entries<JSONSchema>(options.schema)) {
-				if (value?.default) {
+			for (const [key, value] of Object.entries<JSONSchema>(schema.properties!)) {
+				if (value && typeof value === 'object' && value.default) {
 					this.#defaultValues[key as keyof T] = value.default;
 				}
 			}

source/types.ts

@@ -227,8 +227,9 @@ export interface Options<T> {
 
 export type Migrations<T> = Record<string, (store: Conf<T>) => void>;
 
-export type Schema<T> = {[Property in keyof T]: ValueSchema};
-export type ValueSchema = TypedJSONSchema;
+export type Schema<T> = ObjectSchema | {[Property in keyof T]: ValueSchema<T[Property]>};
+export type ObjectSchema = TypedJSONSchema<Record<string | number, unknown>>;
+export type ValueSchema<T> = TypedJSONSchema<T>;
 
 export type Serialize<T> = (value: T) => string;
 export type Deserialize<T> = (text: string) => T;

test/index.ts

@@ -702,6 +702,30 @@ test('schema - valid set', t => {
 	});
 });
 
+test('schema - valid set with full schema', t => {
+	const schema: Schema<{foo: {bar: number; foobar: number}}> = {
+		type: 'object',
+		properties: {
+			foo: {
+				type: 'object',
+				properties: {
+					bar: {
+						type: 'number'
+					},
+					foobar: {
+						type: 'number',
+						maximum: 100
+					}
+				}
+			}
+		}
+	};
+	const config = new Conf({cwd: tempy.directory(), schema});
+	t.notThrows(() => {
+		config.set('foo', {bar: 1, foobar: 2});
+	});
+});
+
 test('schema - one violation', t => {
 	const config = new Conf({
 		cwd: tempy.directory(),
@@ -835,11 +859,11 @@ test('schema - validate Conf default', t => {
 		new Conf({
 			cwd: tempy.directory(),
 			defaults: {
-				// For our tests to fail and typescript to compile, we'll ignore this ts error.
-				// This error is not bad and means the package is well typed.
-				// @ts-expect-error
 				foo: 1
 			},
+			// For our tests to fail and typescript to compile, we'll ignore this ts error.
+			// This error is not bad and means the package is well typed.
+			// @ts-expect-error
 			schema
 		});
 	}, {message: 'Config schema violation: `foo` must be string'});