@elle96/ng-json-schema-manager 0.2.1 → 0.3.0

package/index.d.ts

@@ -132,6 +132,56 @@ declare class JsonSchemaStylesService {
     static ɵprov: i0.ɵɵInjectableDeclaration<JsonSchemaStylesService>;
 }
 
+/**
+ * Texts shown by the form. Every value can be overridden through the `labels` input of `jsm-json-schema-form`
+ * (e.g. to translate them); omitted keys keep the English default.
+ * `{n}` and `{name}` placeholders are replaced with the item number / field name.
+ */
+interface JsonSchemaFormLabels {
+    /** Title used when the schema has none. */
+    formTitle: string;
+    resolving: string;
+    schemaErrorsTitle: string;
+    schemaErrorsHint: string;
+    addItem: string;
+    /** Hidden name of an array item, announced by screen readers ("Item {n}"). */
+    arrayItem: string;
+    remove: string;
+    add: string;
+    addProperty: string;
+    propertyName: string;
+    noItems: string;
+    mustContain: string;
+    min: string;
+    max: string;
+    /** "Option {n}" for oneOf/anyOf entries without a title. */
+    option: string;
+    /** "Section {n}" for allOf entries without a title. */
+    section: string;
+    example: string;
+    propertyNameRequired: string;
+    propertyNameInvalid: string;
+    propertyExists: string;
+    propertyNotAllowed: string;
+    errorRequired: string;
+    errorMinLength: string;
+    errorMaxLength: string;
+    errorMin: string;
+    errorMax: string;
+    errorEmail: string;
+    errorPattern: string;
+    errorInteger: string;
+    errorExclusiveMin: string;
+    errorExclusiveMax: string;
+    errorMultipleOf: string;
+    errorMinItems: string;
+    errorMaxItems: string;
+    errorUniqueItems: string;
+}
+declare const DEFAULT_LABELS: JsonSchemaFormLabels;
+/** Replaces `{key}` placeholders in a label template. */
+declare function formatLabel(template: string, values?: Record<string, string | number>): string;
+
 /** Character shown between the integer and decimal part of a number. */
 type DecimalSeparator = '.' | ',';
 /**
@@ -139,6 +189,7 @@ type DecimalSeparator = '.' | ',';
  */
 declare class JsonSchemaFormOptions {
     decimalSeparator: DecimalSeparator;
+    labels: JsonSchemaFormLabels;
     static ɵfac: i0.ɵɵFactoryDeclaration<JsonSchemaFormOptions, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<JsonSchemaFormOptions>;
 }
