@tryghost/admin-api-schema 4.5.13 → 4.7.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2025 Ghost Foundation
+Copyright (c) 2013-2026 Ghost Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -93,4 +93,4 @@ Follow the instructions for the top-level repo.
 
 # Copyright & License
 
-Copyright (c) 2013-2025 Ghost Foundation - Released under the [MIT license](LICENSE).
+Copyright (c) 2013-2026 Ghost Foundation - Released under the [MIT license](LICENSE).

package/lib/schemas/comment_bans-add.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "comment_bans.add",
+  "title": "comment_bans.add",
+  "description": "Schema for comment_bans.add",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "comment_bans": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 1,
+      "items": {
+        "allOf": [{ "$ref": "comment_bans#/definitions/comment_ban" }]
+      }
+    }
+  },
+  "required": ["comment_bans"]
+}

package/lib/schemas/comment_bans.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "comment_bans",
+  "title": "comment_bans",
+  "description": "Base comment_bans definitions",
+  "definitions": {
+    "comment_ban": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "reason": {
+          "type": "string",
+          "minLength": 1,
+          "maxLength": 2000
+        },
+        "expires_at": {
+          "type": ["string", "null"],
+          "format": "date-time"
+        }
+      },
+      "required": ["reason"]
+    }
+  }
+}

package/lib/schemas/index.js

@@ -1,4 +1,5 @@
 module.exports = [
+    'comment_bans-add',
     'images-upload',
     'media-upload',
     'labels-add',

package/lib/schemas/members-edit.json

@@ -50,6 +50,23 @@
           },
           "labels": {
             "$ref": "members#/definitions/member-labels"
+          },
+          "can_comment": {
+            "type": "boolean"
+          },
+          "comment_ban": {
+            "oneOf": [
+              {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {
+                  "reason": { "type": "string", "minLength": 1, "maxLength": 2000 },
+                  "expires_at": { "type": ["string", "null"], "format": "date-time" }
+                },
+                "required": ["reason"]
+              },
+              { "type": "null" }
+            ]
           }
         }
       }

package/lib/schemas/members.json

@@ -47,6 +47,23 @@
         },
         "newsletters": {
           "$ref": "#/definitions/member-newsletters"
+        },
+        "can_comment": {
+          "type": "boolean"
+        },
+        "comment_ban": {
+          "oneOf": [
+            {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "reason": { "type": "string", "minLength": 1, "maxLength": 2000 },
+                "expires_at": { "type": ["string", "null"], "format": "date-time" }
+              },
+              "required": ["reason"]
+            },
+            { "type": "null" }
+          ]
         }
       }
     },

package/lib/utils/is-lowercase-keyword.js

@@ -1,5 +1,6 @@
 module.exports = function defFunc(ajv) {
-    defFunc.definition = {
+    ajv.addKeyword({
+        keyword: 'isLowercase',
         errors: false,
         validate: function (schema, data) {
             if (data) {
@@ -8,8 +9,6 @@ module.exports = function defFunc(ajv) {
 
             return true;
         }
-    };
-
-    ajv.addKeyword('isLowercase', defFunc.definition);
+    });
     return ajv;
 };

package/lib/utils/json-schema.js

@@ -1,20 +1,25 @@
 const _ = require('lodash');
 const Ajv = require('ajv');
+const addFormats = require('ajv-formats');
 const isLowercaseKeyword = require('./is-lowercase-keyword');
 const errors = require('@tryghost/errors');
 
 const ajv = new Ajv({
     allErrors: true,
     useDefaults: true,
-    removeAdditional: true,
-    formats: {
-        'json-string': (data) => {
-            try {
-                JSON.parse(data);
-                return true;
-            } catch (e) {
-                return false;
-            }
+    removeAdditional: true
+});
+
+addFormats(ajv);
+
+ajv.addFormat('json-string', {
+    type: 'string',
+    validate: (data) => {
+        try {
+            JSON.parse(data);
+            return true;
+        } catch (e) {
+            return false;
         }
     }
 });
@@ -35,10 +40,10 @@ const validate = (schema, definition, data) => {
 
     if (validation.errors) {
         let key;
-        const dataPath = _.get(validation, 'errors[0].dataPath');
+        const instancePath = _.get(validation, 'errors[0].instancePath');
 
-        if (dataPath) {
-            key = dataPath.split('.').pop();
+        if (instancePath) {
+            key = instancePath.split('/').pop();
         } else {
             key = schema.$id.split('.')[0];
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/admin-api-schema",
-  "version": "4.5.13",
+  "version": "4.7.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/TryGhost/SDK.git",
@@ -11,7 +11,7 @@
   "main": "index.js",
   "scripts": {
     "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura mocha './test/**/*.test.js'",
+    "test": "NODE_ENV=testing c8 --reporter text --reporter cobertura mocha './test/**/*.test.js'",
     "lint": "eslint . --ext .js --cache",
     "posttest": "yarn lint"
   },
@@ -23,15 +23,16 @@
     "access": "public"
   },
   "devDependencies": {
-    "c8": "10.1.3",
+    "c8": "11.0.0",
     "mocha": "11.7.5",
     "should": "13.2.3",
-    "sinon": "21.0.0"
+    "sinon": "21.0.1"
   },
   "dependencies": {
-    "@tryghost/errors": "1.3.8",
-    "ajv": "^6.12.6",
-    "lodash": "^4.17.11"
+    "@tryghost/errors": "2.2.1",
+    "ajv": "8.18.0",
+    "ajv-formats": "3.0.1",
+    "lodash": "4.17.23"
   },
-  "gitHead": "a97d783ddb64ae80592ec03468b221a4ec37948a"
+  "gitHead": "2c937c80e98d9bad4458e1c2e9d6f6b138bd308e"
 }