Merge pull request #131 from pluginpal/feature/relational-fields

feat: relational patterns

Author: boazpoolman

.changeset/clever-planes-serve.md

@@ -0,0 +1,5 @@
+---
+"@pluginpal/webtools-core": minor
+---
+
+Relational URL patterns

packages/core/server/admin-api/services/query-layer-decorator.ts

@@ -17,6 +17,9 @@ const decorator = (service: IDecoratedService) => ({
       return service.create.call(this, uid, opts);
     }
 
+    // Fetch the URL pattern for this content type.
+    const urlPattern = await getPluginService('urlPatternService').findByUid(uid);
+
     // If a URL alias was created, fetch it.
     if (opts.data.url_alias) {
       urlAliasEntity = await getPluginService('urlAliasService').findOne(opts.data.url_alias);
@@ -34,7 +37,7 @@ const decorator = (service: IDecoratedService) => ({
     // the id, can we create the URL alias entity and can we update
     // the previously created entity.
     const newEntity = await service.create.call(this, uid, { ...opts, data: opts.data });
-    const generatedPath = await getPluginService('urlPatternService').resolvePattern(uid, { ...newEntity, ...opts.data });
+    const generatedPath = getPluginService('urlPatternService').resolvePattern(uid, { ...newEntity, ...opts.data }, urlPattern.pattern);
 
     // If a URL alias was created and 'generated' is set to true, update the alias.
     if (urlAliasEntity?.generated === true) {
@@ -67,20 +70,20 @@ const decorator = (service: IDecoratedService) => ({
       return service.update.call(this, uid, entityId, opts);
     }
 
+    // Fetch the URL pattern for this content type.
+    const urlPattern = await getPluginService('urlPatternService').findByUid(uid);
+
     // Manually fetch the entity that's being updated.
     // We do this becuase not all it's data is present in opts.data.
-    const entity = await service.findOne.call(this, uid, entityId, {
-      populate: {
-        url_alias: {
-          fields: ['id', 'generated'],
-        },
-      },
-    });
+    const entity = await service.update.call(this, uid, entityId, opts);
 
     // If a URL alias is allready present, fetch it.
     if (opts.data.url_alias) {
       urlAliasEntity = await getPluginService('urlAliasService').findOne(opts.data.url_alias);
+      // @ts-ignore
     } else if (entity.url_alias) {
+      // @ts-ignore
+      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
       urlAliasEntity = entity.url_alias;
     }
 
@@ -90,7 +93,7 @@ const decorator = (service: IDecoratedService) => ({
     }
 
     // Generate the path.
-    const generatedPath = await getPluginService('urlPatternService').resolvePattern(uid, { ...entity, ...opts.data });
+    const generatedPath = getPluginService('urlPatternService').resolvePattern(uid, entity, urlPattern.pattern);
 
     // If a URL alias is present and 'generated' is set to true, update the alias.
     if (urlAliasEntity?.generated === true) {

packages/core/server/admin-api/services/url-pattern.ts

@@ -42,6 +42,27 @@ export default () => ({
     return patternEntity;
   },
 
+  /**
+   * FindByUid.
+   *
+   * @param {string} uid the uid.
+   * @returns {void}
+   */
+  findByUid: async (uid: string) => {
+    const patterns = await getPluginService('urlPatternService').findMany({
+      filters: {
+        contenttype: uid,
+      },
+      limit: 1,
+    });
+
+    if (!patterns[0]) {
+      return null;
+    }
+
+    return patterns[0];
+  },
+
   /**
    * FindMany.
    *
@@ -100,21 +121,41 @@ export default () => ({
           && fieldName !== 'createdBy'
           && fieldName !== 'updatedBy'
         ) {
-          // TODO: Relation fields.
-          // const relation = strapi.contentTypes[field.target];
-
-          // if (
-          //   allowedFields.includes('id')
-          //   && !fields.includes(`${fieldName}.id`)
-          // ) {
-          //   fields.push(`${fieldName}.id`);
-          // }
-
-          // Object.entries(relation.attributes).map(([subFieldName, subField]) => {
-          //   if (subField.type === fieldType || subFieldName === fieldType) {
-          //     fields.push(`${fieldName}.${subFieldName}`);
-          //   }
-          // });
+          // @ts-ignore
+          // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+          const relation = strapi.contentTypes[field.target];
+
+          if (
+            allowedFields.includes('id')
+            && !fields.includes(`${fieldName}.id`)
+          ) {
+            fields.push(`${fieldName}.id`);
+          }
+
+          Object.entries(relation.attributes).forEach(([subFieldName, subField]) => {
+            if (subField.type === fieldType || subFieldName === fieldType) {
+              fields.push(`${fieldName}.${subFieldName}`);
+            }
+          });
+        } else if (
+          field.type === 'component'
+          && field.component
+          && field.repeatable !== true // TODO: implement repeatable components.
+        ) {
+          const relation = strapi.components[field.component];
+
+          if (
+            allowedFields.includes('id')
+            && !fields.includes(`${fieldName}.id`)
+          ) {
+            fields.push(`${fieldName}.id`);
+          }
+
+          Object.entries(relation.attributes).forEach(([subFieldName, subField]) => {
+            if (subField.type === fieldType || subFieldName === fieldType) {
+              fields.push(`${fieldName}.${subFieldName}`);
+            }
+          });
         }
       });
     });
@@ -146,27 +187,43 @@ export default () => ({
     return newFields;
   },
 
+  /**
+   * Get all relations from a pattern.
+   *
+   * @param {string} pattern - The pattern.
+   *
+   * @returns {array} The relations.
+   */
+  getRelationsFromPattern: (pattern: string) => {
+    let fields = getPluginService('urlPatternService').getFieldsFromPattern(pattern);
+    fields = fields.filter((field) => field.split('.').length > 1); // Filter on fields containing a dot (.)
+    fields = fields.map((field) => field.split('.')[0]); // Extract the first part of the fields
+    return fields;
+  },
+
+
   /**
    * Resolve a pattern string from pattern to path for a single entity.
    *
    * @param {string} uid - The UID.
    * @param {object} entity - The entity.
+   * @param {string} urlPattern - The URL pattern.
    *
    * @returns {string} The path.
    */
 
-  resolvePattern: async (
+  resolvePattern: (
     uid: Common.UID.ContentType,
     entity: { [key: string]: string | number },
-  ): Promise<string> => {
+    urlPattern?: string,
+  ) => {
     const resolve = (pattern: string) => {
       let resolvedPattern: string = pattern;
       const fields = getPluginService('urlPatternService').getFieldsFromPattern(pattern);
 
       fields.forEach((field) => {
         const relationalField = field.split('.').length > 1 ? field.split('.') : null;
 
-        // TODO: Relation fields.
         if (field === 'pluralName') {
           const fieldValue = strapi.contentTypes[uid].info.pluralName;
 
@@ -191,18 +248,11 @@ export default () => ({
       return resolvedPattern;
     };
 
-    const patterns = await getPluginService('urlPatternService').findMany({
-      filters: {
-        contenttype: uid,
-      },
-      limit: 1,
-    });
-
-    if (!patterns[0]) {
+    if (!urlPattern) {
       return resolve(strapi.config.get('plugin.webtools.default_pattern'));
     }
 
-    const path = resolve(patterns[0].pattern);
+    const path = resolve(urlPattern);
     return path;
   },