feat: introduce Opportunity creation for Broken Backlinks

README.md

@@ -216,3 +216,50 @@ export default new AuditBuilder()
   .build();
 
 ```
+
+### How to add Opportunities and Suggestions
+```js
+import { syncSuggestions } from '../utils/data-access.js';
+
+export async function auditRunner(url, context) {
+
+  // your audit logic goes here...
+
+  return {
+    auditResult: results,
+    fullAuditRef: baseURL,
+  };
+}
+
+async function convertToOpportunity(auditUrl, auditData, context) {
+  const { dataAccess } = context;
+
+  const opportunity = Opportunity.create(opportunityData);
+
+  // this logic changes based on the audit type
+  const buildKey = (auditData) => `${auditData.property}|${auditData.anotherProperty}`;
+
+  await syncSuggestions({
+    opportunity,
+    newData: auditData,
+    buildKey,
+    mapNewSuggestion: (issue) => ({
+      opportunityId: opportunity.getId(),
+      type: 'SUGGESTION_TYPE',
+      rank: issue.rankMetric,
+      // data changes based on the audit type
+      data: {
+        property: issue.property,
+        anotherProperty: issue.anotherProperty
+      }
+    }),
+    log
+  }); 
+}
+
+export default new AuditBuilder()
+  .withRunner(auditRunner)
+  .withPostProcessors([ convertToOpportunity ])
+  .build();
+
+```