oapi-profile-builder 3.3.0__tar.gz → 3.4.0__tar.gz

{oapi_profile_builder-3.3.0/src/oapi_profile_builder.egg-info → oapi_profile_builder-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 3.3.0
+Version: 3.4.0
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License

{oapi_profile_builder-3.3.0 → oapi_profile_builder-3.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "oapi-profile-builder"
-version = "3.3.0"
+version = "3.4.0"
 description = "Authoritative tooling for creating OGC API Service Profiles (EDR, Features)"
 readme = "README.md"
 license = { file = "LICENSE" }

{oapi_profile_builder-3.3.0 → oapi_profile_builder-3.4.0}/src/oapi_profile_builder/cover.py

@@ -173,12 +173,12 @@ def build_cover_image(profile, output_dir: Path) -> str | None:
         draw.text(((_PAGE_W - tw) / 2, y), text, font=font, fill=fill)
         return y + th
 
-    y = 180
+    y = getattr(cover, "logo_y", 180)
 
     # --- Logo (centered, scaled to a target width) ---
     logo = Image.open(logo_path).convert("RGBA")
-    target_logo_w = 420          # desired cover logo width
-    max_logo_w = 520             # hard cap
+    target_logo_w = getattr(cover, "logo_width", 420)
+    max_logo_w = max(520, target_logo_w)
     max_upscale = 3.0            # don't upscale tiny logos beyond this (avoids heavy blur)
     desired = min(target_logo_w, int(logo.width * max_upscale), max_logo_w)
     if logo.width != desired:
@@ -190,7 +190,8 @@ def build_cover_image(profile, output_dir: Path) -> str | None:
 
     # --- Tagline (italic) ---
     if cover.tagline:
-        y = centered(cover.tagline, fonts.italic_font(30), y, fg) + 60
+        tagline_fs = getattr(cover, "tagline_font_size", 30)
+        y = centered(cover.tagline, fonts.italic_font(tagline_fs), y, fg) + 60
 
     # --- Document number ---
     if m and m.doc_number:
@@ -199,16 +200,19 @@ def build_cover_image(profile, output_dir: Path) -> str | None:
     # --- Edition ---
     edition = getattr(profile, "version", None)
     if edition:
-        y = centered(f"Edition {edition}", fonts.regular_font(28), y, fg) + 24
+        bold_ed = bool(getattr(cover, "bold_edition", False))
+        y = centered(f"Edition {edition}", fonts.regular_font(28, bold=bold_ed), y, fg) + 24
 
     # --- Date ---
-    date_str = _format_date(m.publication_date if m else None)
+    pub_date = (m.doc_pub_date or m.publication_date) if m else None
+    date_str = _format_date(pub_date)
     if date_str:
         y = centered(f"Dated {date_str}", fonts.regular_font(28), y, fg) + 80
 
     # --- Title (large, bold, wrapped) ---
     title = getattr(profile, "title", "") or ""
-    title_font = fonts.regular_font(54, bold=True)
+    title_fs = getattr(cover, "title_font_size", 54)
+    title_font = fonts.regular_font(title_fs, bold=True)
     for line in _wrap(draw, title, title_font, _PAGE_W - 240):
         y = centered(line, title_font, y, fg) + 16
 

{oapi_profile_builder-3.3.0 → oapi_profile_builder-3.4.0}/src/oapi_profile_builder/generate.py

@@ -761,6 +761,35 @@ def _params_with_default_f(params: list[dict], profile: "ServiceProfile | None",
     return [f_param if p is _F else p for p in params]
 
 
+def _paging_limit_param(profile: "ServiceProfile | None") -> dict | None:
+    """Return the `limit` query parameter for feature paging, or None when disabled."""
+    if not (profile and profile.paging and profile.paging.enabled):
+        return None
+    return {
+        "name": "limit",
+        "in": "query",
+        "required": False,
+        "description": "Limits the number of features returned in the response.",
+        "schema": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": profile.paging.max_limit,
+            "default": profile.paging.default_limit,
+        },
+    }
+
+
+def _with_paging_limit(params: list[dict], profile: "ServiceProfile | None") -> list[dict]:
+    """Append the paging `limit` param to a copy of *params* if enabled and absent."""
+    limit_param = _paging_limit_param(profile)
+    if limit_param is None:
+        return params
+    out = list(params)
+    if not any(isinstance(p, dict) and p.get("name") == "limit" for p in out):
+        out.append(limit_param)
+    return out
+
+
 def _collection_paths(coll: Collection, examples: dict | None = None,
                       profile: ServiceProfile | None = None) -> dict:
     paths: dict = {}
@@ -793,12 +822,14 @@ def _collection_paths(coll: Collection, examples: dict | None = None,
     }}
 
     # Always generate Features paths (items, queryables, schema)
+    items_params = _with_paging_limit([_F, _LANG], profile)
+
     paths[f"{base}/items"] = {"get": {
         "summary": f"Get {coll.title or coll.id} items",
         "description": desc,
         "operationId": _operation_id("get", coll.id, "Features"),
         "tags": [tag],
-        "parameters": [_F, _LANG],
+        "parameters": items_params,
         "responses": {
             "200": _R200_FEATURES,
             "400": _ERR_400, "404": _ERR_404, "500": _ERR_500,
@@ -863,6 +894,8 @@ def _collection_paths(coll: Collection, examples: dict | None = None,
             # instance-level query sub-paths — GET + optional POST
             for sub_qt in (active - {"instances"}):
                 sub_params = _params_with_default_f(_QUERY_PARAMS.get(sub_qt, []), profile, _vars(sub_qt))
+                if sub_qt == "items":
+                    sub_params = _with_paging_limit(sub_params, profile)
                 get_op = {
                     "summary": f"query {coll.id} instance by {sub_qt}",
                     "description": desc,
@@ -877,12 +910,13 @@ def _collection_paths(coll: Collection, examples: dict | None = None,
                 paths[f"{base}/instances/{{instanceId}}/{sub_qt}"] = path_ops
 
         elif qt == "items":
+            items_params = _with_paging_limit(params, profile)
             get_op = {
                 "summary": f"query {coll.id} by items",
                 "description": desc,
                 "operationId": _operation_id("queryItems", coll.id),
                 "tags": [tag],
-                "parameters": params,
+                "parameters": items_params,
                 "responses": cov_resp,
             }
             path_ops = {"get": get_op}
@@ -1376,6 +1410,135 @@ def _individual_test_adoc(profile: ServiceProfile, test_id: str) -> str:
 
 _PDF_OVERRIDE_FILENAME = "pdf_override.xsl"
 
+_OVERRIDE_SUPPRESS_SECTION_DIVIDERS = """
+  <!-- Suppress section-divider pages by rendering only the main content flow. -->
+  <xsl:template match="node()" mode="sections">
+    <xsl:param name="num"/>
+    <xsl:param name="initial-page-number"/>
+    <fo:page-sequence xsl:use-attribute-sets="page-sequence-main">
+      <xsl:call-template name="refine_page-sequence-main"/>
+      <xsl:call-template name="insertFootnoteSeparator"/>
+      <xsl:call-template name="insertHeaderFooter">
+        <xsl:with-param name="num" select="$num"/>
+      </xsl:call-template>
+      <fo:flow flow-name="xsl-region-body">
+        <fo:block line-height="125%">
+          <xsl:choose>
+            <xsl:when test=".//mn:indexsect">
+              <xsl:apply-templates select=".//mn:indexsect" mode="index"/>
+            </xsl:when>
+            <xsl:otherwise>
+              <xsl:apply-templates/>
+            </xsl:otherwise>
+          </xsl:choose>
+        </fo:block>
+      </fo:flow>
+    </fo:page-sequence>
+  </xsl:template>
+"""
+
+_OVERRIDE_FLATTEN_BIBLIOGRAPHY = """
+  <!-- Remove the hanging indent on Normative References: the OGC flavor uses
+       start-indent 25mm / text-indent -25mm so continuation lines (the title)
+       sit indented under the authors. Flatten both to 0 so every line aligns at
+       the left margin. -->
+  <xsl:attribute-set name="bibitem-normative-style">
+    <xsl:attribute name="margin-bottom">12pt</xsl:attribute>
+    <xsl:attribute name="start-indent">0mm</xsl:attribute>
+    <xsl:attribute name="text-indent">0mm</xsl:attribute>
+    <xsl:attribute name="line-height">115%</xsl:attribute>
+  </xsl:attribute-set>
+
+  <!-- Same for the non-normative Bibliography section: render the citation tag
+       inline with the title as one flush block (wrapped lines align at the left
+       margin instead of being indented under the authors). -->
+  <xsl:template match="mn:references[not(@normative='true')]/mn:bibitem" name="bibitem_non_normative" priority="2">
+    <xsl:param name="skip"/>
+    <xsl:call-template name="setNamedDestination"/>
+    <fo:block id="{@id}" margin-bottom="12pt" role="SKIP">
+      <fo:inline role="SKIP">
+        <xsl:apply-templates select="mn:biblio-tag">
+          <xsl:with-param name="biblio_tag_part">first</xsl:with-param>
+        </xsl:apply-templates>
+      </fo:inline>
+      <xsl:text> </xsl:text>
+      <xsl:call-template name="processBibitem">
+        <xsl:with-param name="biblio_tag_part">last</xsl:with-param>
+      </xsl:call-template>
+    </fo:block>
+  </xsl:template>
+"""
+
+_OVERRIDE_INLINE_SECTION_HEADERS = """
+  <!-- Inline Level 1 section titles (e.g. '1. Scope' in a single block, no circles, no table). -->
+  <xsl:template match="mn:fmt-title" name="title">
+    <xsl:variable name="level"><xsl:call-template name="getLevel"/></xsl:variable>
+    <xsl:variable name="element-name">
+      <xsl:choose>
+        <xsl:when test="../@inline-header = 'true'">fo:inline</xsl:when>
+        <xsl:otherwise>fo:block</xsl:otherwise>
+      </xsl:choose>
+    </xsl:variable>
+    <xsl:call-template name="setNamedDestination"/>
+    <xsl:variable name="title_styles">
+      <styles xsl:use-attribute-sets="title-style">
+        <xsl:call-template name="refine_title-style"/>
+      </styles>
+    </xsl:variable>
+
+    <xsl:choose>
+      <xsl:when test="$level = 1">
+        <fo:block>
+          <xsl:copy-of select="xalan:nodeset($title_styles)/styles/@*[local-name() = 'space-before' or local-name() = 'margin-bottom' or local-name() = 'keep-with-next' or local-name() = 'role']"/>
+          <xsl:call-template name="setIDforNamedDestinationInline"/>
+          <xsl:variable name="title">
+            <xsl:choose>
+              <xsl:when test="mn:tab">
+                <xsl:copy-of select="mn:tab[1]/following-sibling::node()"/>
+              </xsl:when>
+              <xsl:otherwise><xsl:copy-of select="."/></xsl:otherwise>
+            </xsl:choose>
+          </xsl:variable>
+          <xsl:variable name="section" select="mn:tab[1]/preceding-sibling::node()"/>
+          <xsl:call-template name="insertSectionTitle">
+            <xsl:with-param name="section" select="$section"/>
+            <xsl:with-param name="title" select="$title"/>
+            <xsl:with-param name="level" select="$level"/>
+          </xsl:call-template>
+        </fo:block>
+      </xsl:when>
+      <xsl:when test="$level = 2">
+        <fo:block>
+          <xsl:copy-of select="xalan:nodeset($title_styles)/styles/@*[local-name() = 'space-before' or local-name() = 'margin-bottom' or local-name() = 'keep-with-next' or local-name() = 'role']"/>
+          <xsl:call-template name="setIDforNamedDestinationInline"/>
+          <xsl:variable name="title">
+            <xsl:choose>
+              <xsl:when test="mn:tab">
+                <xsl:copy-of select="mn:tab[1]/following-sibling::node()"/>
+              </xsl:when>
+              <xsl:otherwise><xsl:copy-of select="."/></xsl:otherwise>
+            </xsl:choose>
+          </xsl:variable>
+          <xsl:variable name="section" select="mn:tab[1]/preceding-sibling::node()"/>
+          <xsl:call-template name="insertSectionTitle">
+            <xsl:with-param name="section" select="$section"/>
+            <xsl:with-param name="title" select="$title"/>
+            <xsl:with-param name="level" select="$level"/>
+          </xsl:call-template>
+        </fo:block>
+      </xsl:when>
+      <xsl:otherwise>
+        <xsl:element name="{$element-name}">
+          <xsl:copy-of select="xalan:nodeset($title_styles)/styles/@*"/>
+          <xsl:call-template name="setIDforNamedDestinationInline"/>
+          <xsl:apply-templates/>
+          <xsl:apply-templates select="following-sibling::*[1][self::mn:variant-title][@type = 'sub']" mode="subtitle"/>
+        </xsl:element>
+      </xsl:otherwise>
+    </xsl:choose>
+  </xsl:template>
+"""
+
 # Individual template overrides for the OGC Metanorma flavor's PDF XSL. Each is
 # keyed to a real template name in metanorma-ogc's ogc.standard.xsl and merged
 # in via :pdf-stylesheet-override:. These are coupled to the OGC flavor.
@@ -1519,10 +1682,19 @@ def _effective_pdf_config(m) -> dict:
     (default white) background with dark, readable numbers/titles so they no
     longer carry the OGC navy house style.
     """
+    # suppress_design_elements ("debrand") controls only the OGC *decorative*
+    # motifs — the blue crossing lines, the circular clause-number badges and the
+    # short rule under titles — plus the section-divider page recolouring. It does
+    # NOT remove the section-divider pages, inline the headers, or reflow the
+    # bibliography: those are structural/layout choices left as independent opt-ins
+    # so the default OGC document keeps its divider pages and standard layout.
     debrand = bool(getattr(m, "suppress_design_elements", False))
     crossing = debrand or bool(getattr(m, "suppress_crossing_lines", False))
     underlines = debrand or bool(getattr(m, "suppress_title_underlines", False))
     plain_nums = debrand or bool(getattr(m, "plain_section_numbers", False))
+    suppress_divs = bool(getattr(m, "suppress_section_divider_pages", False))
+    inline_headers = bool(getattr(m, "inline_section_headers", False))
+    biblio_indent = bool(getattr(m, "suppress_bibliography_indent", False))
 
     colors = getattr(m, "colors", None)
     page_bg = getattr(colors, "page_background", None) if colors else None
@@ -1548,6 +1720,9 @@ def _effective_pdf_config(m) -> dict:
         "crossing": crossing,
         "underlines": underlines,
         "plain_nums": plain_nums,
+        "suppress_divs": suppress_divs,
+        "inline_headers": inline_headers,
+        "biblio_indent": biblio_indent,
         "body_font": getattr(m, "body_font", None),
         "watermark": getattr(m, "page_watermark", None),
         "divider_bg": divider_bg,
@@ -1555,6 +1730,32 @@ def _effective_pdf_config(m) -> dict:
     }
 
 
+def _submitting_orgs_text_override(org_name: str) -> str:
+    """Rebrand the OGC flavor's auto-generated 'Submitting Organizations' sentence.
+
+    The OGC Metanorma flavor hardcodes "...submitted this Document to the Open
+    Geospatial Consortium (OGC):" in its presentation stage (not the i18n YAML),
+    so it lands in the presentation XML as the text of the
+    ``clause[@type='submitting_orgs']`` paragraph. We replace just that text node
+    with the rebranded SDO name, leaving the paragraph's styling intact.
+
+    Fragile by nature: coupled to the exact sentence the OGC flavor emits. If the
+    flavor changes that wording, this literal will no longer match and should be
+    updated.
+    """
+    org = _xml_escape(org_name)
+    return f"""
+  <!-- Rebrand the flavor's auto-generated 'Submitting Organizations' sentence
+       (the OGC flavor injects 'the Open Geospatial Consortium (OGC)' at its
+       presentation stage). Match the clause's paragraph element specifically —
+       more specific than the base mn:p template, so mn2pdf's merge appends this
+       and it wins for that paragraph only, leaving all other paragraphs alone. -->
+  <xsl:template match="mn:clause[@type='submitting_orgs']/mn:p">
+    <fo:block xsl:use-attribute-sets="p-style" role="P">The following organizations submitted this Document to {org}:</fo:block>
+  </xsl:template>
+"""
+
+
 def _pdf_override_flags(m) -> list[str]:
     """Return the override snippets enabled by document_metadata, in order."""
     if not m:
@@ -1569,6 +1770,17 @@ def _pdf_override_flags(m) -> list[str]:
         parts.append(_OVERRIDE_SUPPRESS_TITLE_UNDERLINES)
     if cfg["plain_nums"]:
         parts.append(_plain_section_numbers_override(cfg["divider_fg"]))
+    if cfg["suppress_divs"]:
+        parts.append(_OVERRIDE_SUPPRESS_SECTION_DIVIDERS)
+    if cfg["inline_headers"]:
+        parts.append(_OVERRIDE_INLINE_SECTION_HEADERS)
+    if cfg["biblio_indent"]:
+        parts.append(_OVERRIDE_FLATTEN_BIBLIOGRAPHY)
+    # Rebrand the flavor's auto-generated "Submitting Organizations" sentence to
+    # name the copyright holder (e.g. DGIWG) instead of OGC, when rebranding.
+    holder = getattr(m, "copyright_holder", None)
+    if holder and holder.strip().upper() not in ("OGC", "OPEN GEOSPATIAL CONSORTIUM"):
+        parts.append(_submitting_orgs_text_override(holder))
     # When the divider background is rebranded (light), force the big title
     # colour too — the flavor inherits white text, invisible on a light page.
     if cfg["divider_bg"] is not None:
@@ -1699,7 +1911,7 @@ def _build_document_adoc(profile: ServiceProfile) -> str:
         ":committee: technical",
         f":docnumber: {m.doc_number if m else profile.name}",
         f":copyright-year: {year}",
-        f":published-date: {(m.publication_date if m and m.publication_date else default_date)}",
+        f":published-date: {((m.doc_pub_date or m.publication_date) if m and (m.doc_pub_date or m.publication_date) else default_date)}",
         f":issued-date: {(m.approval_date if m and m.approval_date else default_date)}",
         f":received-date: {(m.submission_date if m and m.submission_date else default_date)}",
     ]

{oapi_profile_builder-3.3.0 → oapi_profile_builder-3.4.0}/src/oapi_profile_builder/models.py

@@ -472,6 +472,11 @@ class CoverPage(BaseModel):
             "Note: this marks the cover only; an every-page watermark requires the Metanorma layer."
         ),
     )
+    logo_width: int = Field(default=420, description="Target logo width on cover page")
+    logo_y: int = Field(default=180, description="Logo y-offset from top of cover page")
+    tagline_font_size: int = Field(default=30, description="Font size of cover page tagline")
+    title_font_size: int = Field(default=54, description="Font size of cover page title")
+    bold_edition: bool = Field(default=False, description="When true, render edition in bold font")
 
     @field_validator("background", "text_color")
     @classmethod
@@ -599,6 +604,18 @@ class DocumentMetadata(BaseModel):
             "the flavor's built-in text via :boilerplate-authority:."
         ),
     )
+    doc_pub_date: str | None = Field(default=None, description="Alternative field for publication date (YYYY-MM-DD)")
+    suppress_section_divider_pages: bool = Field(default=False, description="When true, completely remove section-divider pages from the PDF")
+    inline_section_headers: bool = Field(default=False, description="When true, render Level 1 headings inline without circles or table formatting")
+    suppress_bibliography_indent: bool = Field(
+        default=False,
+        description=(
+            "When true, remove the OGC flavor's hanging indent on non-normative "
+            "bibliography/reference entries so the citation tag and title render as a "
+            "single flush paragraph (wrapped lines align at the left margin instead of "
+            "being indented under the authors). Coupled to the OGC Metanorma flavor."
+        ),
+    )
     suppress_flavor_logo: bool = Field(
         default=False,
         description=(
@@ -651,10 +668,15 @@ class DocumentMetadata(BaseModel):
         default=False,
         description=(
             "When true, strip the OGC flavor's decorative PDF design elements — the "
-            "blue 'crossing lines' motif, the circular badges around clause numbers, and "
-            "the short rule under clause titles — via a targeted PDF stylesheet override. "
-            "Produces a plainer 'i. Abstract' / '1 Scope' heading style for SDOs (e.g. "
-            "DGIWG) that don't use the OGC house style. Coupled to the OGC Metanorma flavor."
+            "blue 'crossing lines' motif, the circular badges around clause numbers, "
+            "and the short rule under clause titles — via a targeted PDF stylesheet "
+            "override, and recolour the section-divider pages to a clean light "
+            "background for SDOs (e.g. DGIWG) that don't use the OGC house style. "
+            "This affects only decorative styling: it does NOT remove the "
+            "section-divider pages, inline the section headers, or reflow the "
+            "bibliography — use suppress_section_divider_pages, inline_section_headers "
+            "and suppress_bibliography_indent for those structural changes. Coupled to "
+            "the OGC Metanorma flavor."
         ),
     )
     page_watermark: str | None = Field(
@@ -666,7 +688,7 @@ class DocumentMetadata(BaseModel):
         ),
     )
 
-    @field_validator("submission_date", "approval_date", "publication_date")
+    @field_validator("submission_date", "approval_date", "publication_date", "doc_pub_date")
     @classmethod
     def _valid_date(cls, v: str | None) -> str | None:
         if v is not None and not _DATE_RE.match(v):
@@ -700,6 +722,13 @@ class PubSubConfig(BaseModel):
     collection_filters: dict[str, CollectionPubSub] = Field(default_factory=dict, description="Per-collection filter overrides")
 
 
+class PagingConfig(BaseModel):
+    """Optional pagination parameters config."""
+    enabled: bool = Field(default=True, description="When true, include standard limit parameter in /items endpoint")
+    default_limit: int = Field(default=10, description="Default number of features to return", ge=1)
+    max_limit: int = Field(default=10000, description="Maximum allowed limit for features returned", ge=1)
+
+
 # ---------------------------------------------------------------------------
 # Root model — the authoritative profile definition
 # ---------------------------------------------------------------------------
@@ -767,6 +796,7 @@ class ServiceProfile(BaseModel):
     pubsub: PubSubConfig | None = None
     processes: list[dict] = Field(default_factory=list)
     document_metadata: DocumentMetadata | None = None
+    paging: PagingConfig = Field(default_factory=PagingConfig)
     
     # OGC API - EDR Part 3 specific fields
     required_conformance_classes: list[str] = Field(

{oapi_profile_builder-3.3.0 → oapi_profile_builder-3.4.0/src/oapi_profile_builder.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: oapi-profile-builder
-Version: 3.3.0
+Version: 3.4.0
 Summary: Authoritative tooling for creating OGC API Service Profiles (EDR, Features)
 Author-email: Shane Mill <shane.mill@noaa.gov>
 License: Apache License