@takeshape/schema 8.59.3 → 8.61.0

package/es/index.js

@@ -23,4 +23,5 @@ export * from './enum';
 export * from './patterns';
 export * from './types/types';
 export * from './types/utils';
-export * from './flatten-templates';
+export * from './flatten-templates';
+export * from './relationships';

package/es/migration/index.js

@@ -1,4 +1,4 @@
-import { isLatestProjectSchema, isProjectSchemaV1, isProjectSchemaV3, isProjectSchemaV3_1, isProjectSchemaV3_2, isProjectSchemaV3_3, isProjectSchemaV3_4, isProjectSchemaV3_5, isProjectSchemaV3_5_1, isProjectSchemaV3_6, isProjectSchemaV3_7, isProjectSchemaV3_8, isProjectSchemaV3_9, isProjectSchemaV3_10, isProjectSchemaV3_11, isProjectSchemaV3_12, isProjectSchemaV3_12_1 } from '../types/utils';
+import { isLatestProjectSchema, isProjectSchemaV1, isProjectSchemaV3, isProjectSchemaV3_1, isProjectSchemaV3_2, isProjectSchemaV3_3, isProjectSchemaV3_4, isProjectSchemaV3_5, isProjectSchemaV3_5_1, isProjectSchemaV3_6, isProjectSchemaV3_7, isProjectSchemaV3_8, isProjectSchemaV3_9, isProjectSchemaV3_10, isProjectSchemaV3_11, isProjectSchemaV3_12, isProjectSchemaV3_12_1, isProjectSchemaV3_12_2, isProjectSchemaV3_12_3 } from '../types/utils';
 import migrateToV3 from './to/v3.0.0';
 import migrateToV3_1 from './to/v3.1.0';
 import migrateToV3_2 from './to/v3.2.0';
@@ -15,6 +15,8 @@ import migrateToV3_11_0 from './to/v3.11.0';
 import migrateToV3_12_0 from './to/v3.12.0';
 import migrateToV3_12_1 from './to/v3.12.1';
 import migrateToV3_12_2 from './to/v3.12.2';
