@versionzero/schema 1.0.0

package/types/value-processor/value-processor.d.ts

@@ -0,0 +1,92 @@
+/**
+ * @callback ValueProcessorFunction
+ * @param {any} value - The input value to be processed
+ * @param {any} target - The top-level target object or value which is being built, if known (do not mutate)
+ * @param {SchemaLocation} location - The path and schema of the value being processed within the schema hierarchy
+ * @param {object} options - Options passed to the handler containing this value processor
+ * @returns {any|Promise<any>} - Direct output value or a deferred promise if the value processor is asynchronous
+ */
+/** @typedef {`$${string}`} ValueProcessorKeyword */
+/** @typedef {ValueProcessorKeyword|{[keyword:ValueProcessorKeyword]:ValueProcessorSpec}} KeywordValueProcessorSpec */
+/** @typedef {ValueProcessorDefinition|ValueProcessorFunction|KeywordValueProcessorSpec|object|null|string|number|RegExp} ValueProcessorSpec */
+/** @typedef {ValueProcessor[]|{[param:string]:ValueProcessor}} ValueProcessorArgs */
+/**
+ * @callback ValueProcessorBuilder
+ * @param {ValueProcessorArgs} args
+ * @param {object} [options]
+ * @returns {ValueProcessor}
+ */
+/**
+ * @typedef {object} ValueProcessorParameter
+ * @property {string} parameter
+ * @property {any} [default]
+ * @property {string} [type]
+ * @property {boolean} [required]
+ */
+/**
+ * @callback ValueProcessorDescriber
+ * @param {{[param:string]:ValueProcessor}|ValueProcessor[]|undefined} args
+ * @returns {string|undefined}
+ */
+/**
+ * @typedef {object} ValueProcessorDefinition
+ * @property {string} keyword
+ * @property {ValueProcessorFunction} [process]
+ * @property {ValueProcessorParameter[]} [parameters]
+ * @property {string} [description]
+ * @property {ValueProcessorBuilder} [build]
+ * @property {ValueProcessorDescriber} [describe]
+ */
+/**
+ * @augments {Executor<any>}
+ */
+export class ValueProcessor extends Executor<any> {
+    /**
+     * @param {any} [spec]
+     * @param {string} [description]
+     */
+    constructor(spec?: any, description?: string);
+    set description(description: string | undefined);
+    get description(): string | undefined;
+    set spec(spec: any);
+    get spec(): any;
+    /**
+     *
+     * @param {any} value
+     * @param {any} target
+     * @param {SchemaLocation} location
+     * @param {object} options
+     * @returns {any|Promise<any>}
+     */
+    execute(value: any, target: any, location: SchemaLocation, options: object): any | Promise<any>;
+    #private;
+}
+export type ValueProcessorFunction = (value: any, target: any, location: SchemaLocation, options: object) => any | Promise<any>;
+export type ValueProcessorKeyword = `$${string}`;
+export type KeywordValueProcessorSpec = ValueProcessorKeyword | {
+    [keyword: ValueProcessorKeyword]: ValueProcessorSpec;
+};
+export type ValueProcessorSpec = ValueProcessorDefinition | ValueProcessorFunction | KeywordValueProcessorSpec | object | null | string | number | RegExp;
+export type ValueProcessorArgs = ValueProcessor[] | {
+    [param: string]: ValueProcessor;
+};
+export type ValueProcessorBuilder = (args: ValueProcessorArgs, options?: object) => ValueProcessor;
+export type ValueProcessorParameter = {
+    parameter: string;
+    default?: any;
+    type?: string | undefined;
+    required?: boolean | undefined;
+};
+export type ValueProcessorDescriber = (args: {
+    [param: string]: ValueProcessor;
+} | ValueProcessor[] | undefined) => string | undefined;
+export type ValueProcessorDefinition = {
+    keyword: string;
+    process?: ValueProcessorFunction | undefined;
+    parameters?: ValueProcessorParameter[] | undefined;
+    description?: string | undefined;
+    build?: ValueProcessorBuilder | undefined;
+    describe?: ValueProcessorDescriber | undefined;
+};
+import { Executor } from '../executor/executor.js';
+import { SchemaLocation } from '../schema-location.js';