@takeshape/schema 9.38.0 → 9.40.0

package/es/schemas/project-schema.json

@@ -123,6 +123,9 @@
     {
       "$ref": "https://schema.takeshape.io/project-schema/v3.31.0#"
     },
+    {
+      "$ref": "https://schema.takeshape.io/project-schema/v3.32.0#"
+    },
     {
       "$ref": "https://schema.takeshape.io/project-schema/v4.0.0#"
     }

package/es/template-shapes/templates.js

@@ -2,7 +2,7 @@ import { TemplateVerbs } from './types';
 import { listTypePrefix } from '../migration';
 import { deepClone, pascalCase, visit } from '@takeshape/util';
 import keyBy from 'lodash/keyBy';
-import { createShape, getShapeDependencies, isIndexedRemoteShape } from '../schema-util';
+import { createShape, getShapeDependencies, isCachedShape } from '../schema-util';
 import { getFlattenedTemplateShapeName, getRef, getRefShapeName, refItemToAtRef, refItemToShapeName } from '../refs';
 import { getWhereSearchArg } from './where';
 import { mergeObjectSchemas, mergeSchemaProperties } from '../util';
@@ -389,7 +389,7 @@ export function getShapeListQueryArgs(templateName, legacyArgs) {
     } = context;
     const isAllShapes = shape.name === 'TSSearchable';
     const shapeName = isAllShapes ? templateName : getFlattenedTemplateShapeName(shape.name, templateName);
-    const shapes = isAllShapes ? Object.values(projectSchema.shapes).filter(s => s.model !== undefined || isIndexedRemoteShape(projectSchema, s)) : [shape];
+    const shapes = isAllShapes ? Object.values(projectSchema.shapes).filter(s => s.model !== undefined || isCachedShape(s)) : [shape];
     const {
       schema,
       dependencies

package/es/template-shapes/where.js

@@ -1,6 +1,6 @@
 import unset from 'lodash/unset';
 import isFunction from 'lodash/isFunction';
-import { createSchemaPropertyList, createShape, getAllRefsInShapes, isIndexedRemoteShape } from '../schema-util';
+import { createSchemaPropertyList, createShape, getAllRefsInShapes, isCachedShape } from '../schema-util';
 import uniqBy from 'lodash/uniqBy';
 import md5 from 'blueimp-md5';
 import { pascalCase, isDefined } from '@takeshape/util';
@@ -292,7 +292,7 @@ export function getFields(typeName, shapes, context) {
       name,
       prop,
       workflowsEnabled: workflowsEnabled(projectSchema.apiVersion),
-      isIndexedShape: isIndexedRemoteShape(projectSchema, shape),
+      isIndexedShape: isCachedShape(shape),
       exceededRelationshipDepth: exceededRelationshipDepth(relationshipDepth)
     })).getNodes();
 
