@datashaper/schema - npm Package Compare versions

Comparing version 8.0.1 to 8.1.0

dist/codebook/index.d.ts

@@ -7,3 +7,7 @@ /*!
 export * from './Constraints.js';
+export * from './ErrorCode.js';
 export * from './Field.js';
+export * from './FieldError.js';
 export * from './FieldMetadata.js';
+export * from './ValidationResult.js';
+export * from './ValidationTestResult.js';

dist/codebook/index.js

@@ -6,3 +6,7 @@ /*!
 export * from './Constraints.js';
+export * from './ErrorCode.js';
 export * from './Field.js';
+export * from './FieldError.js';
 export * from './FieldMetadata.js';
+export * from './ValidationResult.js';
+export * from './ValidationTestResult.js';

docs/markdown/schema.md

@@ -20,2 +20,3 @@ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 |  [DateComparisonOperator](./schema.datecomparisonoperator.md) |  |
+|  [ErrorCode](./schema.errorcode.md) |  |
 |  [FieldAggregateOperation](./schema.fieldaggregateoperation.md) | This is the subset of aggregate functions that can operate on a single field so we don't accommodate additional args. See https://uwdata.github.io/arquero/api/op\#aggregate-functions |
@@ -69,2 +70,3 @@ |  [FilterCompareType](./schema.filtercomparetype.md) |  |
 |  [Field](./schema.field.md) | Contains the full schema definition and metadata for a data field (usually a table column). This includes the required data type, various data nature and rendering properties, potential validation rules, and mappings from a data dictionary. |
+|  [FieldError](./schema.fielderror.md) |  |
 |  [FieldMetadata](./schema.fieldmetadata.md) | Holds core metadata/stats for a data field. |
@@ -99,2 +101,4 @@ |  [FillArgs](./schema.fillargs.md) |  |
 |  [UnhotArgs](./schema.unhotargs.md) |  |
+|  [ValidationResult](./schema.validationresult.md) |  |
+|  [ValidationTestResult](./schema.validationtestresult.md) |  |
 |  [VariadicInput](./schema.variadicinput.md) | Multi-input, single output step I/O |
@@ -101,0 +105,0 @@ |  [WindowArgs](./schema.windowargs.md) |  |

docs/report/schema.api.md

@@ -347,2 +347,24 @@ ## API Report File for "@datashaper/schema"
 
+// Warning: (ae-missing-release-tag) "ErrorCode" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export enum ErrorCode {
+    // (undocumented)
+    Enum = "enum",
+    // (undocumented)
+    Maximum = "maximum length",
+    // (undocumented)
+    MaxLength = "max length",
+    // (undocumented)
+    Minimum = "minimum length",
+    // (undocumented)
+    MinLength = "min length",
+    // (undocumented)
+    Pattern = "pattern",
+    // (undocumented)
+    Required = "required",
+    // (undocumented)
+    Unique = "unique"
+}
+
 // Warning: (ae-missing-release-tag) "FactoryInput" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -424,2 +446,14 @@ //
 
+// Warning: (ae-missing-release-tag) "FieldError" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface FieldError {
+    // (undocumented)
+    indexes?: number[];
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    rule: ErrorCode;
+}
+
 // Warning: (ae-missing-release-tag) "FieldMetadata" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -997,2 +1031,22 @@ //
 
+// Warning: (ae-missing-release-tag) "ValidationResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ValidationResult {
+    // (undocumented)
+    errors: FieldError[];
+}
+
+// Warning: (ae-missing-release-tag) "ValidationTestResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ValidationTestResult {
+    // (undocumented)
+    fail: boolean;
+    // (undocumented)
+    indexes: number[];
+    // (undocumented)
+    rule: ErrorCode;
+}
+
 // Warning: (ae-missing-release-tag) "Value" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -999,0 +1053,0 @@ //

docsTemp/schema.api.md

@@ -347,2 +347,24 @@ ## API Report File for "@datashaper/schema"
 
+// Warning: (ae-missing-release-tag) "ErrorCode" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export enum ErrorCode {
+    // (undocumented)
+    Enum = "enum",
+    // (undocumented)
+    Maximum = "maximum length",
+    // (undocumented)
+    MaxLength = "max length",
+    // (undocumented)
+    Minimum = "minimum length",
+    // (undocumented)
+    MinLength = "min length",
+    // (undocumented)
+    Pattern = "pattern",
+    // (undocumented)
+    Required = "required",
+    // (undocumented)
+    Unique = "unique"
+}
+
 // Warning: (ae-missing-release-tag) "FactoryInput" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -424,2 +446,14 @@ //
 
+// Warning: (ae-missing-release-tag) "FieldError" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface FieldError {
+    // (undocumented)
+    indexes?: number[];
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    rule: ErrorCode;
+}
+
 // Warning: (ae-missing-release-tag) "FieldMetadata" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -997,2 +1031,22 @@ //
 
+// Warning: (ae-missing-release-tag) "ValidationResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ValidationResult {
+    // (undocumented)
+    errors: FieldError[];
+}
+
+// Warning: (ae-missing-release-tag) "ValidationTestResult" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export interface ValidationTestResult {
+    // (undocumented)
+    fail: boolean;
+    // (undocumented)
+    indexes: number[];
+    // (undocumented)
+    rule: ErrorCode;
+}
+
 // Warning: (ae-missing-release-tag) "Value" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
@@ -999,0 +1053,0 @@ //

package.json

 {
   "name": "@datashaper/schema",
-  "version": "8.0.1",
+  "version": "8.1.0",
   "type": "module",
@@ -36,7 +36,6 @@ "main": "dist/index.js",
   "scripts": {
-    "clean": "essex clean dist docs",
-    "_create_versions_file": "node create_versions_file.js",
+    "clean": "essex clean dist docs versions.js versions.d.ts",
     "_transpile": "essex build --docs",
     "_bundle_schemas": "run-p bundle-codebook bundle-datapackage bundle-datatable bundle-workflow",
-    "build": "run-p _create_versions_file _transpile _bundle_schemas",
+    "build": "run-p _transpile _bundle_schemas",
     "lint": "essex lint --fix",
@@ -43,0 +42,0 @@ "test": "NODE_OPTIONS=--experimental-vm-modules yarn node $(yarn bin jest) --runInBand",

src/codebook/index.ts

@@ -7,3 +7,7 @@ /*!
 export * from './Constraints.js'
+export * from './ErrorCode.js'
 export * from './Field.js'
+export * from './FieldError.js'
 export * from './FieldMetadata.js'
+export * from './ValidationResult.js'
+export * from './ValidationTestResult.js'

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Filesystem access

Supply chain risk

Accesses the file system, and could potentially read sensitive data.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

771064

increased by3.63%

Number of package files

377

increased by7.41%

Lines of code

15019

increased by3.71%

Number of low supply chain risk alerts

0

decreased by-100%

No dependency changes