json-schema-library 11.0.1 → 11.0.3

package/dist/index.d.cts

@@ -74,7 +74,7 @@ declare function toDataNodes(node: SchemaNode, data: unknown, pointer?: string,
  * could be added at the given property (e.g. item-index), thus an array of options is returned. In all other cases
  * a list with a single item will be returned
  */
-declare function getChildSelection(node: SchemaNode, property: string | number): SchemaNode[] | JsonError;
+declare function getChildSelection(node: SchemaNode, property: string | number): JsonError | SchemaNode[];
 //#endregion
 //#region src/methods/getData.d.ts
 type TemplateOptions = {
@@ -313,10 +313,26 @@ interface SchemaNode extends SchemaNodeMethodsType {
  * Fixed SchemaNode mixin methods
  */
 interface SchemaNodeMethodsType {
-  compileSchema(schema: JsonSchema, evaluationPath?: string, schemaLocation?: string, dynamicId?: string): SchemaNode;
+  compileSchema(schema: JsonSchema | BooleanSchema, evaluationPath?: string, schemaLocation?: string, dynamicId?: string): SchemaNode;
   createError<T extends string = DefaultErrors>(code: T, data: AnnotationData, message?: string): JsonError;
   createAnnotation<T extends string = DefaultErrors>(code: T, data: AnnotationData, message?: string): JsonAnnotation;
   createSchema(data?: unknown): JsonSchema;
+  /**
+   * Returns a node matching the given location (pointer) in data
+   *
+   * - the returned node will have a **reduced schema** based on given input data
+   * - return returned node $ref is resolved
+   *
+   * To resolve dynamic schema where the type of JSON Schema is evaluated by
+   * its value, a data object has to be passed in options.
+   *
+   * Per default this function will return `undefined` schema for valid properties
+   * that do not have a defined schema. Use the option `withSchemaWarning: true` to
+   * receive an error with `code: schema-warning` containing the location of its
+   * last evaluated json-schema.
+   *
+   * @returns { node } or { error } where node can also be undefined (valid but undefined)
+   */
   getNode(pointer: string, data: unknown, options: {
     withSchemaWarning: true;
   } & GetNodeOptions): NodeOrError;
@@ -324,6 +340,14 @@ interface SchemaNodeMethodsType {
     createSchema: true;
   } & GetNodeOptions): NodeOrError;
   getNode(pointer: string, data?: unknown, options?: GetNodeOptions): OptionalNodeOrError;
+  /**
+   * Returns the child for the given property-name or array-index
+   *
+   * - the returned child node is **not reduced**
+   * - a child node $ref is resolved
+   *
+   * @returns { node } or { error } where node can also be undefined (valid but undefined)
+   */
   getNodeChild(key: string | number, data: unknown, options: {
     withSchemaWarning: true;
   } & GetNodeOptions): NodeOrError;
@@ -346,7 +370,7 @@ interface SchemaNodeMethodsType {
     path?: ValidationPath;
   }) => SchemaNode;
   validate(data: unknown, pointer?: string, path?: ValidationPath): ValidateReturnType;
-  addRemoteSchema(url: string, schema: JsonSchema): SchemaNode;
+  addRemoteSchema(url: string, schema: JsonSchema | BooleanSchema): SchemaNode;
   toSchemaNodes(): SchemaNode[];
   toDataNodes(data: unknown, pointer?: string): DataNode[];
   toJSON(): unknown;
@@ -388,9 +412,12 @@ type ValidateReturnType = {
 };
 //#endregion
 //#region src/types.d.ts
+type BooleanSchema = boolean;
 interface JsonSchema {
   [keyword: string]: any;
 }
+declare function isJsonSchema(value: unknown): value is JsonSchema;
+declare function isBooleanSchema(value: unknown): value is BooleanSchema;
 type JsonPointer = string;
 type AnnotationData<D extends Record<string, unknown> = Record<string, unknown>> = D & {
   pointer: string;
@@ -446,7 +473,7 @@ type CompileOptions = {
  * wrapping each schema with utilities and as much preevaluation as possible. Each
  * node will be reused for each task, but will create a compiledNode for bound data.
  */
-declare function compileSchema(schema: JsonSchema, options?: CompileOptions): SchemaNode;
+declare function compileSchema(schema: JsonSchema | BooleanSchema, options?: CompileOptions): SchemaNode;
 //#endregion
 //#region src/settings.d.ts
 declare const _default: {
@@ -564,9 +591,9 @@ declare const draft2020: Draft;
 //#endregion
 //#region src/draftEditor.d.ts
 /**
- * @draft-editor https://json-schema.org/draft/2019-09/release-notes
+ * @draft-editor https://json-schema.org/draft/2020-12/release-notes
  *
- * Uses Draft 2019-09 and changes resolveOneOf to be fuzzy
+ * Uses Draft 2020-12 and changes resolveOneOf to be fuzzy
  */
 declare const draftEditor: Draft;
 //#endregion
@@ -607,4 +634,4 @@ declare function sanitizeErrors(list: ValidationReturnType | ValidationReturnTyp
 /** remote meta-schema stored by schema $id */
 declare const remotes: Record<string, any>;
 //#endregion
-export { type Annotation, type AnnotationData, type CompileOptions, type Context, type DataNode, type Draft, type DraftVersion, type ErrorConfig, type GetNodeOptions, type JsonAnnotation, type JsonError, type JsonPointer, type JsonSchema, type JsonSchemaReducer, type JsonSchemaReducerParams, type JsonSchemaResolver, type JsonSchemaResolverParams, type JsonSchemaValidator, type JsonSchemaValidatorParams, type Keyword, type Maybe, type NodeOrError, type OptionalNodeOrError, type SchemaNode, type ValidateReturnType, type ValidationAnnotation, type ValidationPath, type ValidationReturnType, addKeywords, compileSchema, draft04, draft06, draft07, draft2019, draft2020, draftEditor, extendDraft, getSchemaType, getTypeOf, isAnnotation, isJsonAnnotation, isJsonError, isReduceable, isSchemaNode, mergeNode, mergeSchema, oneOfFuzzyKeyword, oneOfKeyword, remotes, render, sanitizeErrors, _default as settings };
+export { type Annotation, type AnnotationData, type BooleanSchema, type CompileOptions, type Context, type DataNode, type Draft, type DraftVersion, type ErrorConfig, type GetNodeOptions, type JsonAnnotation, type JsonError, type JsonPointer, type JsonSchema, type JsonSchemaReducer, type JsonSchemaReducerParams, type JsonSchemaResolver, type JsonSchemaResolverParams, type JsonSchemaValidator, type JsonSchemaValidatorParams, type Keyword, type Maybe, type NodeOrError, type OptionalNodeOrError, type SchemaNode, type ValidateReturnType, type ValidationAnnotation, type ValidationPath, type ValidationReturnType, addKeywords, compileSchema, draft04, draft06, draft07, draft2019, draft2020, draftEditor, extendDraft, getSchemaType, getTypeOf, isAnnotation, isBooleanSchema, isJsonAnnotation, isJsonError, isJsonSchema, isReduceable, isSchemaNode, mergeNode, mergeSchema, oneOfFuzzyKeyword, oneOfKeyword, remotes, render, sanitizeErrors, _default as settings };

package/dist/index.d.mts

@@ -74,7 +74,7 @@ declare function toDataNodes(node: SchemaNode, data: unknown, pointer?: string,
  * could be added at the given property (e.g. item-index), thus an array of options is returned. In all other cases
  * a list with a single item will be returned
  */
-declare function getChildSelection(node: SchemaNode, property: string | number): SchemaNode[] | JsonError;
+declare function getChildSelection(node: SchemaNode, property: string | number): JsonError | SchemaNode[];
 //#endregion
 //#region src/methods/getData.d.ts
 type TemplateOptions = {
@@ -313,10 +313,26 @@ interface SchemaNode extends SchemaNodeMethodsType {
  * Fixed SchemaNode mixin methods
  */
 interface SchemaNodeMethodsType {
-  compileSchema(schema: JsonSchema, evaluationPath?: string, schemaLocation?: string, dynamicId?: string): SchemaNode;
+  compileSchema(schema: JsonSchema | BooleanSchema, evaluationPath?: string, schemaLocation?: string, dynamicId?: string): SchemaNode;
   createError<T extends string = DefaultErrors>(code: T, data: AnnotationData, message?: string): JsonError;
   createAnnotation<T extends string = DefaultErrors>(code: T, data: AnnotationData, message?: string): JsonAnnotation;
   createSchema(data?: unknown): JsonSchema;
+  /**
+   * Returns a node matching the given location (pointer) in data
+   *
+   * - the returned node will have a **reduced schema** based on given input data
+   * - return returned node $ref is resolved
+   *
+   * To resolve dynamic schema where the type of JSON Schema is evaluated by
+   * its value, a data object has to be passed in options.
+   *
+   * Per default this function will return `undefined` schema for valid properties
+   * that do not have a defined schema. Use the option `withSchemaWarning: true` to
+   * receive an error with `code: schema-warning` containing the location of its
+   * last evaluated json-schema.
+   *
+   * @returns { node } or { error } where node can also be undefined (valid but undefined)
+   */
   getNode(pointer: string, data: unknown, options: {
     withSchemaWarning: true;
   } & GetNodeOptions): NodeOrError;
@@ -324,6 +340,14 @@ interface SchemaNodeMethodsType {
     createSchema: true;
   } & GetNodeOptions): NodeOrError;
   getNode(pointer: string, data?: unknown, options?: GetNodeOptions): OptionalNodeOrError;
+  /**
+   * Returns the child for the given property-name or array-index
+   *
+   * - the returned child node is **not reduced**
+   * - a child node $ref is resolved
+   *
+   * @returns { node } or { error } where node can also be undefined (valid but undefined)
+   */
   getNodeChild(key: string | number, data: unknown, options: {
     withSchemaWarning: true;
   } & GetNodeOptions): NodeOrError;
@@ -346,7 +370,7 @@ interface SchemaNodeMethodsType {
     path?: ValidationPath;
   }) => SchemaNode;
   validate(data: unknown, pointer?: string, path?: ValidationPath): ValidateReturnType;
-  addRemoteSchema(url: string, schema: JsonSchema): SchemaNode;
+  addRemoteSchema(url: string, schema: JsonSchema | BooleanSchema): SchemaNode;
   toSchemaNodes(): SchemaNode[];
   toDataNodes(data: unknown, pointer?: string): DataNode[];
   toJSON(): unknown;
@@ -388,9 +412,12 @@ type ValidateReturnType = {
 };
 //#endregion
 //#region src/types.d.ts
+type BooleanSchema = boolean;
 interface JsonSchema {
   [keyword: string]: any;
 }
+declare function isJsonSchema(value: unknown): value is JsonSchema;
+declare function isBooleanSchema(value: unknown): value is BooleanSchema;
 type JsonPointer = string;
 type AnnotationData<D extends Record<string, unknown> = Record<string, unknown>> = D & {
   pointer: string;
@@ -446,7 +473,7 @@ type CompileOptions = {
  * wrapping each schema with utilities and as much preevaluation as possible. Each
  * node will be reused for each task, but will create a compiledNode for bound data.
  */
-declare function compileSchema(schema: JsonSchema, options?: CompileOptions): SchemaNode;
+declare function compileSchema(schema: JsonSchema | BooleanSchema, options?: CompileOptions): SchemaNode;
 //#endregion
 //#region src/settings.d.ts
 declare const _default: {
@@ -564,9 +591,9 @@ declare const draft2020: Draft;
 //#endregion
 //#region src/draftEditor.d.ts
 /**
- * @draft-editor https://json-schema.org/draft/2019-09/release-notes
+ * @draft-editor https://json-schema.org/draft/2020-12/release-notes
  *
- * Uses Draft 2019-09 and changes resolveOneOf to be fuzzy
+ * Uses Draft 2020-12 and changes resolveOneOf to be fuzzy
  */
 declare const draftEditor: Draft;
 //#endregion
@@ -607,4 +634,4 @@ declare function sanitizeErrors(list: ValidationReturnType | ValidationReturnTyp
 /** remote meta-schema stored by schema $id */
 declare const remotes: Record<string, any>;
 //#endregion
-export { type Annotation, type AnnotationData, type CompileOptions, type Context, type DataNode, type Draft, type DraftVersion, type ErrorConfig, type GetNodeOptions, type JsonAnnotation, type JsonError, type JsonPointer, type JsonSchema, type JsonSchemaReducer, type JsonSchemaReducerParams, type JsonSchemaResolver, type JsonSchemaResolverParams, type JsonSchemaValidator, type JsonSchemaValidatorParams, type Keyword, type Maybe, type NodeOrError, type OptionalNodeOrError, type SchemaNode, type ValidateReturnType, type ValidationAnnotation, type ValidationPath, type ValidationReturnType, addKeywords, compileSchema, draft04, draft06, draft07, draft2019, draft2020, draftEditor, extendDraft, getSchemaType, getTypeOf, isAnnotation, isJsonAnnotation, isJsonError, isReduceable, isSchemaNode, mergeNode, mergeSchema, oneOfFuzzyKeyword, oneOfKeyword, remotes, render, sanitizeErrors, _default as settings };
+export { type Annotation, type AnnotationData, type BooleanSchema, type CompileOptions, type Context, type DataNode, type Draft, type DraftVersion, type ErrorConfig, type GetNodeOptions, type JsonAnnotation, type JsonError, type JsonPointer, type JsonSchema, type JsonSchemaReducer, type JsonSchemaReducerParams, type JsonSchemaResolver, type JsonSchemaResolverParams, type JsonSchemaValidator, type JsonSchemaValidatorParams, type Keyword, type Maybe, type NodeOrError, type OptionalNodeOrError, type SchemaNode, type ValidateReturnType, type ValidationAnnotation, type ValidationPath, type ValidationReturnType, addKeywords, compileSchema, draft04, draft06, draft07, draft2019, draft2020, draftEditor, extendDraft, getSchemaType, getTypeOf, isAnnotation, isBooleanSchema, isJsonAnnotation, isJsonError, isJsonSchema, isReduceable, isSchemaNode, mergeNode, mergeSchema, oneOfFuzzyKeyword, oneOfKeyword, remotes, render, sanitizeErrors, _default as settings };