@takeshape/schema 8.20.1 → 8.20.2

package/es/schemas/project-schema/v4.0.0.json

@@ -3,6 +3,7 @@
   "$id": "https://schema.takeshape.io/project-schema/v4.0.0#",
   "definitions": {
     "schemaArray": {
+      "title": "Schema Array",
       "type": "array",
       "minItems": 1,
       "items": {
@@ -10,10 +11,12 @@
       }
     },
     "nonNegativeInteger": {
+      "title": "Non Negative Integer",
       "type": "integer",
       "minimum": 0
     },
     "nonNegativeIntegerDefault0": {
+      "title": "Non Negative Integer Default 0",
       "allOf": [
         {
           "$ref": "#/definitions/nonNegativeInteger"
@@ -24,9 +27,11 @@
       ]
     },
     "simpleTypes": {
+      "title": "Simple Types",
       "enum": ["array", "boolean", "integer", "null", "number", "object", "string"]
     },
     "stringArray": {
+      "title": "String Array",
       "type": "array",
       "items": {
         "type": "string"
@@ -57,6 +62,7 @@
       "additionalProperties": false
     },
     "mappingString": {
+      "title": "Mapping String",
       "type": "string",
       "pattern": "^[\\w-]+(?::[\\w-]+)+(?:\\.[\\w-]+)+$"
     },
@@ -79,7 +85,7 @@
       "type": "object",
       "properties": {
         "@ref": {
-          "$ref": "#/definitions/ref"
+          "type": "string"
         }
       },
       "required": ["@ref"]
@@ -89,7 +95,7 @@
       "type": "object",
       "properties": {
         "$ref": {
-          "$ref": "#/definitions/ref"
+          "type": "string"
         }
       },
       "required": ["$ref"]
@@ -1220,10 +1226,6 @@
       "title": "Resolver",
       "oneOf": [{"$ref": "#/definitions/basicResolver"}, {"$ref": "#/definitions/composeResolver"}]
     },
-    "ref": {
-      "title": "Ref",
-      "type": "string"
-    },
     "query": {
       "title": "Query",
       "type": "object",

package/es/schemas/project-schema.json

@@ -14,6 +14,7 @@
     {"$ref": "https://schema.takeshape.io/project-schema/v3.6.0#"},
     {"$ref": "https://schema.takeshape.io/project-schema/v3.7.0#"},
     {"$ref": "https://schema.takeshape.io/project-schema/v3.8.0#"},
-    {"$ref": "https://schema.takeshape.io/project-schema/v3.9.0#"}
+    {"$ref": "https://schema.takeshape.io/project-schema/v3.9.0#"},
+    {"$ref": "https://schema.takeshape.io/project-schema/v3.10.0#"}
   ]
 }

package/es/types/types.js

@@ -18,7 +18,7 @@
  */
 export let RefType;
 /**
- * Stub of a ContentSchema that may contain a `$ref` or `@ref`.
+ * Stub of a PropertySchema that may contain a `$ref` or `@ref`.
  */
 
 (function (RefType) {

package/es/types/utils.js

@@ -6,7 +6,7 @@ import isPlainObject from 'lodash/isPlainObject';
 import isString from 'lodash/isString';
 import isArray from 'lodash/isArray';
 import has from 'lodash/has';
-import { CURRENT_SCHEMA_VERSION, latestMetaSchemaJson } from '../schemas';
+import { CURRENT_SCHEMA_VERSION, latestSchemaJson } from '../schemas';
 import satisfies from 'semver/functions/satisfies';
 /** Resolver Type Utils **/
 
@@ -28,7 +28,7 @@ const {
     restResolver,
     awsLambdaResolver
   }
-} = latestMetaSchemaJson;
+} = latestSchemaJson;
 export function isTakeshapeResolver(resolver) {
   return takeshapeResolver.properties.name.enum.includes(resolver.name);
 }
@@ -67,6 +67,7 @@ export const isProjectSchemaV3_6 = createVersionPredicate('3.6.0');
 export const isProjectSchemaV3_7 = createVersionPredicate('3.7.0');
 export const isProjectSchemaV3_8 = createVersionPredicate('3.8.0');
 export const isProjectSchemaV3_9 = createVersionPredicate('3.9.0');
+export const isProjectSchemaV3_10 = createVersionPredicate('3.10.0');
 export const isLatestProjectSchema = createVersionPredicate(CURRENT_SCHEMA_VERSION);
 export function isV3XSchema(maybeSchema) {
   if (!isObject(maybeSchema) || !isString(maybeSchema.projectId) || !isString(maybeSchema.schemaVersion)) {
@@ -86,7 +87,7 @@ export function isAnyProjectSchema(value) {
   }
 
   const maybeSchema = value;
-  return isObject(value) && isString(maybeSchema.projectId) && (isProjectSchemaV1(maybeSchema) || isProjectSchemaV3(maybeSchema) || isProjectSchemaV3_1(maybeSchema) || isProjectSchemaV3_2(maybeSchema) || isProjectSchemaV3_3(maybeSchema) || isProjectSchemaV3_4(maybeSchema) || isProjectSchemaV3_5(maybeSchema) || isProjectSchemaV3_5_1(maybeSchema) || isProjectSchemaV3_6(maybeSchema) || isProjectSchemaV3_7(maybeSchema) || isProjectSchemaV3_8(maybeSchema) || isProjectSchemaV3_9(maybeSchema));
+  return isObject(value) && isString(maybeSchema.projectId) && (isProjectSchemaV1(maybeSchema) || isProjectSchemaV3(maybeSchema) || isProjectSchemaV3_1(maybeSchema) || isProjectSchemaV3_2(maybeSchema) || isProjectSchemaV3_3(maybeSchema) || isProjectSchemaV3_4(maybeSchema) || isProjectSchemaV3_5(maybeSchema) || isProjectSchemaV3_5_1(maybeSchema) || isProjectSchemaV3_6(maybeSchema) || isProjectSchemaV3_7(maybeSchema) || isProjectSchemaV3_8(maybeSchema) || isProjectSchemaV3_9(maybeSchema) || isProjectSchemaV3_10(maybeSchema));
 }
 export function isProjectSchemaWithServices(schema) {
   return typeof schema.dataKey !== 'undefined' && typeof schema.services !== 'undefined';
@@ -173,7 +174,7 @@ const {
     parameterSerializeStyleOptionsForSearchParams,
     parameterSerializeStyleOptionsForPathParams
   }
-} = latestMetaSchemaJson;
+} = latestSchemaJson;
 export function isParameterSerializeStyleForSearchParams(maybeParam) {
   return Boolean(maybeParam && parameterSerializeStyleOptionsForSearchParams.properties.style.enum.includes(maybeParam));
 }
@@ -189,23 +190,26 @@ export function isParameterSerializeStyleOptions(maybeStyle) {
 }
 /** Typeguards for different types of shape schemas **/
 
-export function isRefSchema(maybeRefSchema) {
-  return isString(maybeRefSchema['@ref']) || isString(maybeRefSchema.$ref);
+export function isRefSchema(propertySchema) {
+  return isString(propertySchema['@ref']) || isString(propertySchema.$ref);
 }
-export function isRefSchemaLegacy(maybeRefSchema) {
-  return isString(maybeRefSchema.$ref);
+export function isRefSchemaLegacy(propertySchema) {
+  return isString(propertySchema.$ref);
 }
-export function isAllOfSchema(maybeExtendableSchema) {
-  return isArray(maybeExtendableSchema.allOf);
+export function isAllOfSchema(propertySchema) {
+  return isArray(propertySchema.allOf);
 }
-export function isOneOfSchema(maybeExclusiveOrSchema) {
-  return isArray(maybeExclusiveOrSchema.oneOf);
+export function isOneOfSchema(propertySchema) {
+  return isArray(propertySchema.oneOf);
 }
-export function isArraySchema(maybeArraySchema) {
-  return maybeArraySchema.type === 'array' && isObject(maybeArraySchema.items);
+export function isEnumSchema(obj) {
+  return isArray(obj.enum);
 }
-export function isObjectSchema(maybeObjectSchema) {
-  return maybeObjectSchema.type === 'object' && isObject(maybeObjectSchema.properties);
+export function isArraySchema(propertySchema) {
+  return propertySchema.type === 'array' && isObject(propertySchema.items);
+}
+export function isObjectSchema(propertySchema) {
+  return propertySchema.type === 'object' && isObject(propertySchema.properties);
 }
 /** Service Config Utils **/
 
@@ -274,9 +278,6 @@ export const getArgsType = argsSchema => {
     return ArgsType.args;
   }
 };
-export function isContentObjectSchema(maybeSchema) {
-  return isRefSchema(maybeSchema) || isAllOfSchema(maybeSchema) || isObjectSchema(maybeSchema);
-}
 /**
  * A utility to return the type of ref present on a schema.
  *

package/es/util/detect-cycles.js

@@ -27,7 +27,7 @@ export function hasCycle(projectSchema, schema, shapesSeen = new Set()) {
     return hasCycle(projectSchema, refShape.schema, immutableSetAdd(shapesSeen, refShape.name));
   }
 
-  const combo = schema.oneOf ?? schema.allOf ?? schema.anyOf;
+  const combo = schema.oneOf ?? schema.allOf;
 
   if (combo) {
     return combo.some(childSchema => hasCycle(projectSchema, childSchema, shapesSeen));

package/es/validate.js

@@ -16,7 +16,7 @@ import { isBasicResolver, isComposeResolver } from './types/utils';
 import { refItemToAtRef, refItemToShapeName } from './refs';
 import { scalars } from './scalars';
 import { enumerateOneOfKeys, isUnionSchema } from './unions';
-import { isEnumSchema } from './enum';
+import { isEnumLikeSchema } from './enum';
 import metaSchemaV3_9_0 from './schemas/project-schema/meta-schema-v3.9.0.json';
 
 function findDuplicates(items) {
@@ -331,8 +331,10 @@ function validateRefs(projectSchema, additionalShapeNames = builtInShapeNames) {
 }
 
 function validateDirectives(projectSchema, additionalShapeIds = builtInModelShapeIds) {
-  const errors = [];
-  const projectShapeIds = new Set([...getModelShapeIds(projectSchema.shapes), ...additionalShapeIds]);
+  const errors = []; // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+
+  const projectShapeIds = new Set([...getModelShapeIds(projectSchema.shapes), ...additionalShapeIds]); // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+
   visitShapeProperties(projectSchema.shapes, (schema, path) => {
     if (schema['@relationship']) {
       var _schema$Relationship;
@@ -364,7 +366,8 @@ function validateDirectives(projectSchema, additionalShapeIds = builtInModelShap
 }
 
 function validateOneOfs(projectSchema) {
-  const errors = [];
+  const errors = []; // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
+
   visitShapeProperties(projectSchema.shapes, (schema, path) => {
     const oneOfPath = schema.items ? ['items', 'oneOf'] : ['oneOf'];
     schema = schema.items ? schema.items : schema;
@@ -381,7 +384,7 @@ function validateOneOfs(projectSchema) {
             message: `Invalid refs to ${shapeNames}. oneOf unions cannot reference model shapes. Use @relationship instead`
           });
         }
-      } else if (!isEnumSchema(schema)) {
+      } else if (!isEnumLikeSchema(schema)) {
         errors.push({
           type: 'json',
           path: path.concat(oneOfPath),

package/examples/latest/blog-schema.json

@@ -10,6 +10,37 @@
   "apiVersion": "2",
   "author": "<userId>",
   "workflows": {},
+  "created": "2016-06-21T15:16:19.051Z",
+  "updated": "2016-06-21T15:16:19.051Z",
+  "forms": {
+    "Homepage": {
+      "default": {
+        "order": [
+          "headline",
+          "hero"
+        ]
+      }
+    },
+    "Post": {
+      "default": {
+        "order": [
+          "title",
+          "body",
+          "rating",
+          "otherStuff",
+          "tags"
+        ]
+      }
+    },
+    "Tag": {
+      "default": {
+        "order": [
+          "name"
+        ]
+      }
+    }
+  },
+  "dataKey": "supersecret",
   "queries": {
     "getHomepage": {
       "shape": "Homepage",
@@ -154,9 +185,6 @@
       "args": "DeleteArgs<Tag>"
     }
   },
-  "schemaVersion": "3.9.0",
-  "created": "2016-06-21T15:16:19.051Z",
-  "updated": "2016-06-21T15:16:19.051Z",
   "shapes": {
     "Homepage": {
       "id": "<homepageContentTypeId>",
@@ -345,33 +373,5 @@
       }
     }
   },
-  "forms": {
-    "Homepage": {
-      "default": {
-        "order": [
-          "headline",
-          "hero"
-        ]
-      }
-    },
-    "Post": {
-      "default": {
-        "order": [
-          "title",
-          "body",
-          "rating",
-          "otherStuff",
-          "tags"
-        ]
-      }
-    },
-    "Tag": {
-      "default": {
-        "order": [
-          "name"
-        ]
-      }
-    }
-  },
-  "dataKey": "supersecret"
+  "schemaVersion": "3.10.0"
 }

package/examples/latest/brewery-schema.json

@@ -9,6 +9,58 @@
     "en-us"
   ],
   "workflows": {},
+  "created": "2016-06-21T15:16:19.051Z",
+  "updated": "2016-06-21T15:16:19.051Z",
+  "forms": {
+    "Brewery": {
+      "default": {
+        "properties": {
+          "name": {
+            "widget": "singleLineText"
+          },
+          "addresses": {
+            "properties": {
+              "image": {
+                "widget": "image"
+              },
+              "zipCode": {
+                "widget": "singleLineText"
+              },
+              "state": {
+                "widget": "singleLineText"
+              },
+              "city": {
+                "widget": "singleLineText"
+              },
+              "street": {
+                "widget": "singleLineText"
+              }
+            },
+            "widget": "repeater",
+            "order": [
+              "image",
+              "street",
+              "city",
+              "state",
+              "zipCode"
+            ]
+          }
+        },
+        "order": [
+          "name",
+          "addresses"
+        ]
+      }
+    },
+    "Asset": {
+      "default": {
+        "order": [
+          "title"
+        ]
+      }
+    }
+  },
+  "dataKey": "supersecret",
   "queries": {
     "getBrewery": {
       "shape": "Brewery",
@@ -133,9 +185,6 @@
       "args": "DeleteArgs<Asset>"
     }
   },
-  "schemaVersion": "3.9.0",
-  "created": "2016-06-21T15:16:19.051Z",
-  "updated": "2016-06-21T15:16:19.051Z",
   "shapes": {
     "Brewery": {
       "id": "BREWERY",
@@ -329,54 +378,5 @@
       }
     }
   },
-  "forms": {
-    "Brewery": {
-      "default": {
-        "properties": {
-          "name": {
-            "widget": "singleLineText"
-          },
-          "addresses": {
-            "properties": {
-              "image": {
-                "widget": "image"
-              },
-              "zipCode": {
-                "widget": "singleLineText"
-              },
-              "state": {
-                "widget": "singleLineText"
-              },
-              "city": {
-                "widget": "singleLineText"
-              },
-              "street": {
-                "widget": "singleLineText"
-              }
-            },
-            "widget": "repeater",
-            "order": [
-              "image",
-              "street",
-              "city",
-              "state",
-              "zipCode"
-            ]
-          }
-        },
-        "order": [
-          "name",
-          "addresses"
-        ]
-      }
-    },
-    "Asset": {
-      "default": {
-        "order": [
-          "title"
-        ]
-      }
-    }
-  },
-  "dataKey": "supersecret"
+  "schemaVersion": "3.10.0"
 }