@@ -332,7 +332,7 @@ export function getPropertyComparisonType(name, prop, shapeName, context) {
     name,
     prop,
     workflowsEnabled: workflowsEnabled(projectSchema.apiVersion),
-    isIndexedShape: isIndexedRemoteShape(projectSchema, projectSchema.shapes[shapeName]),
+    isIndexedShape: isCachedShape(projectSchema.shapes[shapeName]),
     exceededRelationshipDepth: exceededRelationshipDepth(relationshipDepth)
   })) {
     return undefined;

package/es/types/utils.js

@@ -8,6 +8,7 @@ import has from 'lodash/has';
 import { latestSchemaJson } from '../schemas';
 import satisfies from 'semver/functions/satisfies';
 import isUndefined from 'lodash/isUndefined';
+import { isCachedShape } from '../schema-util';
 /** Resolver Type Utils **/
 
 /**
@@ -279,4 +280,18 @@ export function isPropertySchemaWithRelationship(schema) {
   var _schema$Resolver;
 
   return ((_schema$Resolver = schema['@resolver']) === null || _schema$Resolver === void 0 ? void 0 : _schema$Resolver.name) === 'shapedb:getRelated';
+}
+export function listCachedShapes(shapes) {
+  return Object.values(shapes).filter(isCachedShape);
+}
+export function getCachedShapeMap(shapes) {
+  const results = {};
+
+  for (const shape of Object.values(shapes)) {
+    if (isCachedShape(shape)) {
+      results[shape.name] = shape;
+    }
+  }
+
+  return results;
 }

package/es/util/api-indexing.js

@@ -1,17 +1,22 @@
 import { isServiceResolver } from '../types';
 import { ensureArray } from '@takeshape/util';
 import { getResolverServices } from '../services';
+import { isCachedShape } from '../schema-util';
+import { getQuery } from '../refs';
 export function serviceHasIndexedShapes(schema, serviceId) {
-  for (const config of Object.values(schema.indexedShapes ?? {})) {
-    const listConfigs = config.queries.list;
+  for (const shape of Object.values(schema.shapes ?? {})) {
+    var _shape$loaders;
 
-    if (listConfigs) {
+    const indexingEnabled = isCachedShape(shape);
+    const listConfigs = (_shape$loaders = shape.loaders) === null || _shape$loaders === void 0 ? void 0 : _shape$loaders.list;
+
+    if (indexingEnabled && listConfigs) {
       for (const {
-        name: queryName
+        query: queryRef
       } of ensureArray(listConfigs)) {
-        const query = queryName && schema.queries[queryName];
+        const resolved = getQuery(schema, queryRef);
 
-        if (query && isServiceResolver(query.resolver) && query.resolver.service === serviceId) {
+        if (resolved && isServiceResolver(resolved.query.resolver) && resolved.query.resolver.service === serviceId) {
           return true;
         }
       }
@@ -22,9 +27,8 @@ export function serviceHasIndexedShapes(schema, serviceId) {
 }
 export function getIndexedServices(projectSchema, configs) {
   return ensureArray(configs).reduce((services, queryConfig) => {
-    const queryName = queryConfig === null || queryConfig === void 0 ? void 0 : queryConfig.name;
-    const query = queryName && projectSchema.queries[queryName];
-    return query ? [...services, ...getResolverServices(query.resolver)] : services;
+    const resolved = queryConfig !== null && queryConfig !== void 0 && queryConfig.query ? getQuery(projectSchema, queryConfig.query) : undefined;
+    return resolved !== null && resolved !== void 0 && resolved.query ? [...services, ...getResolverServices(resolved.query.resolver)] : services;
   }, []);
 }
 
@@ -38,27 +42,30 @@ function flattenListQueryConfigs(base, queryConfig, maybeConfigArray) {
 
 function getQueryIndexConfigHelper(op) {
   return ({
-    indexedShapes
+    shapes
   }, shapeName) => {
-    const indexingConfig = indexedShapes === null || indexedShapes === void 0 ? void 0 : indexedShapes[shapeName];
+    const {
+      cache,
+      loaders
+    } = shapes[shapeName] ?? {};
 
-    if (indexingConfig) {
-      const idField = indexingConfig.idField ?? 'id';
+    if (cache && loaders) {
+      const idField = cache.idField ?? 'id';
 
       if (op === 'list') {
         return flattenListQueryConfigs({
           shapeName,
           idField
-        }, indexingConfig.query, indexingConfig.queries.list);
+        }, cache.fragment, loaders.list);
       }
 
-      const queryConfig = indexingConfig.queries.get;
+      const queryConfig = loaders.get;
 
       if (queryConfig) {
         return {
           idField,
           shapeName,
-          ...indexingConfig.query,
+          ...cache.fragment,
           ...queryConfig
         };
       }

package/es/util/merge.js

@@ -104,7 +104,7 @@ export function mergeFormConfigs(...configs) {
     order: []
   });
 }
-const mergeableSections = ['shapes', 'mutations', 'queries', 'forms', 'services', 'indexedShapes'];
+const mergeableSections = ['shapes', 'mutations', 'queries', 'forms', 'services'];
 
 const isMergeableSection = str => {
   return mergeableSections.includes(str);

package/es/util/patch-schema.js

@@ -1,6 +1,6 @@
 import forIn from 'lodash/forIn';
 import omit from 'lodash/omit';
-const schemaUpdateMergedKeys = ['queries', 'mutations', 'shapes', 'workflows', 'forms', 'services', 'indexedShapes'];
+const schemaUpdateMergedKeys = ['queries', 'mutations', 'shapes', 'workflows', 'forms', 'services'];
 export function shallowMerge(original, update) {
   const result = { ...original
   };

package/es/validate.js

@@ -29,6 +29,7 @@ import last from 'lodash/last';
 import { getRelationship } from './relationships';
 import get from 'lodash/get';
 import gte from 'semver/functions/gte';
+import lte from 'semver/functions/lte';
 import size from 'lodash/size';
 import isEqual from 'lodash/isEqual';
 import pick from 'lodash/pick';
@@ -208,10 +209,24 @@ function validateResolver(projectSchema, basePath, baseResolver) {
   };
 
   const isValidShapeName = shapeName => {
-    var _indexedShapes;
+    var _indexedShapes, _modernShape$cache;
 
-    const modelShape = shapeName ? projectSchema.shapes[shapeName] : undefined;
-    return Boolean((modelShape === null || modelShape === void 0 ? void 0 : modelShape.model) || shapeName && ((_indexedShapes = projectSchema.indexedShapes) === null || _indexedShapes === void 0 ? void 0 : _indexedShapes[shapeName]));
+    if (!shapeName) {
+      return false;
+    }
+
+    const shape = projectSchema.shapes[shapeName];
+
+    if (shape !== null && shape !== void 0 && shape.model) {
+      return true;
+    }
+
+    if ((_indexedShapes = projectSchema.indexedShapes) !== null && _indexedShapes !== void 0 && _indexedShapes[shapeName]) {
+      return true;
+    }
+
+    const modernShape = shape;
+    return Boolean((modernShape === null || modernShape === void 0 ? void 0 : (_modernShape$cache = modernShape.cache) === null || _modernShape$cache === void 0 ? void 0 : _modernShape$cache.enabled) && modernShape.loaders);
   };
 
   const delegateResolverMissingConfig = (parsed, resolver) => {
@@ -443,6 +458,49 @@ function validateIndexedShapeConfig(projectSchema, shapeName, config) {
   return errors;
 }
 
+function validateShapeLoaders(projectSchema, shape) {
+  const errors = [];
+
+  if ('loaders' in shape) {
+    var _loaders, _loaders2;
+
+    const getNamespace = createGetNamespace(projectSchema);
+    const listLoader = (_loaders = shape.loaders) === null || _loaders === void 0 ? void 0 : _loaders.list;
+
+    if (listLoader) {
+      ensureArray(listLoader).forEach((config, i) => {
+        const ref = parsePropertyRef(config.query);
+        const query = ref && get(projectSchema, propertyRefItemToPath(getNamespace, ref));
+
+        if (!query) {
+          errors.push({
+            path: Array.isArray(listLoader) ? ['shapes', shape.name, 'loaders', 'list', i, 'query'] : ['shapes', shape.name, 'loaders', 'list', 'query'],
+            type: 'notFound',
+            message: `Invalid query "${config.query}"`
+          });
+        }
+      });
+    }
+
+    const getLoader = (_loaders2 = shape.loaders) === null || _loaders2 === void 0 ? void 0 : _loaders2.get;
+
+    if (getLoader) {
+      const ref = parsePropertyRef(getLoader.query);
+      const query = ref && get(projectSchema, propertyRefItemToPath(getNamespace, ref));
+
+      if (!query) {
+        errors.push({
+          path: ['shapes', shape.name, 'loaders', 'get', 'query'],
+          type: 'notFound',
+          message: `Invalid query "${getLoader.query}"`
+        });
+      }
+    }
+  }
+
+  return errors;
+}
+
 function visitProperties(projectSchema, callback) {
   JSONPath('$..properties.*', projectSchema, (property, _type, {
     path: propertyPath
@@ -452,50 +510,57 @@ function visitProperties(projectSchema, callback) {
 }
 
 function validateIndexedShapes(projectSchema) {
-  let errors = [];
+  const errors = [];
+  const version = getSemver(projectSchema.schemaVersion);
 
-  if (gt(getSemver(projectSchema.schemaVersion), '3.12.0')) {
+  if (gt(version, '3.12.0') && lte(version, '3.31.0')) {
     const {
       indexedShapes
     } = projectSchema;
 
     if (indexedShapes) {
       forOwn(indexedShapes, (config, shapeName) => {
-        errors = errors.concat(validateIndexedShapeConfig(projectSchema, shapeName, config));
+        errors.push(...validateIndexedShapeConfig(projectSchema, shapeName, config));
       });
     }
-  }
-
-  if (gt(getSemver(projectSchema.schemaVersion), '3.26.0')) {
+  } else if (gt(version, '3.31.0')) {
     const {
-      indexedShapes
+      shapes
     } = projectSchema;
 
-    if (indexedShapes) {
-      let nestedCount = 0;
-      visitProperties(projectSchema, (property, propertyPath) => {
-        const indexed = property['@indexed'];
+    for (const shape of Object.values(shapes)) {
+      const newErrors = validateShapeLoaders(projectSchema, shape);
 
-        if (isRecord(indexed) && indexed.nested) {
-          nestedCount += 1;
+      if (newErrors.length) {
+        errors.push(...newErrors);
+      }
+    }
+  }
 
-          if (property.type !== 'array') {
-            errors.push({
-              path: propertyPath,
-              type: 'location',
-              message: 'Nested indexes may only appear next to fields of type: "array"'
-            });
-          }
-        }
-      });
+  if (gt(version, '3.26.0')) {
+    let nestedCount = 0;
+    visitProperties(projectSchema, (property, propertyPath) => {
+      const indexed = property['@indexed'];
 
-      if (nestedCount > 50) {
-        errors.push({
-          path: ['shapes'],
-          type: 'tooMany',
-          message: `${nestedCount} nested indexes found`
-        });
+      if (isRecord(indexed) && indexed.nested) {
+        nestedCount += 1;
+
+        if (property.type !== 'array') {
+          errors.push({
+            path: propertyPath,
+            type: 'location',
+            message: 'Nested indexes may only appear next to fields of type: "array"'
+          });
+        }
       }
+    });
+
+    if (nestedCount > 50) {
+      errors.push({
+        path: ['shapes'],
+        type: 'tooMany',
+        message: `${nestedCount} nested indexes found`
+      });
     }
   }
 

package/examples/latest/betzino.json

@@ -52525,6 +52525,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/blog-schema.json

@@ -399,6 +399,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/brewery-schema.json

@@ -382,6 +382,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/complex-project-schema.json

@@ -4185,6 +4185,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/complex-schema.json

@@ -15,7 +15,7 @@
   "apiVersion": "1",
   "queries": {},
   "mutations": {},
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "shapes": {
     "DocumentUploadForm": {
       "id": "HJPFlRKkr",

package/examples/latest/fabric-ecommerce.json

@@ -10505,5 +10505,5 @@
       }
     }
   },
-  "schemaVersion": "3.31.0"
+  "schemaVersion": "3.32.0"
 }

package/examples/latest/frank-and-fred-schema.json

@@ -23251,6 +23251,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/klirr-schema.json

@@ -34786,6 +34786,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/massive-schema.json

@@ -7837,6 +7837,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/mill-components-schema.json

@@ -1884,6 +1884,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/one-earth.json

@@ -14216,6 +14216,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/pet-oneof-array.json

@@ -388,6 +388,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/post-schema.json

@@ -226,6 +226,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/pruned-shopify-product-schema.json

@@ -9756,5 +9756,5 @@
       }
     }
   },
-  "schemaVersion": "3.31.0"
+  "schemaVersion": "3.32.0"
 }

package/examples/latest/real-world-schema.json

@@ -1041,6 +1041,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/recursive-repeater-schema.json

@@ -142,6 +142,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/recursive-schema.json

@@ -149,6 +149,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/rick-and-morty-ast.json

@@ -2820,5 +2820,5 @@
       }
     }
   },
-  "schemaVersion": "3.31.0"
+  "schemaVersion": "3.32.0"
 }

package/examples/latest/rick-and-morty-graphql.json

@@ -2292,5 +2292,5 @@
       }
     }
   },
-  "schemaVersion": "3.31.0"
+  "schemaVersion": "3.32.0"
 }

package/examples/latest/rick-and-morty-rest.json

@@ -91,5 +91,5 @@
       }
     }
   },
-  "schemaVersion": "3.31.0"
+  "schemaVersion": "3.32.0"
 }

package/examples/latest/schema-with-repeater-draftjs.json

@@ -397,6 +397,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/shape-books-v3_2_0.json

@@ -1124,6 +1124,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/shape-books.json

@@ -1124,6 +1124,6 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "services": {}
 }

package/examples/latest/shopify-lookbook.json

@@ -1177,5 +1177,5 @@
       }
     }
   },
-  "schemaVersion": "3.31.0"
+  "schemaVersion": "3.32.0"
 }

package/examples/latest/shopify-product-2022-07.json

@@ -5,7 +5,7 @@
     "en-us"
   ],
   "apiVersion": "2",
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "queries": {
     "getAsset": {
       "shape": "Asset",

package/examples/latest/shopify-product-2023-04.json

@@ -49336,7 +49336,7 @@
       }
     }
   },
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "apiVersion": "2",
   "services": {
     "shopify": {

package/examples/latest/shopify-store-with-widget.json

@@ -12560,5 +12560,5 @@
       }
     }
   },
-  "schemaVersion": "3.31.0"
+  "schemaVersion": "3.32.0"
 }

package/examples/latest/stripe-product-runtime-schema.json

@@ -5,7 +5,7 @@
     "en-us"
   ],
   "apiVersion": "2",
-  "schemaVersion": "3.31.0",
+  "schemaVersion": "3.32.0",
   "queries": {
     "getAsset": {
       "shape": "Asset",
@@ -948,6 +948,27 @@
             "type": "string"
           }
         }
+      },
+      "loaders": {
+        "list": {
+          "query": "Stripe_listProducts"
+        },
+        "get": {
+          "query": "Stripe_getProduct"
+        }
+      },
+      "cache": {
+        "enabled": true,
+        "fragment": {
+          "maxDepth": 1
+        },
+        "triggers": [
+          {
+            "type": "schedule",
+            "interval": 1440,
+            "loader": "list"
+          }
+        ]
       }
     },
     "WrappedString": {
@@ -4394,27 +4415,5 @@
         "useRestfulNames": true
       }
     }
-  },
-  "indexedShapes": {
-    "Stripe_Product": {
-      "queries": {
-        "list": {
-          "name": "Stripe_listProducts"
-        },
-        "get": {
-          "name": "Stripe_getProduct"
-        }
-      },
-      "triggers": [
-        {
-          "type": "schedule",
-          "query": "list",
-          "interval": 1440
-        }
-      ],
-      "query": {
-        "maxDepth": 1
-      }
-    }
   }
 }