@@ -183,7 +234,7 @@ declare class JsonSchemaFormComponent implements OnChanges, OnDestroy {
     private readonly resolver;
     private readonly validation;
     private readonly cdr;
-    private readonly options;
+    protected readonly options: JsonSchemaFormOptions;
     schema: JsonSchema;
     value?: unknown;
     data?: unknown;
@@ -193,6 +244,8 @@ declare class JsonSchemaFormComponent implements OnChanges, OnDestroy {
      * either way); the emitted value is always a JSON number.
      */
     decimalSeparator: DecimalSeparator;
+    /** Texts shown by the form (translate them here); omitted keys keep the English default. */
+    labels: Partial<JsonSchemaFormLabels>;
     formReady: EventEmitter<FormGroup<any>>;
     valueChange: EventEmitter<unknown>;
     schemaReady: EventEmitter<JsonSchema>;
@@ -222,7 +275,7 @@ declare class JsonSchemaFormComponent implements OnChanges, OnDestroy {
     onRootReplaced(control: AbstractControl): void;
     private attachValueSub;
     static ɵfac: i0.ɵɵFactoryDeclaration<JsonSchemaFormComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<JsonSchemaFormComponent, "jsm-json-schema-form", never, { "schema": { "alias": "schema"; "required": true; }; "value": { "alias": "value"; "required": false; }; "data": { "alias": "data"; "required": false; }; "allowAdditionalProperties": { "alias": "allowAdditionalProperties"; "required": false; }; "decimalSeparator": { "alias": "decimalSeparator"; "required": false; }; }, { "formReady": "formReady"; "valueChange": "valueChange"; "schemaReady": "schemaReady"; "schemaErrors": "schemaErrors"; }, never, never, true, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<JsonSchemaFormComponent, "jsm-json-schema-form", never, { "schema": { "alias": "schema"; "required": true; }; "value": { "alias": "value"; "required": false; }; "data": { "alias": "data"; "required": false; }; "allowAdditionalProperties": { "alias": "allowAdditionalProperties"; "required": false; }; "decimalSeparator": { "alias": "decimalSeparator"; "required": false; }; "labels": { "alias": "labels"; "required": false; }; }, { "formReady": "formReady"; "valueChange": "valueChange"; "schemaReady": "schemaReady"; "schemaErrors": "schemaErrors"; }, never, never, true, never>;
 }
 
 declare class JsonSchemaNodeComponent implements OnInit, OnDestroy {
@@ -248,6 +301,8 @@ declare class JsonSchemaNodeComponent implements OnInit, OnDestroy {
     propertyError: string;
     /** Tracks whether this primitive control has been touched (for OnPush CD). */
     isTouched: boolean;
+    /** Unique DOM id base of this node: links labels, hints and errors to the control (WCAG 1.3.1, 4.1.2). */
+    readonly nodeId: string;
     private valueSub?;
     constructor(schemaService: JsonSchemaFormService, validation: JsonSchemaValidationService, cdr: ChangeDetectorRef, options: JsonSchemaFormOptions | null);
     ngOnInit(): void;
@@ -259,6 +314,21 @@ declare class JsonSchemaNodeComponent implements OnInit, OnDestroy {
     get nodeKind(): 'oneOf' | 'anyOf' | 'allOf' | 'object' | 'array' | 'primitive';
     get resolvedType(): JsonSchema['type'] | 'enum';
     get decimalSeparator(): DecimalSeparator;
+    /** Texts shown by the form (see `labels` of `jsm-json-schema-form`). */
+    get l(): JsonSchemaFormLabels;
+    fmt(template: string, values?: Record<string, string | number>): string;
+    localize(message: string): string;
+    optionLabel(index: number): string;
+    sectionLabel(index: number): string;
+    /** DOM id of a dynamic key label (keys may contain characters that are not valid in ids). */
+    keyId(key: string): string;
+    /** True when the error list of this primitive is shown (same gate as the error styling). */
+    get visibleError(): boolean;
+    /** Ids of the hint, example, media type and error texts that describe this control. */
+    get describedBy(): string | null;
+    selectOneOf(index: number): void;
+    /** WAI-ARIA tabs keyboard support: arrows, Home and End move between the oneOf options. */
+    onOneOfKeydown(event: KeyboardEvent): void;
     /** `multipleOf` of this node's own schema, exposed as step metadata. */
     get numericStep(): string;
     get inputKind(): 'text' | 'number' | 'textarea' | 'select' | 'checkbox';
@@ -276,6 +346,10 @@ declare class JsonSchemaNodeComponent implements OnInit, OnDestroy {
     get allErrors(): string[];
     get metaBadges(): string[];
     get activeVariant(): JsonSchema | null;
+    /**
+     * Sections rendered for an allOf: the schema's own keywords (without the allOf itself, which would render
+     * this node again forever) when it declares any, followed by every allOf entry.
+     */
     get mergedAllOf(): JsonSchema[];
     isRequired(key: string): boolean;
     schemaForKey(key: string): JsonSchema;
@@ -316,5 +390,5 @@ declare class JsonSchemaFormModule {
  */
 declare function normalizeValue(schema: JsonSchema, value: unknown): unknown;
 
-export { JsonSchemaFormComponent, JsonSchemaFormModule, JsonSchemaFormOptions, JsonSchemaFormService, JsonSchemaNodeComponent, JsonSchemaResolverService, JsonSchemaStylesService, JsonSchemaValidationService, NumericInputDirective, formatNumeric, localizeNumbers, normalizeValue, parseNumericText, sanitizeNumericText };
-export type { DecimalSeparator, JsonSchema, JsonSchemaArray, JsonSchemaBase, JsonSchemaCombinators, JsonSchemaDraft, JsonSchemaObject, JsonSchemaPrimitive, JsonSchemaType, SchemaError, SchemaFieldContext };
+export { DEFAULT_LABELS, JsonSchemaFormComponent, JsonSchemaFormModule, JsonSchemaFormOptions, JsonSchemaFormService, JsonSchemaNodeComponent, JsonSchemaResolverService, JsonSchemaStylesService, JsonSchemaValidationService, NumericInputDirective, formatLabel, formatNumeric, localizeNumbers, normalizeValue, parseNumericText, sanitizeNumericText };
+export type { DecimalSeparator, JsonSchema, JsonSchemaArray, JsonSchemaBase, JsonSchemaCombinators, JsonSchemaDraft, JsonSchemaFormLabels, JsonSchemaObject, JsonSchemaPrimitive, JsonSchemaType, SchemaError, SchemaFieldContext };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elle96/ng-json-schema-manager",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Angular JSON Schema form renderer with Tailwind styling, external $ref support, and reactive forms.",
   "homepage": "https://luigiellebalotta.github.io/json-schema-manager/",
   "repository": {