+import migrateToV3_12_3 from './to/v3.12.3';
+import migrateToV3_13_0 from './to/v3.13.0';
 export * from './utils';
 export const listTypePrefix = 'PaginatedList';
 export async function migrateToLatestProjectSchema(context, projectSchema) {
@@ -86,6 +88,14 @@ export async function migrateToLatestProjectSchema(context, projectSchema) {
     projectSchema = migrateToV3_12_2(projectSchema);
   }
 
+  if (isProjectSchemaV3_12_2(projectSchema)) {
+    projectSchema = migrateToV3_12_3(projectSchema);
+  }
+
+  if (isProjectSchemaV3_12_3(projectSchema)) {
+    projectSchema = migrateToV3_13_0(projectSchema);
+  }
+
   return projectSchema;
 }
 export async function ensureLatest(context, schema) {

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

@@ -2,7 +2,7 @@ import forEach from 'lodash/forEach';
 import pick from 'lodash/pick';
 import { pascalCase, deepClone } from '@takeshape/util';
 import { arraySchemaKeys, getShapeQueriesAndMutations, multipleRelationshipSchemaKeys, objectSchemaKeys, scalarSchemaKeys, schemaMetadataKeys } from '../../schema-util';
-import { formatDate, getRelationshipSchema } from '../utils';
+import { formatDate } from '../utils';
 const annotationMap = {
   l10n: '@l10n',
   sensitive: '@sensitive',
@@ -27,6 +27,24 @@ function getModelType(contentType) {
   }
 
   return 'multiple';
+}
+
+function getRelationshipSchema(relationship) {
+  const itemSchema = {
+    $ref: '#/shapes/TSRelationship/schema'
+  };
+
+  if (relationship.type === 'multiple') {
+    return {
+      type: 'array',
+      items: itemSchema,
+      '@relationship': relationship
+    };
+  }
+
+  return { ...itemSchema,
+    '@relationship': relationship
+  };
 } // eslint-disable-next-line complexity
 
 

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

@@ -0,0 +1,81 @@
+import omit from 'lodash/omit';
+
+function hasWebhook(projectSchema, config) {
+  var _config$queries, _config$queries$singl, _projectSchema$querie, _projectSchema$servic;
+
+  const queryName = (_config$queries = config.queries) === null || _config$queries === void 0 ? void 0 : (_config$queries$singl = _config$queries.single) === null || _config$queries$singl === void 0 ? void 0 : _config$queries$singl.name;
+
+  if (!queryName) {
+    return false;
+  }
+
+  const resolver = projectSchema === null || projectSchema === void 0 ? void 0 : (_projectSchema$querie = projectSchema.queries[queryName]) === null || _projectSchema$querie === void 0 ? void 0 : _projectSchema$querie.resolver;
+  return resolver && 'service' in resolver && (projectSchema === null || projectSchema === void 0 ? void 0 : (_projectSchema$servic = projectSchema.services) === null || _projectSchema$servic === void 0 ? void 0 : _projectSchema$servic[resolver.service].provider) === 'shopify';
+}
+
+function migrateToV3_12_3({
+  indexedShapes: oldIndexedShapes,
+  ...projectSchema
+}) {
+  if (!oldIndexedShapes) {
+    return { ...projectSchema,
+      schemaVersion: '3.12.3'
+    };
+  }
+
+  const indexedShapes = Object.fromEntries(Object.entries(oldIndexedShapes).map(([shapeName, config]) => {
+    var _config$queries$all;
+
+    const queries = {};
+    const triggers = [];
+
+    if (!config.queries) {
+      return [shapeName, { ...config,
+        queries,
+        triggers
+      }];
+    }
+
+    if (hasWebhook(projectSchema, config)) {
+      queries.get = config.queries.single;
+      triggers.push({
+        type: 'webhook',
+        query: 'get',
+        service: 'shopify',
+        events: ['products/create', 'products/update', 'products/delete']
+      });
+    }
+
+    const oldPagination = (_config$queries$all = config.queries.all) === null || _config$queries$all === void 0 ? void 0 : _config$queries$all.pagination;
+    const pagination = oldPagination === undefined ? undefined : oldPagination.type === 'cursor' ? { ...oldPagination,
+      itemsToIndexPath: oldPagination.itemsPath,
+      pageSize: oldPagination.size,
+      pageSizeArg: oldPagination.sizeArg
+    } : oldPagination.type === 'offset' ? { ...oldPagination,
+      itemsToIndexPath: oldPagination.itemsPath,
+      itemTotalPath: oldPagination.totalPath,
+      offsetArg: oldPagination.offsetParam
+    } : { ...oldPagination,
+      itemsToIndexPath: oldPagination.itemsPath,
+      pageTotalPath: oldPagination.totalPagesPath
+    };
+    queries.list = pagination ? { ...omit(config.queries.all, 'interval'),
+      pagination
+    } : omit(config.queries.all, 'interval', 'pagination');
+    triggers.push({
+      type: 'schedule',
+      query: 'list',
+      interval: config.queries.all.interval ?? 60 * 24
+    });
+    return [shapeName, { ...config,
+      queries,
+      triggers
+    }];
+  }));
+  return { ...projectSchema,
+    schemaVersion: '3.12.3',
+    indexedShapes
+  };
+}
+
+export default migrateToV3_12_3;

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

@@ -0,0 +1,21 @@
+import { visit } from '@takeshape/util';
+import get from 'lodash/get';
+
+function migrateToV3_13_0(projectSchema) {
+  visit(projectSchema, ['@relationship'], (relationship, path) => {
+    const parent = get(projectSchema, path.slice(0, -1));
+    parent['@backReference'] = {
+      enabled: true
+    };
+
+    if (relationship.relatedName) {
+      parent['@backReference'].name = relationship.relatedName;
+      delete relationship.relatedName;
+    }
+  });
+  return { ...projectSchema,
+    schemaVersion: '3.13.0'
+  };
+}
+
+export default migrateToV3_13_0;

package/es/migration/utils.js

@@ -1,23 +1,6 @@
 export function formatDate(timestamp) {
   return (timestamp ? new Date(timestamp) : new Date()).toISOString();
 }
-export function getRelationshipSchema(relationship) {
-  const itemSchema = {
-    $ref: '#/shapes/TSRelationship/schema'
-  };
-
-  if (relationship.type === 'multiple') {
-    return {
-      type: 'array',
-      items: itemSchema,
-      '@relationship': relationship
-    };
-  }
-
-  return { ...itemSchema,
-    '@relationship': relationship
-  };
-}
 export function normalizeSchemaVersion(version) {
   return version === undefined ? '1' : version;
 }

package/es/project-schema/index.js

@@ -1,6 +1,8 @@
 // This file is generated by "pnpm json2ts"
 export * from './latest';
 export * from './v4.0.0';
+export * from './v3.13.0';
+export * from './v3.12.3';
 export * from './v3.12.2';
 export * from './v3.12.1';
 export * from './v3.12.0';

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

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

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

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

package/es/relationships.js

@@ -0,0 +1,17 @@
+export function getRelationshipSchema(relationship) {
+  const itemSchema = {
+    $ref: '#/shapes/TSRelationship/schema'
+  };
+
+  if (relationship.type === 'multiple') {
+    return {
+      type: 'array',
+      items: itemSchema,
+      '@relationship': relationship
+    };
+  }
+
+  return { ...itemSchema,
+    '@relationship': relationship
+  };
+}

package/es/schema-util.js

@@ -44,7 +44,7 @@ export const objectSchemaKeys = [...commonSchemaKeys, 'properties', 'required'];
 export const arraySchemaKeys = [...commonSchemaKeys, 'items', 'additionalItems', 'maxItems', 'minItems', 'uniqueItems'];
 export const multipleRelationshipSchemaKeys = [...schemaMetadataKeys, 'maxItems', 'minItems']; // All properties except properties, items, additionalItems
 
-export const nonStructuralSchemaKeys = [...scalarSchemaKeys, '@relationship', 'required', 'maxItems', 'minItems', 'uniqueItems'];
+export const nonStructuralSchemaKeys = [...scalarSchemaKeys, '@relationship', '@backReference', 'required', 'maxItems', 'minItems', 'uniqueItems'];
 const commonProperties = {
   _id: {
     title: 'Id',
@@ -426,17 +426,22 @@ export function findExistingRelationships(projectSchema, shapes) {
 
   const findRelationships = (schema, path) => {
     if (schema['@relationship']) {
+      var _schema$BackReferenc;
+
       const {
-        shapeIds: relatedShapeIds,
-        relatedName
+        shapeIds: relatedShapeIds
       } = schema['@relationship'];
+      const relatedName = (_schema$BackReferenc = schema['@backReference']) === null || _schema$BackReferenc === void 0 ? void 0 : _schema$BackReferenc.name;
 
       for (const shapeId of relatedShapeIds) {
         if (shapeIds.has(shapeId)) {
+          var _schema$BackReferenc2;
+
           addRelationship(relationships, shapeId, {
             relatedName,
             path: path.slice(1),
-            shapeId: path[0]
+            shapeId: path[0],
+            hasBackreference: Boolean((_schema$BackReferenc2 = schema['@backReference']) === null || _schema$BackReferenc2 === void 0 ? void 0 : _schema$BackReferenc2.enabled)
           });
         }
       }

package/es/schemas/index.js

@@ -1,8 +1,10 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.12.2';
+export const CURRENT_SCHEMA_VERSION = '3.13.0';
 export { default as anyProjectSchema } from './project-schema.json';
-export { default as latestSchemaJson } from './project-schema/v3.12.2.json';
+export { default as latestSchemaJson } from './project-schema/v3.13.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
+import projectSchemaV3_13_0 from './project-schema/v3.13.0.json';
+import projectSchemaV3_12_3 from './project-schema/v3.12.3.json';
 import projectSchemaV3_12_2 from './project-schema/v3.12.2.json';
 import projectSchemaV3_12_1 from './project-schema/v3.12.1.json';
 import projectSchemaV3_12_0 from './project-schema/v3.12.0.json';
@@ -32,4 +34,4 @@ import projectSchemaV3_0_0 from './project-schema/v3.0.0.json';
 import metaSchemaV3_0_0 from './project-schema/meta-schema-v3.0.0.json';
 import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV1_0_0 from './project-schema/meta-schema-v1.0.0.json';
-export const allProjectSchemas = [projectSchemaV4_0_0, projectSchemaV3_12_2, projectSchemaV3_12_1, projectSchemaV3_12_0, projectSchemaV3_11_0, projectSchemaV3_10_0, projectSchemaV3_9_0, metaSchemaV3_9_0, projectSchemaV3_8_0, metaSchemaV3_8_0, projectSchemaV3_7_0, metaSchemaV3_7_0, projectSchemaV3_6_0, metaSchemaV3_6_0, projectSchemaV3_5_1, metaSchemaV3_5_1, projectSchemaV3_5_0, metaSchemaV3_5_0, projectSchemaV3_4_0, metaSchemaV3_4_0, projectSchemaV3_3_0, metaSchemaV3_3_0, projectSchemaV3_2_0, metaSchemaV3_2_0, projectSchemaV3_1_0, metaSchemaV3_1_0, projectSchemaV3_0_0, metaSchemaV3_0_0, projectSchemaV1_0_0, metaSchemaV1_0_0];
+export const allProjectSchemas = [projectSchemaV4_0_0, projectSchemaV3_13_0, projectSchemaV3_12_3, projectSchemaV3_12_2, projectSchemaV3_12_1, projectSchemaV3_12_0, projectSchemaV3_11_0, projectSchemaV3_10_0, projectSchemaV3_9_0, metaSchemaV3_9_0, projectSchemaV3_8_0, metaSchemaV3_8_0, projectSchemaV3_7_0, metaSchemaV3_7_0, projectSchemaV3_6_0, metaSchemaV3_6_0, projectSchemaV3_5_1, metaSchemaV3_5_1, projectSchemaV3_5_0, metaSchemaV3_5_0, projectSchemaV3_4_0, metaSchemaV3_4_0, projectSchemaV3_3_0, metaSchemaV3_3_0, projectSchemaV3_2_0, metaSchemaV3_2_0, projectSchemaV3_1_0, metaSchemaV3_1_0, projectSchemaV3_0_0, metaSchemaV3_0_0, projectSchemaV1_0_0, metaSchemaV1_0_0];

package/es/schemas/index.ts

@@ -1,8 +1,10 @@
 // This file is generated by "pnpm json2ts"
-export const CURRENT_SCHEMA_VERSION = '3.12.2';
+export const CURRENT_SCHEMA_VERSION = '3.13.0';
 export {default as anyProjectSchema} from './project-schema.json';
-export {default as latestSchemaJson} from './project-schema/v3.12.2.json';
+export {default as latestSchemaJson} from './project-schema/v3.13.0.json';
 import projectSchemaV4_0_0 from './project-schema/v4.0.0.json';
+import projectSchemaV3_13_0 from './project-schema/v3.13.0.json';
+import projectSchemaV3_12_3 from './project-schema/v3.12.3.json';
 import projectSchemaV3_12_2 from './project-schema/v3.12.2.json';
 import projectSchemaV3_12_1 from './project-schema/v3.12.1.json';
 import projectSchemaV3_12_0 from './project-schema/v3.12.0.json';
@@ -34,6 +36,8 @@ import projectSchemaV1_0_0 from './project-schema/v1.0.0.json';
 import metaSchemaV1_0_0 from './project-schema/meta-schema-v1.0.0.json';
 export const allProjectSchemas = [
   projectSchemaV4_0_0,
+  projectSchemaV3_13_0,
+  projectSchemaV3_12_3,
   projectSchemaV3_12_2,
   projectSchemaV3_12_1,
   projectSchemaV3_12_0,