ds-caselaw-marklogic-api-client 29.2.0__py3-none-any.whl → 31.0.0__py3-none-any.whl

caselawclient/Client.py

@@ -25,12 +25,12 @@ from caselawclient.models.documents import (
     DOCUMENT_COLLECTION_URI_JUDGMENT,
     DOCUMENT_COLLECTION_URI_PRESS_SUMMARY,
     Document,
-    DocumentURIString,
 )
 from caselawclient.models.judgments import Judgment
 from caselawclient.models.press_summaries import PressSummary
 from caselawclient.models.utilities import move
 from caselawclient.search_parameters import SearchParameters
+from caselawclient.types import DocumentURIString
 from caselawclient.xquery_type_dicts import (
     MarkLogicDocumentURIString,
     MarkLogicDocumentVersionURIString,
@@ -1203,17 +1203,40 @@ class MarklogicApiClient:
 
         return results
 
-    def resolve_from_identifier(self, identifier_uri: str, published_only: bool = True) -> IdentifierResolutions:
+    def resolve_from_identifier_slug(self, identifier_uri: str, published_only: bool = True) -> IdentifierResolutions:
         """Given a PUI/EUI url, look up the precomputed slug and return the
         MarkLogic document URIs which match that slug. Multiple returns should be anticipated"""
-        vars: query_dicts.ResolveFromIdentifierDict = {
+        vars: query_dicts.ResolveFromIdentifierSlugDict = {
             "identifier_uri": DocumentURIString(identifier_uri),
             "published_only": int(published_only),
         }
         raw_results: list[str] = get_multipart_strings_from_marklogic_response(
             self._send_to_eval(
                 vars,
-                "resolve_from_identifier.xqy",
+                "resolve_from_identifier_slug.xqy",
+            ),
+        )
+        return IdentifierResolutions.from_marklogic_output(raw_results)
+
+    def resolve_from_identifier(self, identifier_uri: str, published_only: bool = True) -> IdentifierResolutions:
+        warnings.warn(
+            "resolve_from_identifier deprecated, use resolve_from_identifier_slug instead", DeprecationWarning
+        )
+        return self.resolve_from_identifier(identifier_uri, published_only)
+
+    def resolve_from_identifier_value(
+        self, identifier_value: str, published_only: bool = True
+    ) -> IdentifierResolutions:
+        """Given a PUI/EUI url, look up the precomputed slug and return the
+        MarkLogic document URIs which match that slug. Multiple returns should be anticipated"""
+        vars: query_dicts.ResolveFromIdentifierValueDict = {
+            "identifier_value": identifier_value,
+            "published_only": int(published_only),
+        }
+        raw_results: list[str] = get_multipart_strings_from_marklogic_response(
+            self._send_to_eval(
+                vars,
+                "resolve_from_identifier_value.xqy",
             ),
         )
         return IdentifierResolutions.from_marklogic_output(raw_results)

caselawclient/factories.py

@@ -1,17 +1,29 @@
 import datetime
+import json
 from typing import Any, Optional
 from unittest.mock import Mock
 
 from typing_extensions import TypeAlias
 
 from caselawclient.Client import MarklogicApiClient
-from caselawclient.models.documents import Document, DocumentURIString
+from caselawclient.identifier_resolution import IdentifierResolution, IdentifierResolutions
+from caselawclient.models.documents import Document
 from caselawclient.models.documents.body import DocumentBody
 from caselawclient.models.judgments import Judgment
 from caselawclient.models.press_summaries import PressSummary
 from caselawclient.responses.search_result import SearchResult, SearchResultMetadata
+from caselawclient.types import DocumentURIString
 
-DEFAULT_DOCUMENT_BODY_XML = "<akomantoso>This is some XML of a judgment.</akomantoso>"
+DEFAULT_DOCUMENT_BODY_XML = """<akomaNtoso xmlns="http://docs.oasis-open.org/legaldocml/ns/akn/3.0" xmlns:uk="https://caselaw.nationalarchives.gov.uk/akn">
+            <judgment name="decision">
+                <meta/><header/>
+                <judgmentBody>
+                <decision>
+                <p>This is a document.</p>
+                </decision>
+                </judgmentBody>
+            </judgment>
+            </akomaNtoso>"""
 
 
 class DocumentBodyFactory:
@@ -55,7 +67,6 @@ class DocumentFactory:
     def build(
         cls,
         uri: DocumentURIString = DocumentURIString("test/2023/123"),
-        html: str = "<p>This is a judgment.</p>",
         api_client: Optional[MarklogicApiClient] = None,
         **kwargs: Any,
     ) -> target_class:
@@ -65,7 +76,6 @@ class DocumentFactory:
             api_client.get_property_as_node.return_value = None
 
         document = cls.target_class(uri, api_client=api_client)
-        document.content_as_html = Mock(return_value=html)  # type: ignore[method-assign]
         document.body = kwargs.pop("body") if "body" in kwargs else DocumentBodyFactory.build()
 
         for param_name, default_value in cls.PARAMS_MAP.items():
@@ -132,3 +142,33 @@ class SearchResultFactory(SimpleFactory):
         "metadata": SearchResultMetadataFactory.build(),
         "is_failure": False,
     }
+
+
+class IdentifierResolutionFactory:
+    @classmethod
+    def build(
+        self,
+        resolution_uuid: Optional[str] = None,
+        document_uri: Optional[str] = None,
+        identifier_slug: Optional[str] = None,
+        published: Optional[bool] = True,
+        namespace: Optional[str] = None,
+        value: Optional[str] = None,
+    ) -> IdentifierResolution:
+        raw_resolution = {
+            "documents.compiled_url_slugs.identifier_uuid": resolution_uuid or "24b9a384-8bcf-4f20-996a-5c318f8dc657",
+            "documents.compiled_url_slugs.document_uri": document_uri or "/ewca/civ/2003/547.xml",
+            "documents.compiled_url_slugs.identifier_slug": identifier_slug or "ewca/civ/2003/54721",
+            "documents.compiled_url_slugs.document_published": "true" if published else "false",
+            "documents.compiled_url_slugs.identifier_namespace": namespace or "ukncn",
+            "documents.compiled_url_slugs.identifier_value": value or "[2003] EWCA 54721 (Civ)",
+        }
+        return IdentifierResolution.from_marklogic_output(json.dumps(raw_resolution))
+
+
+class IdentifierResolutionsFactory:
+    @classmethod
+    def build(self, resolutions: Optional[list[IdentifierResolution]] = None) -> IdentifierResolutions:
+        if resolutions is None:
+            resolutions = [IdentifierResolutionFactory.build()]
+        return IdentifierResolutions(resolutions)

caselawclient/identifier_resolution.py

@@ -1,7 +1,9 @@
 import json
 from typing import NamedTuple
 
-from caselawclient.models.documents import DocumentURIString
+from caselawclient.models.identifiers import Identifier
+from caselawclient.models.identifiers.unpacker import IDENTIFIER_NAMESPACE_MAP
+from caselawclient.types import DocumentURIString
 from caselawclient.xquery_type_dicts import MarkLogicDocumentURIString
 
 
@@ -12,7 +14,7 @@ class IdentifierResolutions(list["IdentifierResolution"]):
     MarkLogic returns a list of dictionaries; IdentifierResolution handles a single dictionary
     which corresponds to a single identifier to MarkLogic document mapping.
 
-    see `xquery/resolve_from_identifier.xqy` and `resolve_from_identifier` in `Client.py`
+    see `xquery/resolve_from_identifier_slug.xqy` and `resolve_from_identifier` in `Client.py`
     """
 
     @staticmethod
@@ -31,13 +33,20 @@ class IdentifierResolution(NamedTuple):
     document_uri: MarkLogicDocumentURIString
     identifier_slug: DocumentURIString
     document_published: bool
+    identifier_value: str
+    identifier_namespace: str
+    identifier_type: type[Identifier]
 
     @staticmethod
     def from_marklogic_output(raw_row: str) -> "IdentifierResolution":
         row = json.loads(raw_row)
+        identifier_namespace = row["documents.compiled_url_slugs.identifier_namespace"]
         return IdentifierResolution(
             identifier_uuid=row["documents.compiled_url_slugs.identifier_uuid"],
             document_uri=MarkLogicDocumentURIString(row["documents.compiled_url_slugs.document_uri"]),
             identifier_slug=DocumentURIString(row["documents.compiled_url_slugs.identifier_slug"]),
             document_published=row["documents.compiled_url_slugs.document_published"] == "true",
+            identifier_value=row["documents.compiled_url_slugs.identifier_value"],
+            identifier_namespace=identifier_namespace,
+            identifier_type=IDENTIFIER_NAMESPACE_MAP[identifier_namespace],
         )

caselawclient/models/documents/__init__.py

@@ -6,15 +6,14 @@ from typing import TYPE_CHECKING, Any, Optional
 from ds_caselaw_utils import courts
 from ds_caselaw_utils.courts import CourtNotFoundException
 from ds_caselaw_utils.types import NeutralCitationString
-from lxml import html as html_parser
 from requests_toolbelt.multipart import decoder
 
 from caselawclient.errors import (
     DocumentNotFoundError,
-    GatewayTimeoutError,
     NotSupportedOnVersion,
     OnlySupportedOnVersion,
 )
+from caselawclient.identifier_resolution import IdentifierResolutions
 from caselawclient.models.identifiers import Identifier
 from caselawclient.models.identifiers.fclid import FindCaseLawIdentifier, FindCaseLawIdentifierSchema
 from caselawclient.models.identifiers.unpacker import unpack_all_identifiers_from_etree
@@ -30,9 +29,10 @@ from caselawclient.models.utilities.aws import (
     request_parse,
     unpublish_documents,
 )
+from caselawclient.types import DocumentURIString
 
 from .body import DocumentBody
-from .exceptions import CannotPublishUnpublishableDocument, DocumentNotSafeForDeletion, InvalidDocumentURIException
+from .exceptions import CannotPublishUnpublishableDocument, DocumentNotSafeForDeletion
 from .statuses import DOCUMENT_STATUS_HOLD, DOCUMENT_STATUS_IN_PROGRESS, DOCUMENT_STATUS_NEW, DOCUMENT_STATUS_PUBLISHED
 
 MINIMUM_ENRICHMENT_TIME = datetime.timedelta(minutes=20)
@@ -49,28 +49,6 @@ if TYPE_CHECKING:
     from caselawclient.Client import MarklogicApiClient
 
 
-class DocumentURIString(str):
-    """
-    This class checks that the string is actually a valid Document URI on creation. It does _not_ manipulate the string.
-    """
-
-    def __new__(cls, content: str) -> "DocumentURIString":
-        # Check that the URI doesn't begin or end with a slash
-        if content[0] == "/" or content[-1] == "/":
-            raise InvalidDocumentURIException(
-                f'"{content}" is not a valid document URI; URIs cannot begin or end with slashes.'
-            )
-
-        # Check that the URI doesn't contain a full stop
-        if "." in content:
-            raise InvalidDocumentURIException(
-                f'"{content}" is not a valid document URI; URIs cannot contain full stops.'
-            )
-
-        # If everything is good, return as usual
-        return str.__new__(cls, content)
-
-
 class Document:
     """
     A base class from which all other document types are extensions. This class includes the essential methods for
@@ -273,39 +251,6 @@ class Document:
         "Is this document a potentially historic version of a document, or is it the main document itself?"
         return extract_version(self.uri) != 0
 
-    def content_as_html(
-        self,
-        version_uri: Optional[DocumentURIString] = None,
-        query: Optional[str] = None,
-    ) -> str:
-        try:
-            results = self.api_client.eval_xslt(
-                self.uri,
-                version_uri,
-                show_unpublished=True,
-                query=query,
-            )
-            multipart_data = decoder.MultipartDecoder.from_response(results)
-            return str(multipart_data.parts[0].text)
-        except GatewayTimeoutError as e:
-            if query is not None:
-                warnings.warn(
-                    (
-                        "Gateway timeout when getting content with query"
-                        "highlighting for document %s, version %s, and query"
-                        '"%s", falling back to unhighlighted content...'
-                    )
-                    % (self.uri, version_uri, query),
-                    GatewayTimeoutGettingHTMLWithQuery,
-                )
-                return self.content_as_html(version_uri)
-            raise e
-
-    def number_of_mentions(self, query: str) -> int:
-        html = self.content_as_html(query=query)
-        tree = html_parser.fromstring(html.encode("utf-8"))
-        return len(tree.findall(".//mark"))
-
     @cached_property
     def is_failure(self) -> bool:
         """
@@ -550,3 +495,21 @@ class Document:
             return getattr(self.body, name)
         except Exception:
             raise AttributeError(f"Neither 'Document' nor 'DocumentBody' objects have an attribute '{name}'")
+
+    def linked_document_resolutions(self, namespaces: list[str], only_published: bool = True) -> IdentifierResolutions:
+        """Get documents which share the same neutral citation as this document."""
+        if not hasattr(self, "neutral_citation") or not self.neutral_citation:
+            return IdentifierResolutions([])
+
+        resolutions = self.api_client.resolve_from_identifier_value(self.neutral_citation)
+        if only_published:
+            resolutions = resolutions.published()
+
+        # only documents which aren't this one and have a right namespace
+        return IdentifierResolutions(
+            [
+                resolution
+                for resolution in resolutions
+                if resolution.document_uri != self.uri.as_marklogic() and resolution.identifier_namespace in namespaces
+            ]
+        )

caselawclient/models/documents/body.py

@@ -12,6 +12,11 @@ from caselawclient.models.utilities.dates import parse_string_date_as_utc
 
 from .xml import XML
 
+DEFAULT_NAMESPACES = {
+    "uk": "https://caselaw.nationalarchives.gov.uk/akn",
+    "akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0",
+}
+
 
 class UnparsableDate(Warning):
     pass
@@ -26,35 +31,25 @@ class DocumentBody:
         self._xml = XML(xml_bytestring=xml_bytestring)
         """ This is an instance of the `Document.XML` class for manipulation of the XML document itself. """
 
-    def get_xpath_match_string(self, xpath: str, namespaces: dict[str, str]) -> str:
+    def get_xpath_match_string(self, xpath: str, namespaces: dict[str, str] = DEFAULT_NAMESPACES) -> str:
         return self._xml.get_xpath_match_string(xpath, namespaces)
 
+    def get_xpath_match_strings(self, xpath: str, namespaces: dict[str, str] = DEFAULT_NAMESPACES) -> list[str]:
+        return self._xml.get_xpath_match_strings(xpath, namespaces)
+
     @cached_property
     def name(self) -> str:
-        return self._xml.get_xpath_match_string(
-            "/akn:akomaNtoso/akn:*/akn:meta/akn:identification/akn:FRBRWork/akn:FRBRname/@value",
-            {"akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0"},
+        return self.get_xpath_match_string(
+            "/akn:akomaNtoso/akn:*/akn:meta/akn:identification/akn:FRBRWork/akn:FRBRname/@value"
         )
 
     @cached_property
     def court(self) -> str:
-        return self._xml.get_xpath_match_string(
-            "/akn:akomaNtoso/akn:*/akn:meta/akn:proprietary/uk:court/text()",
-            {
-                "uk": "https://caselaw.nationalarchives.gov.uk/akn",
-                "akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0",
-            },
-        )
+        return self.get_xpath_match_string("/akn:akomaNtoso/akn:*/akn:meta/akn:proprietary/uk:court/text()")
 
     @cached_property
     def jurisdiction(self) -> str:
-        return self._xml.get_xpath_match_string(
-            "/akn:akomaNtoso/akn:*/akn:meta/akn:proprietary/uk:jurisdiction/text()",
-            {
-                "uk": "https://caselaw.nationalarchives.gov.uk/akn",
-                "akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0",
-            },
-        )
+        return self.get_xpath_match_string("/akn:akomaNtoso/akn:*/akn:meta/akn:proprietary/uk:jurisdiction/text()")
 
     @property
     def court_and_jurisdiction_identifier_string(self) -> CourtCode:
@@ -64,9 +59,8 @@ class DocumentBody:
 
     @cached_property
     def document_date_as_string(self) -> str:
-        return self._xml.get_xpath_match_string(
+        return self.get_xpath_match_string(
             "/akn:akomaNtoso/akn:*/akn:meta/akn:identification/akn:FRBRWork/akn:FRBRdate/@date",
-            {"akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0"},
         )
 
     @cached_property
@@ -90,9 +84,8 @@ class DocumentBody:
         name: Optional[str] = None,
     ) -> list[datetime.datetime]:
         name_filter = f"[@name='{name}']" if name else ""
-        iso_datetimes = self._xml.get_xpath_match_strings(
+        iso_datetimes = self.get_xpath_match_strings(
             f"/akn:akomaNtoso/akn:*/akn:meta/akn:identification/akn:FRBRManifestation/akn:FRBRdate{name_filter}/@date",
-            {"akn": "http://docs.oasis-open.org/legaldocml/ns/akn/3.0"},
         )
 
         return [parse_string_date_as_utc(event, pytz.UTC) for event in iso_datetimes]
@@ -130,9 +123,24 @@ class DocumentBody:
     def content_as_xml(self) -> str:
         return self._xml.xml_as_string
 
+    @cached_property
+    def has_content(self) -> bool:
+        """If we do not have a word document, the XML will not contain
+        the contents of the judgment, but will contain a preamble."""
+        trailing_tags = self._xml.xml_as_tree.xpath("//*[preceding::akn:meta]", namespaces=DEFAULT_NAMESPACES)
+        for tag in trailing_tags:
+            if tag.tail and tag.tail.strip():
+                return True
+            if tag.text and tag.text.strip():
+                return True
+
+        return False
+
     @cache
-    def content_as_html(self, image_base_url: Optional[str] = None) -> str:
+    def content_as_html(self, image_base_url: Optional[str] = None) -> Optional[str]:
         """Convert the XML representation of the Document into HTML for rendering."""
+        if not self.has_content:
+            return None
 
         html_xslt_location = os.path.join(os.path.dirname(os.path.realpath(__file__)), "transforms", "html.xsl")
 

caselawclient/models/documents/exceptions.py

@@ -4,7 +4,3 @@ class CannotPublishUnpublishableDocument(Exception):
 
 class DocumentNotSafeForDeletion(Exception):
     """A document which is not safe for deletion cannot be deleted."""
-
-
-class InvalidDocumentURIException(Exception):
-    """The document URI is not valid."""

caselawclient/models/judgments.py

@@ -5,12 +5,15 @@ from typing import TYPE_CHECKING, Any, Optional
 from ds_caselaw_utils.types import NeutralCitationString
 
 from caselawclient.errors import DocumentNotFoundError
+from caselawclient.identifier_resolution import IdentifierResolutions
 from caselawclient.models.neutral_citation_mixin import NeutralCitationMixin
 
 if TYPE_CHECKING:
     from caselawclient.models.press_summaries import PressSummary
 
-from .documents import Document, DocumentURIString
+from caselawclient.types import DocumentURIString
+
+from .documents import Document
 
 
 class Judgment(NeutralCitationMixin, Document):
@@ -49,3 +52,7 @@ class Judgment(NeutralCitationMixin, Document):
             return PressSummary(uri, self.api_client)
         except DocumentNotFoundError:
             return None
+
+    @cached_property
+    def linked_press_summaries(self, only_published: bool = True) -> "IdentifierResolutions":
+        return self.linked_document_resolutions(["uksummaryofncn"], only_published)

caselawclient/models/press_summaries.py

@@ -7,9 +7,11 @@ from typing import TYPE_CHECKING, Any, Optional
 from ds_caselaw_utils.types import NeutralCitationString
 
 from caselawclient.errors import DocumentNotFoundError
+from caselawclient.identifier_resolution import IdentifierResolutions
 from caselawclient.models.neutral_citation_mixin import NeutralCitationMixin
+from caselawclient.types import DocumentURIString
 
-from .documents import Document, DocumentURIString
+from .documents import Document
 
 if TYPE_CHECKING:
     from caselawclient.models.judgments import Judgment
@@ -50,3 +52,6 @@ class PressSummary(NeutralCitationMixin, Document):
             return Judgment(uri, self.api_client)
         except DocumentNotFoundError:
             return None
+
+    def linked_judgments(self, only_published: bool = True) -> "IdentifierResolutions":
+        return self.linked_document_resolutions(["ukncn"], only_published)

caselawclient/models/utilities/aws.py

@@ -2,7 +2,7 @@ import datetime
 import json
 import logging
 import uuid
-from typing import TYPE_CHECKING, Any, Literal, Optional, TypedDict, overload
+from typing import Any, Literal, Optional, TypedDict, overload
 
 import boto3
 import botocore.client
@@ -13,10 +13,7 @@ from mypy_boto3_sns.client import SNSClient
 from mypy_boto3_sns.type_defs import MessageAttributeValueTypeDef
 from typing_extensions import NotRequired
 
-if TYPE_CHECKING:
-    from caselawclient.models.documents import DocumentURIString
-else:
-    DocumentURIString = None
+from caselawclient.types import DocumentURIString
 
 env = environ.Env()
 

caselawclient/models/utilities/move.py

@@ -4,8 +4,8 @@ import ds_caselaw_utils as caselawutils
 from ds_caselaw_utils.types import NeutralCitationString
 
 from caselawclient.errors import MarklogicAPIError
-from caselawclient.models.documents import DocumentURIString
 from caselawclient.models.utilities.aws import copy_assets
+from caselawclient.types import DocumentURIString
 
 if TYPE_CHECKING:
     from caselawclient.Client import MarklogicApiClient

caselawclient/responses/search_result.py

@@ -12,7 +12,7 @@ from ds_caselaw_utils.types import CourtCode, JurisdictionCode
 from lxml import etree
 
 from caselawclient.Client import MarklogicApiClient
-from caselawclient.models.documents import DocumentURIString
+from caselawclient.types import DocumentURIString
 from caselawclient.xml_helpers import get_xpath_match_string
 
 

caselawclient/types.py

@@ -0,0 +1,31 @@
+class InvalidDocumentURIException(Exception):
+    """The document URI is not valid."""
+
+
+class MarkLogicDocumentURIString(str):
+    pass
+
+
+class DocumentURIString(str):
+    """
+    This class checks that the string is actually a valid Document URI on creation. It does _not_ manipulate the string.
+    """
+
+    def __new__(cls, content: str) -> "DocumentURIString":
+        # Check that the URI doesn't begin or end with a slash
+        if content[0] == "/" or content[-1] == "/":
+            raise InvalidDocumentURIException(
+                f'"{content}" is not a valid document URI; URIs cannot begin or end with slashes.'
+            )
+
+        # Check that the URI doesn't contain a full stop
+        if "." in content:
+            raise InvalidDocumentURIException(
+                f'"{content}" is not a valid document URI; URIs cannot contain full stops.'
+            )
+
+        # If everything is good, return as usual
+        return str.__new__(cls, content)
+
+    def as_marklogic(self) -> MarkLogicDocumentURIString:
+        return MarkLogicDocumentURIString(f"/{self}.xml")

caselawclient/xquery/resolve_from_identifier_value.xqy

@@ -0,0 +1,17 @@
+xquery version "1.0-ml";
+
+declare namespace xdmp="http://marklogic.com/xdmp"; 
+declare variable $identifier_value as xs:string external;
+declare variable $published_only as xs:int? external := 1;
+
+let $published_query := if ($published_only) then " AND document_published = 'true'" else ""
+let $query := "SELECT * from compiled_url_slugs WHERE (identifier_value = @value)" ||  $published_query
+
+return xdmp:sql(
+  $query,
+  "map",
+  map:new((
+    map:entry("value", $identifier_value)
+  ))
+)
+

caselawclient/xquery_type_dicts.py

@@ -7,9 +7,9 @@ checks. They are used to enforce appropriately typed variables being passed in t
 """
 
 from typing import Any, NewType, Optional, TypedDict
-from caselawclient.models.documents import DocumentURIString
+from caselawclient.types import DocumentURIString
+from caselawclient.types import MarkLogicDocumentURIString as MarkLogicDocumentURIString
 
-MarkLogicDocumentURIString = NewType("MarkLogicDocumentURIString", str)
 MarkLogicDocumentVersionURIString = NewType("MarkLogicDocumentVersionURIString", MarkLogicDocumentURIString)
 
 MarkLogicPrivilegeURIString = NewType("MarkLogicPrivilegeURIString", str)
@@ -141,12 +141,18 @@ class ListJudgmentVersionsDict(MarkLogicAPIDict):
     uri: MarkLogicDocumentURIString
 
 
-# resolve_from_identifier.xqy
-class ResolveFromIdentifierDict(MarkLogicAPIDict):
+# resolve_from_identifier_slug.xqy
+class ResolveFromIdentifierSlugDict(MarkLogicAPIDict):
     identifier_uri: DocumentURIString
     published_only: Optional[int]
 
 
+# resolve_from_identifier_value.xqy
+class ResolveFromIdentifierValueDict(MarkLogicAPIDict):
+    identifier_value: str
+    published_only: Optional[int]
+
+
 # set_boolean_property.xqy
 class SetBooleanPropertyDict(MarkLogicAPIDict):
     name: str

{ds_caselaw_marklogic_api_client-29.2.0.dist-info → ds_caselaw_marklogic_api_client-31.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: ds-caselaw-marklogic-api-client
-Version: 29.2.0
+Version: 31.0.0
 Summary: An API client for interacting with the underlying data in Find Caselaw.
 Home-page: https://github.com/nationalarchives/ds-caselaw-custom-api-client
 Keywords: national archives,caselaw
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Requires-Dist: boto3 (>=1.26.112,<2.0.0)
-Requires-Dist: certifi (>=2024.12.14,<2024.13.0)
+Requires-Dist: certifi (>=2025.1.31,<2025.2.0)
 Requires-Dist: charset-normalizer (>=3.0.0,<4.0.0)
 Requires-Dist: django-environ (>=0.12.0)
 Requires-Dist: ds-caselaw-utils (>=2.0.0,<3.0.0)

{ds_caselaw_marklogic_api_client-29.2.0.dist-info → ds_caselaw_marklogic_api_client-31.0.0.dist-info}/RECORD

@@ -1,15 +1,15 @@
-caselawclient/Client.py,sha256=6BaVpKSvMcNhSaDXzTkN1h4iV7KFrY7SgSHNGqGQ_2o,43863
+caselawclient/Client.py,sha256=JBtcmyuY8tHm1pj62BkmtLSjsZ825ver9sefTLhltIc,45005
 caselawclient/__init__.py,sha256=DY-caubLDQWWingSdsBWgovDNXh8KcnkI6kwz08eIFk,612
 caselawclient/client_helpers/__init__.py,sha256=fyDNKCdrTb2N0Ks23YDhmvlXKfLTHnYQCXhnZb-QQbg,3832
 caselawclient/client_helpers/search_helpers.py,sha256=R99HyRLeYHgsw2L3DOidEqlKLLvs6Tga5rKTuWQViig,1525
 caselawclient/content_hash.py,sha256=0cPC4OoABq0SC2wYFX9-24DodNigeOqksDxgxQH_hUA,2221
 caselawclient/errors.py,sha256=JC16fEGq_MRJX-_KFzfINCV2Cqx8o6OWOt3C16rQd84,3142
-caselawclient/factories.py,sha256=6-xZMVmvtXA8AnyWJgJTums1EWfM6lPIhrWQu0NopJo,4472
-caselawclient/identifier_resolution.py,sha256=IOqrZcIHoHhNOCAkNveOBcWddBNpkOB8cz1r0zFa8mQ,1829
+caselawclient/factories.py,sha256=_ey9KTu393H9q1hWAjr5LIp4oYzDre55QpVMkmxNSb0,6223
+caselawclient/identifier_resolution.py,sha256=pqapUH8oiZF3ie-s_CI0hvZwH__JVcjJ4VxkpBxswmA,2354
 caselawclient/models/__init__.py,sha256=kd23EUpvaC7aLHdgk8farqKAQEx3lf7RvNT2jEatvlg,68
-caselawclient/models/documents/__init__.py,sha256=huZ-aQ-tsfuWScqSPkBAAQ9dhYa98fdd5eHwO85s_BQ,19456
-caselawclient/models/documents/body.py,sha256=7Sj6lnddcAM8VAeecAS2VEhQHR9CB3G0fL8TAXz7EXw,5588
-caselawclient/models/documents/exceptions.py,sha256=rw1xId16vBKvBImgFmFUpeFgKqU7VTNtVLIEVBPGKyk,374
+caselawclient/models/documents/__init__.py,sha256=LNo9FVKkF9rGzmJ4swEKrKXvimpvenE3OU_Z3Rt6Jic,18230
+caselawclient/models/documents/body.py,sha256=mhPOV1cOF3RJr69UzNPlo1KrzePaj7KDPYi1exP06L0,5880
+caselawclient/models/documents/exceptions.py,sha256=Mz1P8uNqf5w6uLnRwJt6xK7efsVqtd5VA-WXUUH7QLk,285
 caselawclient/models/documents/statuses.py,sha256=Cp4dTQmJOtsU41EJcxy5dV1841pGD2PNWH0VrkDEv4Q,579
 caselawclient/models/documents/transforms/html.xsl,sha256=oSSO-IBX4qLiSWexQYmWJfGNevF09aCBx4D1NYqXxpo,38322
 caselawclient/models/documents/xml.py,sha256=HlmPb63lLMnySSOLP4iexcAyQiLByKBZtTd25f8sY8M,1268
@@ -18,19 +18,20 @@ caselawclient/models/identifiers/fclid.py,sha256=pTO586ra0sr4DbjHSxuI8UlxfNXLm9n
 caselawclient/models/identifiers/neutral_citation.py,sha256=3Jw1_-NmGfGmrWGFSzLdTHBYHIHq4tPkF8U7Jba-jGo,1848
 caselawclient/models/identifiers/press_summary_ncn.py,sha256=r55-qgi9LDnGxY8vTKijzotGknA6mNLpu55QQTV8Lxo,652
 caselawclient/models/identifiers/unpacker.py,sha256=xvp480QESbN36NEc6qeo-orqOBq6WchnLI7thY7A1qs,2156
-caselawclient/models/judgments.py,sha256=xFjfOspa9ZL29gvvGVNq11JC7h-LKebFMrQYvVIIoEI,1868
+caselawclient/models/judgments.py,sha256=H_-t4mCa3LdYu1cLOhQB5n045RdJghWpqS5hgPPDE4U,2170
 caselawclient/models/neutral_citation_mixin.py,sha256=jAac3PPuWyPdj9N-n-U_JfwkbgbSIXaqFVQahfu95do,2086
-caselawclient/models/press_summaries.py,sha256=bEqJxu-7eBLhwulOsDXYDl2ptIp3RkkMpOcdVvWB5ds,1836
+caselawclient/models/press_summaries.py,sha256=a50KdX_v41G_eI5h6_HuA2hvrhOA2EDvoTYBi5va1e8,2101
 caselawclient/models/utilities/__init__.py,sha256=u3yIhbTjFQ1JJyAm5wsMEBswWl4t6Z7UMORF5FqC2xQ,1257
-caselawclient/models/utilities/aws.py,sha256=5UJhxdGwYwH0bswi3q9nzmXcioPz9t_lNWYmP45RyK4,8842
+caselawclient/models/utilities/aws.py,sha256=E4nFcNC2xxPUv0Xkfi2XTO3FyIH6jaAy9pgsvR48Eg8,8759
 caselawclient/models/utilities/dates.py,sha256=WwORxVjUHM1ZFcBF6Qtwo3Cj0sATsnSECkUZ6ls1N1Q,492
-caselawclient/models/utilities/move.py,sha256=Rsx1eGHVjbGz0WMVDjy8b_5t4Ig8aP55sLudL07MVUs,3621
+caselawclient/models/utilities/move.py,sha256=MXdUqkSiyqRb8YKs_66B6ICWn8EWM6DiJV95fuJO1Us,3610
 caselawclient/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 caselawclient/responses/__init__.py,sha256=2-5NJn_PXPTje_W4dHeHYaNRN6vXK4UcB9eLLNUAKa4,67
 caselawclient/responses/search_response.py,sha256=Z76Zj4VvM-EV_vdiehv2-Jfkr9HZD3SvCTlRrUB_cyE,1951
-caselawclient/responses/search_result.py,sha256=2yR3FP4CQsVymE7RrOMbh1owjYaRTrqkjMObbIkSlhE,8216
+caselawclient/responses/search_result.py,sha256=hotJHJ9wQusjb4PjZm1DDZv2HEsXWTtZU5TOTj2T0rw,8205
 caselawclient/responses/xsl/search_match.xsl,sha256=4Sv--MrwBd7J48E9aI7jlFSXGlNi4dBqgzJ3bdMJ_ZU,1018
 caselawclient/search_parameters.py,sha256=nR-UC1aWZbdXzXBrVDaHECU4Ro8Zi4JZATtgrpAVsKY,3342
+caselawclient/types.py,sha256=gedGlrO1ZA_wYdCuquwi6seFr5OqTPxi1O0D_lKdEps,1087
 caselawclient/xml_helpers.py,sha256=FEtE8gxaEZmcgua-Xu8awPmiOm9K58OSabEYVGpiVEY,493
 caselawclient/xquery/break_judgment_checkout.xqy,sha256=rISzoBKxQKrP5ZRdCSoRqOXW8T_NDBSZRFjOXo_H3ns,220
 caselawclient/xquery/checkin_judgment.xqy,sha256=QeGqO3kL-q0UrjopCVU0lCbkwbyoc5SuNLYFAIbbyMg,197
@@ -59,7 +60,8 @@ caselawclient/xquery/get_version_annotation.xqy,sha256=pFDMGA9SxI59iUPaoAeUsq23k
 caselawclient/xquery/get_version_created.xqy,sha256=bRweaXFtwMBNzL16SlOdiOxHkbqNUwpwDHLxpZYVCh0,250
 caselawclient/xquery/insert_document.xqy,sha256=iP2xTaLGa-u6X9KfS1yJ6yPCKQUWQFYdEW1S4YcMY7w,531
 caselawclient/xquery/list_judgment_versions.xqy,sha256=WShga8igeD21hSLfVSvCOiDMPDhNH6KGf1OW6G0SAkY,190
-caselawclient/xquery/resolve_from_identifier.xqy,sha256=Fa-RSw9ZwD__BmT5LLJ0J0HcDstDbedkEccv45M3L4g,484
+caselawclient/xquery/resolve_from_identifier_slug.xqy,sha256=Fa-RSw9ZwD__BmT5LLJ0J0HcDstDbedkEccv45M3L4g,484
+caselawclient/xquery/resolve_from_identifier_value.xqy,sha256=7uP3DnRi67qSp0aUhW6Cv_GA8BQGw6GuvtAghjrT7Z4,493
 caselawclient/xquery/set_boolean_property.xqy,sha256=8Vg3yDWqeDynUJQHw2OF4daDIKTnp8ARol1_OCqY0Dk,355
 caselawclient/xquery/set_metadata_citation.xqy,sha256=ImwijXowvOCiH_br_LepnKsEpys9tg4Cf3uz6MoC5-c,659
 caselawclient/xquery/set_metadata_court.xqy,sha256=xQGR3e4pdJuDPMlzdAdzrBDSeQbEFiLVIm2z_KQI_Ds,996
@@ -77,8 +79,8 @@ caselawclient/xquery/validate_all_documents.xqy,sha256=z_0YEXmRcZ-FaJM0ouKiTjdI4
 caselawclient/xquery/validate_document.xqy,sha256=PgaDcnqCRJPIVqfmWsNlXmCLNKd21qkJrvY1RtNP7eA,140
 caselawclient/xquery/xslt.xqy,sha256=w57wNijH3dkwHkpKeAxqjlghVflQwo8cq6jS_sm-erM,199
 caselawclient/xquery/xslt_transform.xqy,sha256=smyFFxqmtkuOzBd2l7uw6K2oAsYctudrP8omdv_XNAM,2463
-caselawclient/xquery_type_dicts.py,sha256=kybL-YzwK34Fr6MeWfqVOJHYrs0ZNeDWXDsp8o2Yb1U,6114
-ds_caselaw_marklogic_api_client-29.2.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
-ds_caselaw_marklogic_api_client-29.2.0.dist-info/METADATA,sha256=ALbG5q-13rqmY9R-1lUB7LLUnZppeBT4A9xssTV5skM,4264
-ds_caselaw_marklogic_api_client-29.2.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
-ds_caselaw_marklogic_api_client-29.2.0.dist-info/RECORD,,
+caselawclient/xquery_type_dicts.py,sha256=IElFK9aFZboNgKytRjK2EQPIJJcXXw9NVfRTWKx2zJo,6283
+ds_caselaw_marklogic_api_client-31.0.0.dist-info/LICENSE.md,sha256=fGMzyyLuQW-IAXUeDSCrRdsYW536aEWThdbpCjo6ZKg,1108
+ds_caselaw_marklogic_api_client-31.0.0.dist-info/METADATA,sha256=QR0bbqSK9ZROZon7RZII--oK8fBuKoMRk94JTOE57Zc,4262
+ds_caselaw_marklogic_api_client-31.0.0.dist-info/WHEEL,sha256=7Z8_27uaHI_UZAc4Uox4PpBhQ9Y5_modZXWMxtUi4NU,88
+ds_caselaw_marklogic_api_client-31.0.0.dist-info/RECORD,,