screwdriver-data-schema - npm Package Compare versions

Comparing version 4.0.1 to 5.0.0

index.js

 'use strict';
-const build = require('./model/build');
-const job = require('./model/job');
-const pipeline = require('./model/pipeline');
-const platform = require('./model/platform');
-const user = require('./model/user');
-const pagination = require('./model/pagination');
 
-module.exports = { build, job, pipeline, platform, user, pagination };
+const models = require('./models');
+const api = require('./api');
+const config = require('./config');
+
+module.exports = { models, api, config };

package.json

 {
   "name": "screwdriver-data-schema",
-  "version": "4.0.1",
+  "version": "5.0.0",
   "description": "Internal Data Schema of Screwdriver",
@@ -42,4 +42,4 @@ "main": "index.js",
   "dependencies": {
-    "joi": "^8.1.0"
+    "joi": "^9.0.0"
   }
 }

README.md

@@ -10,8 +10,14 @@ # Screwdriver Data Schema
 
-The model represents a combination of what is required to create the resource and what is possible
-for returning from the resource.
+It's broken down into three sections:
+ - `api` - API related input/output structure
+ - `config` - Screwdriver.yaml definitions
+ - `models` - Internal data resources
 
-## Methodology
+## Models
 
-Each model contains four (4) schemas:
+The model represents a combination of what is required to create the resource and what is possible for returning from the resource.
+
+### Methodology
+
+Each model contains seven (7) schemas:
  - `base` - List of all available fields in the model
@@ -21,2 +27,5 @@ - `get` - Expected return values from a GET request against this resource
  - `update` - Expected input values when making an UPDATE action against this resource
+ - `keys` - List of keys that combine to represent a unique row
+ - `tableName` - Internal name of the table
+ - `indexes` - Secondary indexes to make search/lookup faster
 
@@ -26,3 +35,3 @@ ## Usage
 ```bash
-npm install screwdriver-data-model
+npm install screwdriver-data-schema
 ```
@@ -29,0 +38,0 @@

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

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

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

Improved metrics

Total package byte prevSize

42126

increased by39.32%

Number of package files

68

increased by54.55%

Lines of code

998

increased by42.37%

Number of lines in readme file

56

increased by19.15%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addeditems@2.2.1(transitive)

• + Addedjoi@9.2.0(transitive)

• - Removedjoi@8.4.2(transitive)

• Updatedjoi@^9.0.0