@jkcfg/std/schema.js

jk standard library

/**
 * @module std/schema
 */
import { RPC, RPCSync } from './internal/rpc';
import { valueFromUTF8Bytes } from './internal/data';
function decodeResponse(bytes) {
    const results = valueFromUTF8Bytes(bytes);
    if (results === null) {
        return 'ok';
    }
    if (Array.isArray(results)) {
        return results;
    }
    throw new Error(`unexpected return value from RPC: ${results}`);
}
/**
 * validateWithObject validates a value using a JSON schema supplied
 * as object.
 *
 * ```typescript
 * const result = validateWithObject(5, { type: 'number' });
 * ```
 */
export function validateWithObject(obj, schema) {
    return decodeResponse(RPCSync('std.validate.schema', JSON.stringify(obj), JSON.stringify(schema)));
}
/**
 * validateWithFile validates a value using a schema located at
 * the path (relative to the input directory).
 */
export function validateWithFile(obj, path) {
    return RPC('std.validate.schemafile', JSON.stringify(obj), path, '').then(decodeResponse);
}
/**
 * validateWithResource validates a value using a schema location at
 * the given path relative to the module represented by `moduleRef`;
 * this is intended to be used by wrapping it in
 * `@jkcfg/std/resource#withModuleRef`.
 *
 * ```javascript
 * import { withModuleRef } from '@jkcfg/std/resource';
 *
 * export function validate(value) {
 *   return withModuleRef(ref => validateWithSchema(value, 'schema.json', ref));
 * }
 * ```
 */
export function validateWithResource(obj, path, moduleRef) {
    return RPC('std.validate.schemafile', JSON.stringify(obj), path, moduleRef).then(decodeResponse);
}