@takeshape/schema 9.53.0 → 9.55.0

package/dist/schemas/project-schema.json

@@ -138,6 +138,9 @@
     {
       "$ref": "https://schema.takeshape.io/project-schema/v3.36.0#"
     },
+    {
+      "$ref": "https://schema.takeshape.io/project-schema/v3.37.0#"
+    },
     {
       "$ref": "https://schema.takeshape.io/project-schema/v4.0.0#"
     }

package/es/migration/index.js

@@ -42,6 +42,7 @@ import migrateToV3_33_0 from './to/v3.33.0';
 import migrateToV3_34_0 from './to/v3.34.0';
 import migrateToV3_35_0 from './to/v3.35.0';
 import migrateToV3_36_0 from './to/v3.36.0';
+import migrateToV3_37_0 from './to/v3.37.0';
 export const migrateTo = {
   'v3.0.0': migrateToV3_0_0,
   'v3.1.0': migrateToV3_1_0,
@@ -86,7 +87,8 @@ export const migrateTo = {
   'v3.33.0': migrateToV3_33_0,
   'v3.34.0': migrateToV3_34_0,
   'v3.35.0': migrateToV3_35_0,
-  'v3.36.0': migrateToV3_36_0
+  'v3.36.0': migrateToV3_36_0,
+  'v3.37.0': migrateToV3_37_0
 };
 export * from './utils';
 export const listTypePrefix = 'PaginatedList';

package/es/migration/to/v3.37.0.js

@@ -0,0 +1,10 @@
+const migrate = async (_, projectSchema) => {
+  /**
+   * No migration needed all changes are backwards compatible.
+   */
+  return { ...projectSchema,
+    schemaVersion: '3.37.0'
+  };
+};
+
+export default migrate;

package/es/project-schema/index.js

@@ -45,6 +45,7 @@ export * from './v3.33.0';
 export * from './v3.34.0';
 export * from './v3.35.0';
 export * from './v3.36.0';
+export * from './v3.37.0';
 export * from './v4.0.0';
 
 // Schema type utilities
@@ -111,5 +112,6 @@ export const isProjectSchemaJSONV3_33_0 = createVersionPredicate('3.33.0');
 export const isProjectSchemaJSONV3_34_0 = createVersionPredicate('3.34.0');
 export const isProjectSchemaJSONV3_35_0 = createVersionPredicate('3.35.0');
 export const isProjectSchemaJSONV3_36_0 = createVersionPredicate('3.36.0');
-export const isLatestProjectSchemaJSON = createVersionPredicate('3.36.0');
+export const isProjectSchemaJSONV3_37_0 = createVersionPredicate('3.37.0');
+export const isLatestProjectSchemaJSON = createVersionPredicate('3.37.0');
 export const isProjectSchemaJSONV4_0_0 = createVersionPredicate('4.0.0');

package/es/project-schema/migrate.js

@@ -1,6 +1,6 @@
 // This file is generated by "pnpm json2ts"
 import { migrateTo } from '../migration';
-import { isProjectSchemaJSONV1_0_0, isProjectSchemaJSONV3_0_0, isProjectSchemaJSONV3_1_0, isProjectSchemaJSONV3_2_0, isProjectSchemaJSONV3_3_0, isProjectSchemaJSONV3_4_0, isProjectSchemaJSONV3_5_0, isProjectSchemaJSONV3_5_1, isProjectSchemaJSONV3_6_0, isProjectSchemaJSONV3_7_0, isProjectSchemaJSONV3_8_0, isProjectSchemaJSONV3_9_0, isProjectSchemaJSONV3_10_0, isProjectSchemaJSONV3_11_0, isProjectSchemaJSONV3_12_0, isProjectSchemaJSONV3_12_1, isProjectSchemaJSONV3_12_2, isProjectSchemaJSONV3_12_3, isProjectSchemaJSONV3_13_0, isProjectSchemaJSONV3_14_0, isProjectSchemaJSONV3_15_0, isProjectSchemaJSONV3_16_0, isProjectSchemaJSONV3_17_0, isProjectSchemaJSONV3_17_1, isProjectSchemaJSONV3_18_0, isProjectSchemaJSONV3_18_1, isProjectSchemaJSONV3_18_2, isProjectSchemaJSONV3_19_0, isProjectSchemaJSONV3_20_0, isProjectSchemaJSONV3_21_0, isProjectSchemaJSONV3_22_0, isProjectSchemaJSONV3_23_0, isProjectSchemaJSONV3_24_0, isProjectSchemaJSONV3_25_0, isProjectSchemaJSONV3_26_0, isProjectSchemaJSONV3_27_0, isProjectSchemaJSONV3_28_0, isProjectSchemaJSONV3_29_0, isProjectSchemaJSONV3_30_0, isProjectSchemaJSONV3_31_0, isProjectSchemaJSONV3_32_0, isProjectSchemaJSONV3_33_0, isProjectSchemaJSONV3_34_0, isProjectSchemaJSONV3_35_0, isProjectSchemaJSONV4_0_0, isLatestProjectSchemaJSON } from './index'; // eslint-disable-next-line complexity
+import { isProjectSchemaJSONV1_0_0, isProjectSchemaJSONV3_0_0, isProjectSchemaJSONV3_1_0, isProjectSchemaJSONV3_2_0, isProjectSchemaJSONV3_3_0, isProjectSchemaJSONV3_4_0, isProjectSchemaJSONV3_5_0, isProjectSchemaJSONV3_5_1, isProjectSchemaJSONV3_6_0, isProjectSchemaJSONV3_7_0, isProjectSchemaJSONV3_8_0, isProjectSchemaJSONV3_9_0, isProjectSchemaJSONV3_10_0, isProjectSchemaJSONV3_11_0, isProjectSchemaJSONV3_12_0, isProjectSchemaJSONV3_12_1, isProjectSchemaJSONV3_12_2, isProjectSchemaJSONV3_12_3, isProjectSchemaJSONV3_13_0, isProjectSchemaJSONV3_14_0, isProjectSchemaJSONV3_15_0, isProjectSchemaJSONV3_16_0, isProjectSchemaJSONV3_17_0, isProjectSchemaJSONV3_17_1, isProjectSchemaJSONV3_18_0, isProjectSchemaJSONV3_18_1, isProjectSchemaJSONV3_18_2, isProjectSchemaJSONV3_19_0, isProjectSchemaJSONV3_20_0, isProjectSchemaJSONV3_21_0, isProjectSchemaJSONV3_22_0, isProjectSchemaJSONV3_23_0, isProjectSchemaJSONV3_24_0, isProjectSchemaJSONV3_25_0, isProjectSchemaJSONV3_26_0, isProjectSchemaJSONV3_27_0, isProjectSchemaJSONV3_28_0, isProjectSchemaJSONV3_29_0, isProjectSchemaJSONV3_30_0, isProjectSchemaJSONV3_31_0, isProjectSchemaJSONV3_32_0, isProjectSchemaJSONV3_33_0, isProjectSchemaJSONV3_34_0, isProjectSchemaJSONV3_35_0, isProjectSchemaJSONV3_36_0, isProjectSchemaJSONV4_0_0, isLatestProjectSchemaJSON } from './index'; // eslint-disable-next-line complexity
 
 export async function migrateToLatestProjectSchema(context, projectSchema) {
   if (isLatestProjectSchemaJSON(projectSchema)) {
@@ -183,6 +183,10 @@ export async function migrateToLatestProjectSchema(context, projectSchema) {
     projectSchema = await migrateTo['v3.36.0'](context, projectSchema);
   }
 
+  if (isProjectSchemaJSONV3_36_0(projectSchema)) {
+    projectSchema = await migrateTo['v3.37.0'](context, projectSchema);
+  }
+
   if (isProjectSchemaJSONV4_0_0(projectSchema)) {
     throw new Error('You are using an unreleased schema version. Migration is not possible');
   }

package/es/project-schema/v3.37.0.js

@@ -0,0 +1 @@
+export {};

package/es/schemas/index.js

@@ -1,7 +1,7 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.36.0';
+export const CURRENT_SCHEMA_VERSION = '3.37.0';
 export { default as anyProjectSchema } from './project-schema.json';
-export { default as latestSchemaJson } from './project-schema/v3.36.0.json';
+export { default as latestSchemaJson } from './project-schema/v3.37.0.json';
 import metaSchemaV1_0_0 from './project-schema/meta-schema-v1.0.0.json';
 import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV3_0_0 from './project-schema/meta-schema-v3.0.0.json';
@@ -59,5 +59,6 @@ import projectSchemaV3_33_0 from './project-schema/v3.33.0.json';
 import projectSchemaV3_34_0 from './project-schema/v3.34.0.json';
 import projectSchemaV3_35_0 from './project-schema/v3.35.0.json';
 import projectSchemaV3_36_0 from './project-schema/v3.36.0.json';
+import projectSchemaV3_37_0 from './project-schema/v3.37.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
-export const allProjectSchemas = [metaSchemaV1_0_0, projectSchemaV1_0_0, metaSchemaV3_0_0, projectSchemaV3_0_0, metaSchemaV3_1_0, projectSchemaV3_1_0, metaSchemaV3_2_0, projectSchemaV3_2_0, metaSchemaV3_3_0, projectSchemaV3_3_0, metaSchemaV3_4_0, projectSchemaV3_4_0, metaSchemaV3_5_0, projectSchemaV3_5_0, metaSchemaV3_5_1, projectSchemaV3_5_1, metaSchemaV3_6_0, projectSchemaV3_6_0, metaSchemaV3_7_0, projectSchemaV3_7_0, metaSchemaV3_8_0, projectSchemaV3_8_0, metaSchemaV3_9_0, projectSchemaV3_9_0, projectSchemaV3_10_0, projectSchemaV3_11_0, projectSchemaV3_12_0, projectSchemaV3_12_1, projectSchemaV3_12_2, projectSchemaV3_12_3, projectSchemaV3_13_0, projectSchemaV3_14_0, projectSchemaV3_15_0, projectSchemaV3_16_0, projectSchemaV3_17_0, projectSchemaV3_17_1, projectSchemaV3_18_0, projectSchemaV3_18_1, projectSchemaV3_18_2, projectSchemaV3_19_0, projectSchemaV3_20_0, projectSchemaV3_21_0, projectSchemaV3_22_0, projectSchemaV3_23_0, projectSchemaV3_24_0, projectSchemaV3_25_0, projectSchemaV3_26_0, projectSchemaV3_27_0, projectSchemaV3_28_0, projectSchemaV3_29_0, projectSchemaV3_30_0, projectSchemaV3_31_0, projectSchemaV3_32_0, projectSchemaV3_33_0, projectSchemaV3_34_0, projectSchemaV3_35_0, projectSchemaV3_36_0, projectSchemaV4_0_0];
+export const allProjectSchemas = [metaSchemaV1_0_0, projectSchemaV1_0_0, metaSchemaV3_0_0, projectSchemaV3_0_0, metaSchemaV3_1_0, projectSchemaV3_1_0, metaSchemaV3_2_0, projectSchemaV3_2_0, metaSchemaV3_3_0, projectSchemaV3_3_0, metaSchemaV3_4_0, projectSchemaV3_4_0, metaSchemaV3_5_0, projectSchemaV3_5_0, metaSchemaV3_5_1, projectSchemaV3_5_1, metaSchemaV3_6_0, projectSchemaV3_6_0, metaSchemaV3_7_0, projectSchemaV3_7_0, metaSchemaV3_8_0, projectSchemaV3_8_0, metaSchemaV3_9_0, projectSchemaV3_9_0, projectSchemaV3_10_0, projectSchemaV3_11_0, projectSchemaV3_12_0, projectSchemaV3_12_1, projectSchemaV3_12_2, projectSchemaV3_12_3, projectSchemaV3_13_0, projectSchemaV3_14_0, projectSchemaV3_15_0, projectSchemaV3_16_0, projectSchemaV3_17_0, projectSchemaV3_17_1, projectSchemaV3_18_0, projectSchemaV3_18_1, projectSchemaV3_18_2, projectSchemaV3_19_0, projectSchemaV3_20_0, projectSchemaV3_21_0, projectSchemaV3_22_0, projectSchemaV3_23_0, projectSchemaV3_24_0, projectSchemaV3_25_0, projectSchemaV3_26_0, projectSchemaV3_27_0, projectSchemaV3_28_0, projectSchemaV3_29_0, projectSchemaV3_30_0, projectSchemaV3_31_0, projectSchemaV3_32_0, projectSchemaV3_33_0, projectSchemaV3_34_0, projectSchemaV3_35_0, projectSchemaV3_36_0, projectSchemaV3_37_0, projectSchemaV4_0_0];

package/es/schemas/index.ts

@@ -1,7 +1,7 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.36.0';
+export const CURRENT_SCHEMA_VERSION = '3.37.0';
 export {default as anyProjectSchema} from './project-schema.json';
-export {default as latestSchemaJson} from './project-schema/v3.36.0.json';
+export {default as latestSchemaJson} from './project-schema/v3.37.0.json';
 import metaSchemaV1_0_0 from './project-schema/meta-schema-v1.0.0.json';
 import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV3_0_0 from './project-schema/meta-schema-v3.0.0.json';
@@ -59,6 +59,7 @@ import projectSchemaV3_33_0 from './project-schema/v3.33.0.json';
 import projectSchemaV3_34_0 from './project-schema/v3.34.0.json';
 import projectSchemaV3_35_0 from './project-schema/v3.35.0.json';
 import projectSchemaV3_36_0 from './project-schema/v3.36.0.json';
+import projectSchemaV3_37_0 from './project-schema/v3.37.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
 export const allProjectSchemas = [
   metaSchemaV1_0_0,
@@ -118,5 +119,6 @@ export const allProjectSchemas = [
   projectSchemaV3_34_0,
   projectSchemaV3_35_0,
   projectSchemaV3_36_0,
+  projectSchemaV3_37_0,
   projectSchemaV4_0_0
 ];

package/es/schemas/project-schema/latest.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
-  "$id": "https://schema.takeshape.io/project-schema/v3.36.0#",
+  "$id": "https://schema.takeshape.io/project-schema/v3.37.0#",
   "title": "Project Schema JSON",
   "definitions": {
     "schemaArray": {
@@ -2796,6 +2796,80 @@
         }
       ]
     },
+    "serviceHealthCheck": {
+      "title": "Service Health Check",
+      "description": "Configuration for ping health checks.",
+      "type": "object",
+      "properties": {
+        "checkName": {
+          "title": "Check Name",
+          "description": "The name of a health check to run",
+          "type": "string",
+          "enum": [
+            "graphqlIntrospection",
+            "ping"
+          ]
+        },
+        "endpoint": {
+          "title": "Endpoint",
+          "description": "The endpoint to use when checking the service health.",
+          "type": "string"
+        },
+        "requestMethod": {
+          "title": "Request Method",
+          "description": "A custom method to use for the health check request.",
+          "type": "string",
+          "enum": [
+            "GET",
+            "POST",
+            "PUT",
+            "PATCH",
+            "DELETE"
+          ]
+        },
+        "requestHeaders": {
+          "title": "Request Headers",
+          "description": "Any custom headers to set with the health check request.",
+          "type": "object",
+          "propertyNames": {
+            "pattern": "[0-9A-Za-z_-]+"
+          }
+        },
+        "requestBody": {
+          "title": "Request Body",
+          "description": "A custom body to send along with the ping request.",
+          "type": "string"
+        },
+        "requestBodyFormat": {
+          "title": "Request Body Format",
+          "description": "A custom body to send along with the ping request.",
+          "type": "string",
+          "enum": [
+            "string",
+            "form",
+            "json"
+          ]
+        },
+        "requestTimeout": {
+          "title": "Request Timeout",
+          "description": "The amount of time to wait when receiving a response from the health check, in seconds.",
+          "type": "number",
+          "minimum": 2,
+          "maximum": 60
+        },
+        "healthyResponseStatusCode": {
+          "title": "Healthy Response Status Code",
+          "description": "The response status code that qualifies as healthy.",
+          "type": "number",
+          "minimum": 200,
+          "maximum": 399
+        }
+      },
+      "required": [
+        "checkName"
+      ],
+      "additionalProperties": false
+    },
     "serviceType": {
       "title": "Service Type",
       "description": "The general type of this service, specifying how and where it will be utilized.",
@@ -2851,6 +2925,9 @@
         "authentication": {
           "$ref": "#/definitions/serviceAuthentication"
         },
+        "healthCheck": {
+          "$ref": "#/definitions/serviceHealthCheck"
+        },
         "webhookId": {
           "type": "string"
         },
@@ -2908,6 +2985,9 @@
         "authentication": {
           "type": "string"
         },
+        "healthCheck": {
+          "$ref": "#/definitions/serviceHealthCheck"
+        },
         "webhookId": {
           "type": "string"
         },
@@ -3061,7 +3141,7 @@
     "schemaVersion": {
       "type": "string",
       "enum": [
-        "3.36.0"
+        "3.37.0"
       ],
       "description": "The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format."
     },