proskomma-core 0.9.10 → 0.9.13

package/src/pipelines/perf2x/index.cjs

@@ -0,0 +1,7 @@
+const perf2usfmPipeline = require('./perf2usfmPipeline.json');
+const perf2PkJsonPipeline = require('./perf2PkJsonPipeline.json');
+
+module.exports = {
+  perf2usfmPipeline,
+  perf2PkJsonPipeline,
+};

package/src/pipelines/perf2x/perf2PkJsonPipeline.json

@@ -0,0 +1,41 @@
+[
+  {
+    "id": 0,
+    "type": "Inputs",
+    "inputs": {
+      "perf": "json"
+    }
+  },
+  {
+    "id": 1,
+    "title": "PERF to PkJSON",
+    "name": "perf2PkJson",
+    "type": "Transform",
+    "inputs": [
+      {
+        "name": "perf",
+        "type": "json",
+        "source": "Input perf"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "pkJson",
+        "type": "json"
+      }
+    ],
+    "documentation": "",
+    "description": "PERF=>JSON: Converts PERF to current Proskomma input format"
+  },
+  {
+    "id": 999,
+    "type": "Outputs",
+    "outputs": [
+      {
+        "name": "pkJson",
+        "type": "json",
+        "source": "Transform 1 pkJson"
+      }
+    ]
+  }
+]

package/src/pipelines/perf2x/perf2usfmPipeline.json

@@ -0,0 +1,65 @@
+[
+  {
+    "id": 0,
+    "type": "Inputs",
+    "inputs": {
+      "perf": "json"
+    }
+  },
+  {
+    "id": 1,
+    "title": "Generate report",
+    "name": "calculateUsfmChapterPositions",
+    "type": "Transform",
+    "inputs": [
+      {
+        "name": "perf",
+        "type": "json",
+        "source": "Input perf"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "report",
+        "type": "json"
+      }
+    ],
+    "description": "Generate report from perf to calculate the position of the chapters"
+  },
+  {
+    "id": 2,
+    "title": "PERF to USFM",
+    "name": "perf2usfm",
+    "type": "Transform",
+    "inputs": [
+      {
+        "name": "perf",
+        "type": "json",
+        "source": "Input perf"
+      },
+      {
+        "name": "report",
+        "type": "json",
+        "source": "Transform 1 report"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "usfm",
+        "type": "text"
+      }
+    ],
+    "description": "PERF=>USFM: Conversion via Proskomma"
+  },
+  {
+    "id": 999,
+    "type": "Outputs",
+    "outputs": [
+      {
+        "name": "usfm",
+        "type": "text",
+        "source": "Transform 2 usfm"
+      }
+    ]
+  }
+]

package/src/transforms/calculateUsfmChapterPositions.cjs

@@ -0,0 +1,106 @@
+const { PerfRenderFromJson } = require('proskomma-json-tools');
+
+const initialBlockRecord = ct => ({
+  type: ct.sequences[0].block.type,
+  subType: ct.sequences[0].block.subType,
+  pos: ct.sequences[0].block.blockN,
+  perfChapter: null,
+});
+
+const calculateUsfmChapterPositionsActions = {
+  startDocument: [
+    {
+      description: 'Set up storage',
+      test: () => true,
+      action: ({ workspace, output }) => {
+        workspace.blockRecords = [];
+        output.report = {};
+      },
+    },
+  ],
+  startParagraph: [
+    {
+      description: 'Set up block record',
+      test: () => true,
+      action: ({ context, workspace }) => {
+        workspace.blockRecords.push(initialBlockRecord(context));
+      },
+    },
+  ],
+  blockGraft: [
+    {
+      description: 'Set up block record',
+      test: () => true,
+      action: ({ context, workspace }) => {
+        workspace.blockRecords.push(initialBlockRecord(context));
+      },
+    },
+  ],
+  mark: [
+    {
+      description: 'Add chapter number to block record',
+      test: ({ context }) => context.sequences[0].element.subType === 'chapter',
+      action: ({ context, workspace }) => {
+        workspace.blockRecords[workspace.blockRecords.length - 1].perfChapter = context.sequences[0].element.atts['number'];
+      },
+    },
+  ],
+  endDocument: [
+    {
+      description: 'Populate report',
+      test: () => true,
+      action: ({ workspace, output }) => {
+        for (const [recordN, record] of Object.entries(workspace.blockRecords)) {
+          if (!record.perfChapter) {
+            continue;
+          }
+
+          let usfmChapterPos = recordN;
+          let found = false;
+
+          while (usfmChapterPos > 0 && !found) {
+            if (workspace.blockRecords[usfmChapterPos - 1].type === 'paragraph'
+                            || workspace.blockRecords[usfmChapterPos - 1].subType === 'title') {
+              found = true;
+            } else {
+              usfmChapterPos--;
+            }
+          }
+          output.report[usfmChapterPos.toString()] = record.perfChapter;
+        }
+      },
+    },
+  ],
+};
+
+const calculateUsfmChapterPositionsCode = function ({ perf }) {
+  const cl = new PerfRenderFromJson({ srcJson: perf, actions: calculateUsfmChapterPositionsActions });
+  const output = {};
+
+  cl.renderDocument({
+    docId: '', config: { maxLength: 60 }, output,
+  });
+  return { report: output.report };
+};
+
+const calculateUsfmChapterPositions = {
+  name: 'calculateUsfmChapterPositions',
+  type: 'Transform',
+  description: 'PERF=>JSON: Generates positions for inserting chapter numbers into USFM',
+  inputs: [
+    {
+      name: 'perf',
+      type: 'json',
+      source: '',
+    },
+  ],
+  outputs: [
+    {
+      name: 'report',
+      type: 'json',
+    },
+  ],
+  code: calculateUsfmChapterPositionsCode,
+};
+
+module.exports = calculateUsfmChapterPositions;

package/src/transforms/index.cjs

@@ -0,0 +1,9 @@
+const calculateUsfmChapterPositions = require('./calculateUsfmChapterPositions.cjs');
+const perf2usfm = require('./perf2usfm.cjs');
+const perf2PkJson = require('./perf2PkJson.cjs');
+
+module.exports = {
+  calculateUsfmChapterPositions,
+  perf2usfm,
+  perf2PkJson,
+};