metanorma-document 0.2.9 → 0.2.12

data/frontend/test/fixtures/iso-document.json

@@ -0,0 +1,271 @@
+{
+  "type": "doc",
+  "attrs": { "id": "iso-17301-1" },
+  "meta": {
+    "title": "ISO 17301-1:2016 — Cereals and pulses",
+    "flavor": "iso",
+    "type": "international-standard",
+    "schema_version": "v2.1.5"
+  },
+  "toc": {
+    "sections": [
+      { "id": "foreword", "title": "Foreword", "type": "foreword", "children": [] },
+      { "id": "scope", "title": "Scope", "type": "clause", "children": [] },
+      { "id": "normrefs", "title": "Normative references", "type": "references", "children": [] },
+      { "id": "terms", "title": "Terms and definitions", "type": "terms", "children": [
+        { "id": "term-rice", "title": "rice", "type": "clause", "children": [] }
+      ]},
+      { "id": "test-methods", "title": "Test methods", "type": "clause", "children": [] }
+    ],
+    "numbering": { "scope": "1", "normrefs": "2", "terms": "3", "term-rice": "3.1", "test-methods": "4" }
+  },
+  "content": [
+    {
+      "type": "foreword",
+      "attrs": { "id": "foreword", "title": "Foreword" },
+      "content": [
+        {
+          "type": "paragraph",
+          "attrs": { "id": "foreword-p1" },
+          "content": [
+            { "type": "text", "text": "ISO (the International Organization for Standardization) is a worldwide federation of national standards bodies (ISO member bodies)." }
+          ]
+        },
+        {
+          "type": "paragraph",
+          "attrs": { "id": "foreword-p2" },
+          "content": [
+            { "type": "text", "text": "The procedures used to develop this document are described in the ISO/IEC Directives, Part 1." }
+          ]
+        }
+      ]
+    },
+    {
+      "type": "clause",
+      "attrs": { "id": "scope", "title": "Scope", "number": "1" },
+      "content": [
+        {
+          "type": "paragraph",
+          "attrs": { "id": "scope-p1" },
+          "content": [
+            { "type": "text", "text": "This document specifies " },
+            { "type": "text", "text": "the test methods", "marks": [{ "type": "strong" }] },
+            { "type": "text", "text": " for cereals and pulses." }
+          ]
+        },
+        {
+          "type": "paragraph",
+          "attrs": { "id": "scope-p2" },
+          "content": [
+            { "type": "text", "text": "It is applicable to " },
+            { "type": "text", "text": "Oryza sativa L.", "marks": [{ "type": "emphasis" }] },
+            { "type": "text", "text": " and " },
+            { "type": "text", "text": "Oryza glaberrima", "marks": [{ "type": "emphasis" }] },
+            { "type": "text", "text": "." }
+          ]
+        },
+        {
+          "type": "bullet_list",
+          "attrs": { "id": "scope-list1" },
+          "content": [
+            { "type": "list_item", "content": [{ "type": "text", "text": "Milling quality assessment" }] },
+            { "type": "list_item", "content": [{ "type": "text", "text": "Moisture content determination" }] },
+            { "type": "list_item", "content": [
+              { "type": "text", "text": "See " },
+              { "type": "text", "text": "ISO 712", "marks": [{ "type": "xref", "attrs": { "target": "iso712" } }] }
+            ] }
+          ]
+        }
+      ]
+    },
+    {
+      "type": "references",
+      "attrs": { "id": "normrefs", "title": "Normative references", "number": "2" },
+      "content": [
+        {
+          "type": "paragraph",
+          "attrs": { "id": "normrefs-p1" },
+          "content": [
+            { "type": "text", "text": "The following documents are referred to in the text." }
+          ]
+        },
+        {
+          "type": "bullet_list",
+          "attrs": { "id": "normrefs-list1" },
+          "content": [
+            { "type": "list_item", "content": [
+              { "type": "text", "text": "ISO 712, " },
+              { "type": "text", "text": "Cereals and cereal products", "marks": [{ "type": "emphasis" }] },
+              { "type": "text", "text": " — Determination of moisture content" }
+            ] },
+            { "type": "list_item", "content": [
+              { "type": "text", "text": "ISO 520, " },
+              { "type": "text", "text": "Cereals", "marks": [{ "type": "emphasis" }] },
+              { "type": "text", "text": " — Determination of the mass of 1 000 grains" }
+            ] }
+          ]
+        }
+      ]
+    },
+    {
+      "type": "terms",
+      "attrs": { "id": "terms", "title": "Terms and definitions", "number": "3" },
+      "content": [
+        {
+          "type": "paragraph",
+          "attrs": { "id": "terms-p1" },
+          "content": [
+            { "type": "text", "text": "For the purposes of this document, the following terms and definitions apply." }
+          ]
+        },
+        {
+          "type": "clause",
+          "attrs": { "id": "term-rice", "title": "rice", "number": "3.1" },
+          "content": [
+            {
+              "type": "paragraph",
+              "attrs": { "id": "term-rice-p1" },
+              "content": [
+                { "type": "text", "text": "grains of " },
+                { "type": "text", "text": "Oryza sativa L.", "marks": [{ "type": "emphasis" }] }
+              ]
+            },
+            {
+              "type": "example",
+              "attrs": { "id": "term-rice-ex1", "type": "example" },
+              "content": [
+                {
+                  "type": "paragraph",
+                  "content": [
+                    { "type": "text", "text": "Long-grain rice, medium-grain rice, and short-grain rice are the main categories." }
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "note",
+              "attrs": { "id": "term-rice-n1", "type": "note" },
+              "content": [
+                {
+                  "type": "paragraph",
+                  "content": [
+                    { "type": "text", "text": "The term \"rice\" also applies to paddy rice (unhulled) and brown rice (hulled but unpolished)." }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "type": "clause",
+      "attrs": { "id": "test-methods", "title": "Test methods", "number": "4" },
+      "content": [
+        {
+          "type": "paragraph",
+          "attrs": { "id": "test-methods-p1" },
+          "content": [
+            { "type": "text", "text": "The following test methods shall be used for determining the quality parameters." }
+          ]
+        },
+        {
+          "type": "table",
+          "attrs": { "id": "table-1", "title": "Table 1 — Test parameters" },
+          "content": [
+            {
+              "type": "table_head",
+              "content": [
+                {
+                  "type": "table_row",
+                  "content": [
+                    { "type": "table_cell", "content": [{ "type": "text", "text": "Parameter" }] },
+                    { "type": "table_cell", "content": [{ "type": "text", "text": "Method" }] },
+                    { "type": "table_cell", "content": [{ "type": "text", "text": "Unit" }] }
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "table_body",
+              "content": [
+                {
+                  "type": "table_row",
+                  "content": [
+                    { "type": "table_cell", "content": [{ "type": "text", "text": "Moisture content" }] },
+                    { "type": "table_cell", "content": [{ "type": "text", "text": "ISO 712" }] },
+                    { "type": "table_cell", "content": [{ "type": "text", "text": "%" }] }
+                  ]
+                },
+                {
+                  "type": "table_row",
+                  "content": [
+                    { "type": "table_cell", "content": [{ "type": "text", "text": "Grain mass" }] },
+                    { "type": "table_cell", "content": [{ "type": "text", "text": "ISO 520" }] },
+                    { "type": "table_cell", "content": [{ "type": "text", "text": "g" }] }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "type": "admonition",
+          "attrs": { "type": "warning" },
+          "content": [
+            {
+              "type": "paragraph",
+              "content": [
+                { "type": "text", "text": "All measurements shall be performed at (20 ± 2) °C ambient temperature." }
+              ]
+            }
+          ]
+        },
+        {
+          "type": "sourcecode",
+          "attrs": { "language": "python", "text": "def moisture_content(wet, dry):\n    return (wet - dry) / wet * 100" }
+        },
+        {
+          "type": "figure",
+          "attrs": { "id": "fig-1", "title": "Figure 1 — Grain structure" },
+          "content": [
+            { "type": "image", "attrs": { "src": "grain.png", "alt": "Grain structure diagram" } }
+          ]
+        },
+        {
+          "type": "formula",
+          "attrs": { "id": "formula-1", "text": "m = (w - d) / w * 100" }
+        },
+        {
+          "type": "ordered_list",
+          "attrs": { "id": "test-steps" },
+          "content": [
+            { "type": "list_item", "content": [{ "type": "text", "text": "Weigh the sample" }] },
+            { "type": "list_item", "content": [{ "type": "text", "text": "Dry at 130 °C" }] },
+            { "type": "list_item", "content": [{ "type": "text", "text": "Re-weigh and calculate" }] }
+          ]
+        },
+        {
+          "type": "quote",
+          "attrs": { "id": "quote-1" },
+          "content": [
+            {
+              "type": "paragraph",
+              "content": [
+                { "type": "text", "text": "Precision is the soul of science." }
+              ]
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "type": "footnotes",
+      "content": [
+        { "type": "list_item", "attrs": { "id": "fn1", "ref_id": "fnref1" }, "content": [
+          { "type": "paragraph", "content": [{ "type": "text", "text": "Published by ISO." }] }
+        ] }
+      ]
+    }
+  ]
+}

data/frontend/tmp/debug_e2e.cjs

@@ -0,0 +1,46 @@
+const puppeteer = require('puppeteer');
+const path = require('path');
+
+async function main() {
+  const browser = await puppeteer.launch({ headless: true, args: ['--no-sandbox'] });
+  const page = await browser.newPage();
+
+  const errors = [];
+  page.on('console', msg => { if (msg.type() === 'error') errors.push(msg.text()); });
+  page.on('pageerror', err => errors.push('PAGE: ' + err.message));
+
+  const samplePath = path.resolve('dist/sample.html');
+  await page.goto('file://' + samplePath, { waitUntil: 'networkidle0', timeout: 15000 });
+  await page.waitForSelector('#metanorma-app', { timeout: 5000 });
+  await new Promise(r => setTimeout(r, 2000));
+
+  console.log('=== Console Errors ===');
+  errors.forEach(e => console.log(e));
+
+  console.log('\n=== Admonition classes ===');
+  const admonitions = await page.$$eval('[class*="admonition"]', function(els) {
+    return els.map(function(el) { return { tag: el.tagName, cls: el.className.substring(0, 100) }; });
+  });
+  admonitions.forEach(function(a) { console.log(JSON.stringify(a)); });
+
+  console.log('\n=== Body computed styles ===');
+  const bodyStyles = await page.evaluate(function() {
+    var s = getComputedStyle(document.body);
+    return { color: s.color, bg: s.backgroundColor };
+  });
+  console.log(JSON.stringify(bodyStyles));
+
+  console.log('\n=== Root CSS vars ===');
+  const rootVars = await page.evaluate(function() {
+    var s = getComputedStyle(document.documentElement);
+    return { ebookBg: s.getPropertyValue('--ebook-bg').trim(), ebookText: s.getPropertyValue('--ebook-text').trim() };
+  });
+  console.log(JSON.stringify(rootVars));
+
+  console.log('\n=== html class ===');
+  const htmlClass = await page.evaluate(function() { return document.documentElement.className; });
+  console.log(htmlClass);
+
+  await browser.close();
+}
+main().catch(console.error);

data/frontend/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "ES2020",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "lib": ["ES2020", "DOM", "DOM.Iterable"],
+    "skipLibCheck": true,
+    "moduleResolution": "bundler",
+    "allowImportingTsExtensions": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "jsx": "preserve",
+    "strict": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "paths": {
+      "@/*": ["./src/*"],
+      "@test/*": ["./test/*"]
+    }
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue", "test/**/*.ts"],
+  "references": [{ "path": "./tsconfig.node.json" }]
+}

data/frontend/tsconfig.node.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true,
+    "strict": true
+  },
+  "include": ["vite.config.ts"]
+}

data/frontend/vite.config.ts

@@ -0,0 +1,37 @@
+/// <reference types="vitest" />
+import { defineConfig } from 'vite'
+import vue from '@vitejs/plugin-vue'
+import { resolve } from 'path'
+
+export default defineConfig({
+  plugins: [vue()],
+  test: {
+    environment: 'happy-dom',
+    globals: true,
+    exclude: ['e2e/**', 'node_modules/**'],
+  },
+  build: {
+    lib: {
+      entry: resolve(__dirname, 'src/app.ts'),
+      name: 'MetanormaSpa',
+      fileName: 'app',
+      formats: ['iife']
+    },
+    rollupOptions: {
+      output: {
+        inlineDynamicImports: true,
+        assetFileNames: 'app.[ext]'
+      }
+    },
+    minify: 'esbuild'
+  },
+  define: {
+    'process.env.NODE_ENV': JSON.stringify('production')
+  },
+  resolve: {
+    alias: {
+      '@': resolve(__dirname, 'src'),
+      '@test': resolve(__dirname, 'test'),
+    }
+  }
+})

data/frontend/vitest.e2e.config.ts

@@ -0,0 +1,9 @@
+import { defineConfig } from 'vite'
+
+export default defineConfig({
+  test: {
+    environment: 'node',
+    testTimeout: 30000,
+    hookTimeout: 30000,
+  },
+})

data/lib/metanorma/bipm_document/metadata/bipm_bibliographic_item.rb

@@ -3,20 +3,6 @@
 module Metanorma
   module BipmDocument
     module Metadata
-      # Depiction element containing image/SVG content.
-      class DepictionElement < Lutaml::Model::Serializable
-        attribute :type, :string
-        attribute :content, :string
-
-        xml do
-          element "depiction"
-          map_attribute "type", to: :type
-          map_all_content to: :content
-        end
-      end
-
-      # The bibliographical description of a BIPM document.
-      # Inherits all ISO bibdata fields; BIPM adds depiction.
       class BipmBibliographicItem < Metanorma::IsoDocument::Metadata::IsoBibliographicItem
         attribute :ext, BipmBibDataExtensionType
         attribute :depiction, DepictionElement

data/lib/metanorma/bipm_document/metadata/depiction_element.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BipmDocument
+    module Metadata
+      class DepictionElement < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :content, :string
+
+        xml do
+          element "depiction"
+          map_attribute "type", to: :type
+          map_all_content to: :content
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/bipm_document/metadata.rb

@@ -9,7 +9,7 @@ module Metanorma
                "#{__dir__}/metadata/bipm_bibliographic_item"
       autoload :BipmStructuredIdentifier,
                "#{__dir__}/metadata/bipm_structured_identifier"
-      autoload :DepictionElement, "#{__dir__}/metadata/bipm_bibliographic_item"
+      autoload :DepictionElement, "#{__dir__}/metadata/depiction_element"
     end
   end
 end

data/lib/metanorma/document/cli.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "fileutils"
+
+module Metanorma
+  module Document
+    class CLI
+      class Error < StandardError; end
+
+      ToMirrorOptions = Struct.new(
+        :xml_path,
+        :output,
+        :flavor,
+        :id_strategy,
+        :title,
+        keyword_init: true,
+      )
+
+      def self.run(argv)
+        command = argv.shift
+        case command
+        when "to-mirror"
+          to_mirror(argv)
+        when nil, "-h", "--help"
+          puts usage
+        else
+          raise Error, "Unknown command: #{command}"
+        end
+      end
+
+      def self.to_mirror(argv)
+        options = parse_to_mirror_options(argv)
+        execute_to_mirror(options)
+      end
+
+      def self.parse_to_mirror_options(argv)
+        options = ToMirrorOptions.new(output: nil, flavor: nil,
+                                      id_strategy: nil, title: nil)
+
+        parser = OptionParser.new do |opts|
+          opts.banner = "Usage: metanorma-document to-mirror <xml_path> [options]"
+
+          opts.on("-o", "--output PATH",
+                  "Output JSON path (default: stdout)") do |path|
+            options.output = path
+          end
+
+          opts.on("-f", "--flavor FLAVOR",
+                  "Document flavor (default: auto-detect)") do |flavor|
+            options.flavor = flavor
+          end
+
+          opts.on("--id-strategy STRATEGY",
+                  "ID strategy: preserve (default), positional") do |strategy|
+            case strategy
+            when "positional"
+              options.id_strategy = Mirror::IdStrategy::Positional.new
+            when "preserve"
+              options.id_strategy = Mirror::IdStrategy::Preserve.new
+            else
+              raise Error,
+                    "Unknown ID strategy: #{strategy}. Use 'preserve' or 'positional'."
+            end
+          end
+
+          opts.on("--title TITLE", "Document title override") do |title|
+            options.title = title
+          end
+        end
+
+        parser.parse!(argv)
+
+        xml_path = argv.shift
+        raise Error, "XML path required" unless xml_path
+        raise Error, "File not found: #{xml_path}" unless File.exist?(xml_path)
+
+        options.xml_path = xml_path
+        options
+      end
+
+      def self.execute_to_mirror(options)
+        pipeline = Mirror::Output::Pipeline.new(
+          xml_path: options.xml_path,
+          flavor: options.flavor,
+          title: options.title,
+          id_strategy: options.id_strategy,
+        )
+        guide = pipeline.process
+
+        json = Mirror::Serialization::JsonSerializer.serialize_pretty(guide.content)
+        write_output(json, options.output)
+      end
+
+      def self.write_output(json, output_path)
+        if output_path
+          FileUtils.mkdir_p(File.dirname(output_path))
+          File.write(output_path, json)
+        else
+          $stdout.puts(json)
+        end
+      end
+
+      def self.usage
+        <<~USAGE
+          Usage: metanorma-document <command> [options]
+
+          Commands:
+            to-mirror    Convert presentation XML to mirror JSON
+
+          Run `metanorma-document <command> --help` for command-specific options.
+        USAGE
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/ancillary_blocks/callout_annotation.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module AncillaryBlocks
+        class CalloutAnnotation < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :anchor, :string
+          attribute :semx_id, :string
+          attribute :original_id, :string
+          attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+
+          xml do
+            element "callout-annotation"
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "original-id", to: :original_id
+            map_element "p", to: :p
+          end
+        end
+      end
+    end
+  end
+end