screwdriver-data-schema 21.28.4 → 22.0.1

package/models/pipeline.js

@@ -27,11 +27,7 @@ const CREATE_MODEL = {
 };
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this pipeline')
-        .example(123345),
+    id: Joi.number().integer().positive().description('Identifier of this pipeline').example(123345),
 
     name: Scm.repoName.optional(),
 
@@ -50,23 +46,15 @@ const MODEL = {
 
     scmRepo: Scm.repo,
 
-    createTime: Joi.string()
-        .isoDate()
-        .description('When this pipeline was created'),
+    createTime: Joi.string().isoDate().description('When this pipeline was created'),
 
-    admins: Joi.object()
-        .description('Admins of this Pipeline')
-        .example({ myself: true }),
+    admins: Joi.object().description('Admins of this Pipeline').example({ myself: true }),
 
     workflowGraph: WorkflowGraph.workflowGraph.description('Graph representation of the workflow'),
 
     annotations: Annotations.annotations.description('Pipeline-level annotations'),
 
-    lastEventId: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of last event')
-        .example(123345),
+    lastEventId: Joi.number().integer().positive().description('Identifier of last event').example(123345),
 
     configPipelineId: Joi.number()
         .integer()

package/models/secret.js

@@ -5,23 +5,13 @@ const mutate = require('../lib/mutate');
 const Job = require('../config/job');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this secret')
-        .example(123345),
+    id: Joi.number().integer().positive().description('Identifier of this secret').example(123345),
 
-    pipelineId: Joi.number()
-        .integer()
-        .positive()
-        .description('pipeline associated with the secret')
-        .example(123345),
+    pipelineId: Joi.number().integer().positive().description('pipeline associated with the secret').example(123345),
 
     name: Job.secret.description('Name of the secret').example('NPM_TOKEN'),
 
-    value: Joi.string()
-        .description('value of the secret')
-        .example('2d991790bab1ac8576097ca87f170df73410b55c'),
+    value: Joi.string().description('value of the secret').example('2d991790bab1ac8576097ca87f170df73410b55c'),
 
     allowInPR: Joi.boolean().description('flag to denote if the secret can be shown in PR builds')
 };

package/models/stage.js

@@ -4,43 +4,19 @@ const Joi = require('joi');
 const Regex = require('../config/regex');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .example(12345),
+    id: Joi.number().integer().positive().example(12345),
 
-    pipelineId: Joi.number()
-        .integer()
-        .positive()
-        .description('Pipeline associated with the Stage')
-        .example(123345),
+    pipelineId: Joi.number().integer().positive().description('Pipeline associated with the Stage').example(123345),
 
-    name: Joi.string()
-        .regex(Regex.STAGE_NAME)
-        .max(110)
-        .description('Name of the Stage')
-        .example('deploy'),
+    name: Joi.string().regex(Regex.STAGE_NAME).max(110).description('Name of the Stage').example('deploy'),
 
     jobIds: Joi.array()
-        .items(
-            Joi.number()
-                .integer()
-                .positive()
-                .description('Identifier for this job')
-                .example(123345)
-        )
+        .items(Joi.number().integer().positive().description('Identifier for this job').example(123345))
         .description('Job IDs in this Stage'),
 
-    description: Joi.string()
-        .max(256)
-        .description('Description of the Stage')
-        .example('Deploys canary jobs'),
+    description: Joi.string().max(256).description('Description of the Stage').example('Deploys canary jobs'),
 
