@datadayrepos/json-schema-types 0.0.1-beta.12

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Ivar Strand
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+# JSON SCHEMA TYPES
+
+Support library for json-schema types used across libraries.
+
+## 1. Install
+Clone this template and navigate to the project directory. Use `pnpm` for installing dependencies:
+
+```sh
+pnpm install @datadayrepos/json-schema-types -D
+```
+
+## 2. Content
+Exports the following:
+```ts
+export type {
+  ExtendedJson7,
+  JSONSchema7TypeName,
+  JSONSchema7Type,
+  JSONSchema7Object,
+  JSONSchema7Array,
+  JSONSchema7Version,
+  JSONSchema7Definition,
+  JSONSchema7
+
+} from './jsonSchema'
+
+export type {
+  GenericObjectType,
+  ABYSchema,
+  ABYAllSchemaPackage,
+  ABYSchemaDefinition,
+  ABYSchemaTypeName,
+  ABYSchemaType,
+  FieldsMap,
+  UISpec,
+  WidgetNames,
+  UISchema,
+  UISchemaDetail,
+  ErrSchema
+
+} from './internalScema'
+```
+
+
+## 📄 License
+[MIT](./LICENSE) License © 2023 [Ivar Strand](https://github.com/datadayrepos)

package/dist/fieldProps.d.ts

@@ -0,0 +1,20 @@
+export type FieldProps = {
+    /** Current node schema */
+    schema: object;
+    /** Current node uiSchema */
+    uiSchema: object;
+    /** Current node errorSchema */
+    errorSchema: object;
+    /** Custom verification rules */
+    customFormats: object;
+    /** Root node schema */
+    rootSchema: object;
+    /** Root node formData */
+    rootFormData: object;
+    /** Current node path */
+    curNodePath: string;
+    /** Is it required */
+    required: boolean;
+    /** Do you need to verify the data group */
+    needValidFieldGroup: boolean;
+};

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export type { ExtendedJson7, JSONSchema7TypeName, JSONSchema7Type, JSONSchema7Object, JSONSchema7Array, JSONSchema7Version, JSONSchema7Definition, JSONSchema7, } from './jsonSchema';
+export type { GenericObjectType, ABYSchema, ABYAllSchemaPackage, ABYSchemaDefinition, ABYSchemaTypeName, ABYSchemaType, FieldsMap, UISpec, WidgetNames, UISchema, UISchemaDetail, ErrSchema, } from './internalScema';

package/dist/internalScema.d.ts

@@ -0,0 +1,189 @@
+/** ivar.strand 220831 - used as wrappers around json schema and for certain custom props*/
+import type { ExtendedJson7, JSONSchema7Definition, JSONSchema7Type, JSONSchema7TypeName } from './jsonSchema';
+import type { FieldProps } from './fieldProps';
+/**
+ * The representation of any generic object type, usually used as an intersection on other types to make them more
+ * flexible in the properties they support (i.e. anything else)
+ */
+export type GenericObjectType = {
+    [name: string]: any;
+};
+/**
+ * Map the JSONSchema7 to our own type so that we can easily bump to JSONSchema8 at some future date and only have to
+ * update this one type.
+ */
+export type ABYSchema = ExtendedJson7;
+/** Wrapper for all schema package */
+export type ABYAllSchemaPackage = {
+    schema?: ABYSchema;
+    formFooter?: FormFooter;
+    formProps?: FormProps;
+    formMeta?: FormMeta;
+    uiSchema?: UISchema;
+    errorSchema?: UISchema;
+    customFormats?: object;
+    formData?: object;
+};
+/**
+ * Map the JSONSchema7Definition to our own type so that we can easily bump to JSONSchema8Definition at some future
+ * date and only have to update this one type.
+ */
+export type ABYSchemaDefinition = JSONSchema7Definition;
+export type ABYSchemaTypeName = JSONSchema7TypeName;
+export type ABYSchemaType = JSONSchema7Type;
+export type FieldsMap = {
+    array: FieldsMapItem;
+    boolean: FieldsMapItem;
+    integer: FieldsMapItem;
+    number: FieldsMapItem;
+    object: FieldsMapItem;
+    string: FieldsMapItem;
+    null: object;
+    anyOf: FieldsMapItem;
+    oneOf: FieldsMapItem;
+    allOf: FieldsMapItem;
+};
+export type FieldsMapItem = {
+    name: string;
+    props?: FieldProps;
+    setup?: (props: any, context: any) => any;
+};
+export type UISpec = {
+    readonly?: ABYSchema['readOnly'];
+    step?: ABYSchema['multipleOf'];
+    min?: ABYSchema['minimum'];
+    max?: ABYSchema['maximum'];
+    minlength?: ABYSchema['minLength'];
+    maxlength?: ABYSchema['maxLength'];
+    title?: ABYSchema['title'];
+    description?: ABYSchema['description'];
+    isRange?: boolean;
+    isNumberValue?: boolean;
+    schemaType?: ABYSchema['type'];
+};
+/**
+ * An `ErrorTransformer` function will take in a list of `errors` and potentially return a transformation of those
+ * errors in what ever way it deems necessary
+ */
+export type ErrorTransformer = (errors: RJSFValidationError[]) => RJSFValidationError[];
+/** The type that describes the data that is returned from the `ValidatorType.validateFormData()` function */
+export type ValidationData<T> = {
+    /** The validation errors as a list of `RJSFValidationError` objects */
+    errors: RJSFValidationError[];
+    /** The validation errors in the form of an `ErrorSchema` */
+    errorSchema: ErrorSchema<T>;
+};
+/** The type for error produced by RJSF schema validation */
+export type RJSFValidationError = {
+    /** Name of the error, for example, "required" or "minLength" */
+    name?: string;
+    /** Message, for example, "is a required property" or "should NOT be shorter than 3 characters" */
+    message?: string;
+    /**
+     * An object with the error params returned by ajv
+     * ([see doc](https://github.com/ajv-validator/ajv/tree/6a671057ea6aae690b5967ee26a0ddf8452c6297#error-parameters)
+     * for more info)
+     */
+    params?: any;
+    /**
+     * A string in Javascript property accessor notation to the data path of the field with the error. For example,
+     * `.name` or `['first-name']`
+     */
+    property?: string;
+    /**
+     * JSON pointer to the schema of the keyword that failed validation. For example, `#/fields/firstName/required`.
+     * (Note: this may sometimes be wrong due to a [bug in ajv](https://github.com/ajv-validator/ajv/issues/512))
+     */
+    schemaPath?: string;
+    /** Full error name, for example ".name is a required property" */
+    stack: string;
+};
+/** Type describing a recursive structure of `FieldErrors`s for an object with a non-empty set of keys */
+export type ErrorSchema<T = any> = FieldErrors & {
+    [key in keyof T]?: ErrorSchema<T[key]>;
+};
+/** The type that describes an error in a field */
+export type FieldError = string;
+/** The type that describes the list of errors for a field */
+export type FieldErrors = {
+    /** The list of errors for the field */
+    __errors?: FieldError[];
+};
+export type WidgetNames = 'CameraWidget' | 'AbyQrModule' | 'CheckboxWidget' | 'CheckboxesWidget' | 'DateWidget' | 'GeoWidget' | 'HiddenWidget' | 'RadioWidget' | 'SelectWidget' | 'SliderWidget' | 'SwitchWidget' | 'SwitchMiniWidget' | 'TagWidget' | 'TimeWidget' | 'UploadWidget' | 'hidden';
+export type UISchema = {
+    [key: string]: UISchemaDetail;
+};
+export type UISchemaDetail = {
+    'ui:options'?: {
+        [uiOption: string]: any;
+    };
+    'ui:description'?: string;
+    'ui:enumNames'?: string[];
+    'ui:field'?: string;
+    'ui:hidden'?: string | boolean;
+    'ui:show'?: string | boolean;
+    'ui:title'?: string;
+    'ui:widget'?: WidgetNames;
+    'ui:disabled'?: string;
+    'ui:order'?: string[];
+    'ui:placeholder'?: string;
+    [uiProp: string]: any;
+};
+export type ErrSchema = {
+    [key: string]: ErrSchemaDetail;
+};
+export type ErrSchemaDetail = {
+    'err:options'?: {
+        [errOption: string]: any;
+    };
+    'err:required'?: boolean;
+    'err:unique'?: string;
+    [errProp: string]: any;
+};
+/** ********************** FormConfig */
+export type FormConfig = {
+    formProps: FormProps;
+    formMeta: FormMeta;
+    formFooter: FormFooter;
+};
+export type FormFooter = {
+    cancelBtn?: string;
+    okBtn?: string;
+    show?: boolean;
+};
+export type FormMeta = {
+    $id?: string;
+    $schema?: string;
+    $$formtags?: string;
+};
+export type FormProps = {
+    title?: string;
+    description?: string;
+    backLbl?: string;
+    fwdLbl?: string;
+    inline?: boolean;
+    inlineFooter?: boolean;
+    isMiniDes?: boolean;
+    labelPosition?: 'left' | 'right' | 'top';
+    labelSuffix?: string;
+    labelWidth?: number | string;
+    layoutColumn?: number;
+    layoutSingleton?: boolean;
+};
+/** ********************** Main form emits */
+export type FormChange = {
+    newValue: any;
+    oldValue: any;
+};
+/**
+ * @items curVal - current value
+ * @items parentFormData - current value of parent form
+ * @items preVal - current value
+ * @items rootFormData - current value of root form, all data at root
+ */
+export type WidgetChange = {
+    curVal: any;
+    parentFormData: any;
+    preVal: any;
+    rootFormData: any;
+};

package/dist/jsonSchema.d.ts

@@ -0,0 +1,147 @@
+import type { ErrSchemaDetail, UISchemaDetail } from './internalScema';
+/** Json schema with extended ui types */
+export type ExtendedJson7 = {
+    enumNames?: string[];
+    _collapser?: ExtendedJson7;
+    $$itemRef?: string;
+    $$itemId?: string;
+    $$isSingle?: boolean;
+    $$isActive?: boolean;
+    $$isParent?: boolean;
+    $$notUniqueProperty?: boolean;
+} & UISchemaDetail & ErrSchemaDetail & JSONSchema7;
+/**
+ * Primitive type
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
+ */
+export type JSONSchema7TypeName = 'string' | 'number' | 'integer' | 'boolean' | 'object' | 'array' | 'null';
+/**
+ * Primitive type
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1.1
+ */
+export type JSONSchema7Type = string | number | boolean | JSONSchema7Object | JSONSchema7Array | null;
+export type JSONSchema7Object = {
+    [key: string]: JSONSchema7Type;
+};
+export type JSONSchema7Array = Array<JSONSchema7Type>;
+/**
+ * Meta schema
+ *
+ * Recommended values:
+ * - 'http://json-schema.org/schema#'
+ * - 'http://json-schema.org/hyper-schema#'
+ * - 'http://json-schema.org/draft-07/schema#'
+ * - 'http://json-schema.org/draft-07/hyper-schema#'
+ *
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-5
+ */
+export type JSONSchema7Version = string;
+/**
+ * JSON Schema v7 recursive
+ * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01
+ */
+export type JSONSchema7Definition = ExtendedJson7 | boolean;
+export type JSONSchema7 = {
+    $id?: string | undefined;
+    $ref?: string | undefined;
+    $schema?: JSONSchema7Version | undefined;
+    $comment?: string | undefined;
+    /**
+     * @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-00#section-8.2.4
+     * @see https://datatracker.ietf.org/doc/html/draft-bhutton-json-schema-validation-00#appendix-A
+     */
+    $defs?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.1
+     */
+    type?: JSONSchema7TypeName | JSONSchema7TypeName[] | undefined;
+    enum?: JSONSchema7Type[] | undefined;
+    const?: JSONSchema7Type | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.2
+     */
+    multipleOf?: number | undefined;
+    maximum?: number | undefined;
+    exclusiveMaximum?: number | undefined;
+    minimum?: number | undefined;
+    exclusiveMinimum?: number | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.3
+     */
+    maxLength?: number | undefined;
+    minLength?: number | undefined;
+    pattern?: string | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4
+     */
+    items?: JSONSchema7Definition | JSONSchema7Definition[] | undefined;
+    additionalItems?: JSONSchema7Definition | undefined;
+    maxItems?: number | undefined;
+    minItems?: number | undefined;
+    uniqueItems?: boolean | undefined;
+    contains?: JSONSchema7 | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.5
+     */
+    maxProperties?: number | undefined;
+    minProperties?: number | undefined;
+    required?: string[] | undefined;
+    properties?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+    patternProperties?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+    additionalProperties?: JSONSchema7Definition | undefined;
+    dependencies?: {
+        [key: string]: JSONSchema7Definition | string[];
+    } | undefined;
+    propertyNames?: JSONSchema7Definition | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.6
+     */
+    if?: JSONSchema7Definition | undefined;
+    then?: JSONSchema7Definition | undefined;
+    else?: JSONSchema7Definition | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.7
+     */
+    allOf?: JSONSchema7Definition[] | undefined;
+    anyOf?: JSONSchema7Definition[] | undefined;
+    oneOf?: JSONSchema7Definition[] | undefined;
+    not?: JSONSchema7Definition | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-7
+     */
+    format?: string | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-8
+     */
+    contentMediaType?: string | undefined;
+    contentEncoding?: string | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-9
+     */
+    definitions?: {
+        [key: string]: JSONSchema7Definition;
+    } | undefined;
+    /**
+     * @see https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-10
+     */
+    title?: string | undefined;
+    description?: string | undefined;
+    default?: JSONSchema7Type | undefined;
+    readOnly?: boolean | undefined;
+    writeOnly?: boolean | undefined;
+    examples?: JSONSchema7Type | undefined;
+};
+export type ValidationResult = {
+    valid: boolean;
+    errors: ValidationError[];
+};
+export type ValidationError = {
+    property: string;
+    message: string;
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@datadayrepos/json-schema-types",
+  "version": "0.0.1-beta.12",
+  "private": false,
+  "packageManager": "pnpm@8.9.0",
+  "description": "Types used for json schema render and editors",
+  "author": "Ivar Strand",
+  "license": "MIT",
+  "homepage": "https://github.com/abyrint/json-schema-types#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/abyrint/json-schema-types.git"
+  },
+  "bugs": {
+    "url": "https://github.com/abyrint/json-schema-types/issues"
+  },
+  "keywords": [
+    "json-schema",
+    "types"
+  ],
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "lint": "eslint --cache .",
+    "lint:fix": "eslint . --fix",
+    "release": "bumpp -r && pnpm -r publish",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "typecheck": "tsc --noEmit",
+    "build": "tsc --emitDeclarationOnly",
+    "pub": "npm publish --access public"
+  },
+  "devDependencies": {
+    "@datadayrepos/eslint-config": "^1.0.1-beta.11",
+    "@datadayrepos/eslint-plugin-datadayrepos": "1.0.0-Beta12",
+    "@datadayrepos/ni": "^0.21.8",
+    "@types/node": "^20.8.3",
+    "eslint": "^8.51.0",
+    "eslint-plugin-sort-keys": "^2.3.5",
+    "lint-staged": "^14.0.1",
+    "pnpm": "^8.8.0",
+    "typescript": "^5.2.2"
+  },
+  "lint-staged": {
+    "*.{js,ts,tsx,vue,md}": [
+      "eslint --cache --fix"
+    ]
+  }
+}