prez-lib 4.3.0 → 4.3.1

package/dist/service.d.ts

@@ -1,4 +1,4 @@
-import { PrezDataItem, PrezDataList, PrezDataSearch, PrezNodeList, PrezProfileHeader, PrezProfiles } from './types';
+import { PrezDataItem, PrezDataList, PrezDataSearchDefault, PrezDataSearchLuceneShacl, PrezNodeList, PrezProfileHeader, PrezProfiles, PrezSearchOptionsDefault, PrezSearchOptionsLuceneShacl } from './types';
 /**
  * Does a GET request to a Prez API endpoint
  *
@@ -31,7 +31,8 @@ export declare function getItem(baseUrl: string, path: string): Promise<PrezData
  * @param path Search path along with any query parameters
  * @returns
  */
-export declare function search(baseUrl: string, path: string): Promise<PrezDataSearch>;
+export declare function search(baseUrl: string, path: string, options?: PrezSearchOptionsDefault): Promise<PrezDataSearchDefault>;
+export declare function search(baseUrl: string, path: string, options: PrezSearchOptionsLuceneShacl): Promise<PrezDataSearchLuceneShacl>;
 /**
  * Returns the full list of Prez Profiles used for the global profile list
  *

package/dist/store.d.ts

@@ -1,5 +1,5 @@
 import { Store, Quad_Object, Quad_Subject, Term } from 'n3';
-import { PrezNode, PrezProperties, PrezSearchResult, PrezFocusNode, PrezLink, PrezConceptSchemeNode, PrezConceptNode, PrezOntologyNode, PrezConceptSchemeOntologyNode, PrezBBlockNode, PrezLinkParent, PrezFacet } from './types';
+import { PrezBBlockNode, PrezConceptNode, PrezConceptSchemeNode, PrezConceptSchemeOntologyNode, PrezFacet, PrezFlatSearchResult, PrezFocusNode, PrezLink, PrezLinkParent, PrezLuceneShaclSearchResult, PrezNode, PrezOntologyNode, PrezProperties, PrezSearchOptionsDefault, PrezSearchOptionsLuceneShacl } from './types';
 /**
  * An in-memory N3.js store containing convenience functions
  */
@@ -50,6 +50,8 @@ export declare class RDFStore {
      */
     fromIri(iri: string): string;
     private getObjectLiteral;
+    private toSubjectTerm;
+    private getRequiredObject;
     getProperties(term: Term, options?: {
         excludePrefix?: string;
         includePrefix?: string;
@@ -78,7 +80,7 @@ export declare class RDFStore {
      * @param predicate a string or string array of predicate IRIs
      * @returns the array of objects
      */
-    getObjects(subject: string, predicate: string | string[]): Quad_Object[];
+    getObjects(subject: string | Quad_Subject | Quad_Object, predicate: string | string[]): Quad_Object[];
     getMembers(subject: string): PrezLink | undefined;
     /**
      * Returns the concept hierarchy for a vocab
@@ -125,7 +127,14 @@ export declare class RDFStore {
     /**
      * Returns search results
      */
-    search(): PrezSearchResult[];
+    private extractSearchResultHash;
+    private getSearchResultBase;
+    private getOptionalFlatSearchMatch;
+    private parseSearchMatch;
+    private parseDefaultSearchResult;
+    private parseJenaLuceneShaclSearchResult;
+    search(options?: PrezSearchOptionsDefault): PrezFlatSearchResult[];
+    search(options: PrezSearchOptionsLuceneShacl): PrezLuceneShaclSearchResult[];
     /**
      * Returns a list of facets
      *

package/dist/types.d.ts

@@ -184,16 +184,48 @@ export interface PrezProperty {
 export interface PrezProperties {
     [predicateIri: string]: PrezProperty;
 }
+export type PrezSearchParserMode = "default" | "jena-lucene-shacl";
+export type PrezSearchOptionsDefault = {
+    parserMode?: "default";
+};
+export type PrezSearchOptionsLuceneShacl = {
+    parserMode: "jena-lucene-shacl";
+};
+export type PrezSearchOptions = PrezSearchOptionsDefault | PrezSearchOptionsLuceneShacl;
+/**
+ * Represents a single predicate/snippet pair inside a Lucene SHACL search result.
+ */
+export type PrezSearchMatch = {
+    predicate: PrezNode;
+    match: PrezLiteral;
+};
 /**
- * Represents a search result
+ * Represents the default flat Prez search result shape.
  */
-export type PrezSearchResult = {
+export type PrezFlatSearchResult = {
     hash: string;
     weight: number;
     predicate: PrezNode;
     match: PrezLiteral;
     resource: PrezFocusNode;
 };
+/**
+ * Backwards-compatible alias for the default flat search result shape.
+ */
+export type PrezSearchResult = PrezFlatSearchResult;
+/**
+ * Represents the Jena Lucene SHACL search result shape.
+ */
+export type PrezLuceneShaclSearchResult = {
+    hash: string;
+    weight: number;
+    resource: PrezFocusNode;
+    matches: PrezSearchMatch[];
+};
+/**
+ * Represents any supported Prez search result shape.
+ */
+export type PrezAnySearchResult = PrezFlatSearchResult | PrezLuceneShaclSearchResult;
 /**
  * Represents an item in Prez that contains node info and its related properties
  */
@@ -220,7 +252,7 @@ export type PrezMediatype = {
 export type PrezDataTypes = 'item' | 'list' | 'search';
 export interface PrezData {
     type: PrezDataTypes;
-    data: PrezFocusNode | PrezFocusNode[] | PrezSearchResult[];
+    data: PrezFocusNode | PrezFocusNode[] | PrezAnySearchResult[];
     profiles: PrezProfileHeader[];
     parents: PrezLinkParent[];
     facets: PrezFacet[];
@@ -236,12 +268,21 @@ export interface PrezDataItem extends PrezData {
     data: PrezFocusNode | PrezConceptSchemeNode | PrezOntologyNode | PrezConceptSchemeOntologyNode | PrezBBlockNode;
     store: RDFStore;
 }
-export interface PrezDataSearch extends PrezData {
+export interface PrezDataSearchBase extends Omit<PrezData, "type" | "data"> {
     type: 'search';
+    parserMode: PrezSearchParserMode;
     count: number;
-    data: PrezSearchResult[];
     maxReached: boolean;
 }
+export interface PrezDataSearchDefault extends PrezDataSearchBase {
+    parserMode: "default";
+    data: PrezFlatSearchResult[];
+}
+export interface PrezDataSearchLuceneShacl extends PrezDataSearchBase {
+    parserMode: "jena-lucene-shacl";
+    data: PrezLuceneShaclSearchResult[];
+}
+export type PrezDataSearch = PrezDataSearchDefault | PrezDataSearchLuceneShacl;
 export type PrezFacetValue = {
     term: (PrezLiteral | PrezNode);
     count: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prez-lib",
-  "version": "4.3.0",
+  "version": "4.3.1",
   "description": "A JS library for processing RDF data for use with Prez UI",
   "type": "module",
   "license": "BSD-3-Clause",
@@ -39,6 +39,7 @@
   "scripts": {
     "dev": "vite",
     "build": "tsc && vite build",
+    "test": "node --test tests/**/*.test.mjs",
     "types": "tsc",
     "preview": "vite preview",
     "preinstall": "npx only-allow pnpm"