-    groupEventId: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of the group event')
-        .example(123345)
+    groupEventId: Joi.number().integer().positive().description('Identifier of the group event').example(123345)
 };
 
 module.exports = {

package/models/step.js

@@ -4,46 +4,24 @@ const Joi = require('joi');
 const mutate = require('../lib/mutate');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this Step')
-        .example(123345),
-
-    buildId: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of the parent Build')
-        .example(123345),
-
-    name: Joi.string()
-        .max(64)
-        .description('Name of the Step')
-        .example('install'),
-
-    command: Joi.string()
-        .description('Command of the Step to execute')
-        .example('npm install'),
-
-    code: Joi.number()
-        .integer()
-        .description('Exit code')
-        .example(1),
-
-    startTime: Joi.string()
-        .isoDate()
-        .description('When this Step started')
-        .example('2017-01-06T01:49:50.384359267Z'),
+    id: Joi.number().integer().positive().description('Identifier of this Step').example(123345),
+
+    buildId: Joi.number().integer().positive().description('Identifier of the parent Build').example(123345),
+
+    name: Joi.string().max(64).description('Name of the Step').example('install'),
+
+    command: Joi.string().description('Command of the Step to execute').example('npm install'),
+
+    code: Joi.number().integer().description('Exit code').example(1),
+
+    startTime: Joi.string().isoDate().description('When this Step started').example('2017-01-06T01:49:50.384359267Z'),
 
     endTime: Joi.string()
         .isoDate()
         .description('When this Step stopped running')
         .example('2017-01-06T01:49:51.676057192Z'),
 
-    lines: Joi.number()
-        .integer()
-        .description('Number of Step log lines')
-        .example(100)
+    lines: Joi.number().integer().description('Number of Step log lines').example(100)
 };
 
 module.exports = {

package/models/template.js

@@ -6,20 +6,10 @@ const Template = require('../config/template');
 const pipelineId = require('./pipeline').base.extract('id');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this template')
-        .example(123345),
-    labels: Joi.array()
-        .items(Joi.string())
-        .description('Labels for template')
-        .example(['stable', 'latest', 'beta']),
+    id: Joi.number().integer().positive().description('Identifier of this template').example(123345),
+    labels: Joi.array().items(Joi.string()).description('Labels for template').example(['stable', 'latest', 'beta']),
     config: Template.config,
-    name: Joi.string()
-        .max(64)
-        .description('Template name')
-        .example('nodejs/lib'),
+    name: Joi.string().max(64).description('Template name').example('nodejs/lib'),
     version: Template.version,
     description: Template.description,
     maintainer: Template.maintainer,

package/models/templateTag.js

@@ -4,21 +4,14 @@ const Joi = require('joi');
 const Template = require('../config/template');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this template tag')
-        .example(123345),
+    id: Joi.number().integer().positive().description('Identifier of this template tag').example(123345),
     createTime: Joi.string()
         .isoDate()
         .max(32)
         .description('When this template tag was created')
         .example('2038-01-19T03:14:08.131Z'),
     namespace: Template.namespace,
-    name: Joi.string()
-        .max(64)
-        .description('Template name')
-        .example('nodejs/lib'),
+    name: Joi.string().max(64).description('Template name').example('nodejs/lib'),
     tag: Template.templateTag,
     version: Template.exactVersion
 };

package/models/token.js

@@ -9,9 +9,7 @@ const HASH_LENGTH = 512;
 const HASH_BASE64_LENGTH = Math.ceil(HASH_LENGTH / 6);
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive(),
+    id: Joi.number().integer().positive(),
 
     hash: Joi.string()
         // Using https://www.npmjs.com/package/base64url
@@ -19,21 +17,11 @@ const MODEL = {
         .length(HASH_BASE64_LENGTH)
         .description('Hashed token value'),
 
-    userId: Joi.number()
-        .integer()
-        .positive()
-        .description('User ID'),
+    userId: Joi.number().integer().positive().description('User ID'),
 
-    pipelineId: Joi.number()
-        .integer()
-        .positive()
-        .description('Pipeline ID')
-        .example(123345),
+    pipelineId: Joi.number().integer().positive().description('Pipeline ID').example(123345),
 
-    name: Joi.string()
-        .max(128)
-        .description('Token name')
-        .example('Mobile token'),
+    name: Joi.string().max(128).description('Token name').example('Mobile token'),
 
     description: Joi.string()
         .max(256)
@@ -41,10 +29,7 @@ const MODEL = {
         .description('Token description')
         .example('Used to authenticate the mobile app'),
 
-    lastUsed: Joi.string()
-        .isoDate()
-        .allow('')
-        .description('Last used')
+    lastUsed: Joi.string().isoDate().allow('').description('Last used')
 };
 
 module.exports = {
@@ -54,9 +39,7 @@ module.exports = {
      * @property base
      * @type {Joi}
      */
-    base: Joi.object(MODEL)
-        .without('userId', 'pipelineId')
-        .label('Token'),
+    base: Joi.object(MODEL).without('userId', 'pipelineId').label('Token'),
 
     /**
      * All the available properties of Job

package/models/trigger.js

@@ -4,30 +4,19 @@ const Joi = require('joi');
 const Regex = require('../config/regex');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .example(12345),
+    id: Joi.number().integer().positive().example(12345),
 
     src: Joi.alternatives()
         .try(
-            Joi.string()
-                .regex(Regex.EXTERNAL_TRIGGER)
-                .max(128),
-            Joi.string()
-                .regex(Regex.EXTERNAL_TRIGGER_AND)
-                .max(128)
+            Joi.string().regex(Regex.EXTERNAL_TRIGGER).max(128),
+            Joi.string().regex(Regex.EXTERNAL_TRIGGER_AND).max(128)
         )
         .example('~sd@1234:component'),
 
     dest: Joi.alternatives()
         .try(
-            Joi.string()
-                .regex(Regex.EXTERNAL_TRIGGER)
-                .max(128),
-            Joi.string()
-                .regex(Regex.EXTERNAL_TRIGGER_AND)
-                .max(128)
+            Joi.string().regex(Regex.EXTERNAL_TRIGGER).max(128),
+            Joi.string().regex(Regex.EXTERNAL_TRIGGER_AND).max(128)
         )
         .example('~sd@5678:test')
 };

package/models/user.js

@@ -7,16 +7,9 @@ const scmContext = pipelineBaseSchema.extract('scmContext');
 const Settings = require('../config/settings');
 
 const MODEL = {
-    id: Joi.number()
-        .integer()
-        .positive()
-        .description('Identifier of this user')
-        .example(123345),
+    id: Joi.number().integer().positive().description('Identifier of this user').example(123345),
 
-    username: Joi.string()
-        .max(128)
-        .description('Username')
-        .example('batman123'),
+    username: Joi.string().max(128).description('Username').example('batman123'),
 
     token: Joi.string().description('Github token'),
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "screwdriver-data-schema",
-  "version": "21.28.4",
+  "version": "22.0.1",
   "description": "Internal Data Schema of Screwdriver",
   "main": "index.js",
   "scripts": {
@@ -40,22 +40,22 @@
   },
   "devDependencies": {
     "chai": "^4.3.6",
-    "eslint": "^7.32.0",
-    "eslint-config-screwdriver": "^5.0.1",
-    "js-yaml": "^3.14.1",
-    "mocha": "^9.2.0",
+    "eslint": "^8.27.0",
+    "eslint-config-screwdriver": "^7.0.0",
+    "js-yaml": "^4.1.0",
+    "mocha": "^10.1.0",
     "mocha-multi-reporters": "^1.5.1",
     "mocha-sonarqube-reporter": "^1.0.2",
     "mysql2": "^1.7.0",
     "npx": "^10.2.2",
-    "nyc": "^15.0.0",
+    "nyc": "^15.1.0",
     "pg": "^7.18.2",
-    "sequelize": "^6.24.0",
-    "sequelize-cli": "^6.5.1",
-    "sqlite3": "^4.2.0"
+    "sequelize": "^6.25.3",
+    "sequelize-cli": "^6.5.2",
+    "sqlite3": "^5.1.2"
   },
   "dependencies": {
-    "cron-parser": "^4.5.0",
-    "joi": "^17.6.2"
+    "cron-parser": "^4.6.0",
+    "joi": "^17.7.0"
   }
 }

package/plugins/datastore.js

@@ -4,18 +4,13 @@ const Joi = require('joi');
 const table = Joi.string().required();
 const SCHEMA_ID = Joi.object().keys({
     table,
-    params: Joi.object()
-        .min(1)
-        .required()
+    params: Joi.object().min(1).required()
 });
 const SCHEMA_UPDATE = Joi.object().keys({
     table,
     params: Joi.object()
         .keys({
-            id: Joi.number()
-                .integer()
-                .positive()
-                .required()
+            id: Joi.number().integer().positive().required()
         })
         .unknown(true)
         .min(2)
@@ -23,48 +18,25 @@ const SCHEMA_UPDATE = Joi.object().keys({
 });
 const SCHEMA_SAVE = Joi.object().keys({
     table,
-    params: Joi.object()
-        .unknown(true)
-        .min(1)
-        .required()
+    params: Joi.object().unknown(true).min(1).required()
 });
-const SCHEMA_SEARCH_FIELD = Joi.string()
-    .max(100)
-    .required();
-const SCHEMA_SEARCH_KEYWORD = Joi.alternatives().try(
-    Joi.string()
-        .max(200)
-        .required(),
-    Joi.number().required()
-);
+const SCHEMA_SEARCH_FIELD = Joi.string().max(100).required();
+const SCHEMA_SEARCH_KEYWORD = Joi.alternatives().try(Joi.string().max(200).required(), Joi.number().required());
 const SCHEMA_SCAN = Joi.object().keys({
     table,
     params: Joi.object(),
     paginate: Joi.object().keys({
-        count: Joi.number()
-            .integer()
-            .positive()
-            .required(),
-        page: Joi.number()
-            .integer()
-            .positive()
-            .required()
+        count: Joi.number().integer().positive().required(),
+        page: Joi.number().integer().positive().required()
     }),
     search: Joi.object().keys({
         field: Joi.alternatives().try(Joi.array().items(SCHEMA_SEARCH_FIELD), SCHEMA_SEARCH_FIELD),
         keyword: Joi.alternatives().try(Joi.array().items(SCHEMA_SEARCH_KEYWORD), SCHEMA_SEARCH_KEYWORD)
     }),
-    sort: Joi.string()
-        .lowercase()
-        .valid('ascending', 'descending')
-        .default('descending'),
+    sort: Joi.string().lowercase().valid('ascending', 'descending').default('descending'),
     sortBy: Joi.string().max(100),
-    exclude: Joi.array()
-        .items(Joi.string().max(100))
-        .max(100),
-    groupBy: Joi.array()
-        .items(Joi.string().max(100))
-        .max(100),
+    exclude: Joi.array().items(Joi.string().max(100)).max(100),
+    groupBy: Joi.array().items(Joi.string().max(100)).max(100),
     startTime: Joi.string().isoDate(),
     endTime: Joi.string().isoDate(),
     timeKey: Joi.string(),

package/plugins/executor.js

@@ -38,17 +38,10 @@ const buildSchemaObj = {
     pipelineId,
     buildClusterName: models.buildCluster.base.extract('name'),
     container: models.build.base.extract('container').required(),
-    apiUri: Joi.string()
-        .uri()
-        .required()
-        .label('API URI'),
-    token: Joi.string()
-        .required()
-        .label('Build JWT'),
+    apiUri: Joi.string().uri().required().label('API URI'),
+    token: Joi.string().required().label('Build JWT'),
     enqueueTime: Joi.date().iso(),
-    isPR: Joi.boolean()
-        .optional()
-        .default(true),
+    isPR: Joi.boolean().optional().default(true),
     prParentJobId: jobId.optional()
 };
 const SCHEMA_START = Joi.object()
@@ -66,10 +59,7 @@ const SCHEMA_STOP = Joi.object()
         token: Joi.string().label('Build JWT'),
         pipelineId,
         provider: Provider.provider.optional(),
-        apiUri: Joi.string()
-            .uri()
-            .required()
-            .label('API URI'),
+        apiUri: Joi.string().uri().required().label('API URI'),
         jobName
     })
     .unknown(true) // allow other fields

package/plugins/notifications.js

@@ -3,9 +3,7 @@
 const Joi = require('joi');
 const STATUSES = require('../models/build').allStatuses;
 const SCHEMA_STATUS = Joi.string().valid(...STATUSES);
-const SCHEMA_BUILD_SETTINGS = Joi.object()
-    .keys({})
-    .unknown(true);
+const SCHEMA_BUILD_SETTINGS = Joi.object().keys({}).unknown(true);
 const SCHEMA_SCM_REPO = Joi.object()
     .keys({
         name: Joi.string().required()
@@ -23,9 +21,7 @@ const SCHEMA_BUILD_DATA = {
     jobName: Joi.string(),
     build: Joi.object()
         .keys({
-            id: Joi.number()
-                .integer()
-                .required()
+            id: Joi.number().integer().required()
         })
         .unknown(true),
     event: Joi.object(),

package/plugins/scm.js

@@ -10,10 +10,7 @@ const checkoutUrl = models.pipeline.create.extract('checkoutUrl').required();
 const hook = core.scm.hook.required();
 const jobName = models.job.base.extract('name').optional();
 const pipelineId = models.pipeline.base.extract('id').optional();
-const prNum = core.scm.hook
-    .extract('prNum')
-    .allow(null)
-    .optional();
+const prNum = core.scm.hook.extract('prNum').allow(null).optional();
 const rootDir = Scm.rootDir.optional();
 const scmContext = models.pipeline.base.extract('scmContext').optional();
 const scmRepo = Scm.repo.optional();
@@ -128,17 +125,11 @@ const UPDATE_COMMIT_STATUS = Joi.object()
             .required()
             .valid(...SCM_STATUSES),
         jobName,
-        url: Joi.string()
-            .uri()
-            .required(),
+        url: Joi.string().uri().required(),
         pipelineId,
         scmContext,
-        context: Joi.string()
-            .max(100)
-            .optional(),
-        description: Joi.string()
-            .max(200)
-            .optional()
+        context: Joi.string().max(100).optional(),
+        description: Joi.string().max(200).optional()
     })
     .required();
 
@@ -156,9 +147,7 @@ const GET_FILE = Joi.object()
 const GET_CHANGED_FILES_INPUT = Joi.object()
     .keys({
         type,
-        webhookConfig: Joi.object()
-            .allow(null)
-            .required(),
+        webhookConfig: Joi.object().allow(null).required(),
         token,
         scmContext,
         scmUri: scmUri.optional(),
@@ -166,12 +155,7 @@ const GET_CHANGED_FILES_INPUT = Joi.object()
     })
     .required();
 
-const GET_CHANGED_FILES_OUTPUT = Joi.alternatives().try(
-    Joi.array()
-        .items(Joi.string())
-        .required(),
-    null
-);
+const GET_CHANGED_FILES_OUTPUT = Joi.alternatives().try(Joi.array().items(Joi.string()).required(), null);
 
 const PARSE_HOOK = Joi.alternatives().try(hook, null);