prez-lib 4.0.0

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, RDFLib Team
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,34 @@
+# Prez Lib
+A JS library for processing RDF data for use with Prez UI, implementing [RDF/JS types](https://github.com/rdfjs/types) and [N3.js](https://github.com/rdfjs/N3.js).
+
+## Installing
+
+```bash
+npm install prez-lib
+```
+
+## Example Usage
+Using the factory functions:
+```typescript
+import { literal, node } from "prez-lib";
+
+const term = node({
+    value: "https://example.com",
+    label: literal("term"),
+    links: [
+        {
+            value: "/"
+        }
+    ],
+});
+```
+
+Using the store class:
+```typescript
+import { RDFStore } from "prez-lib";
+
+const data = "<https://example.com/subject> <https://example.com/predicate> <https://example.com/object> .";
+const store = new RDFStore();
+store.load(data);
+const data = store.getItem();
+```

package/dist/consts.d.ts

@@ -0,0 +1,37 @@
+import { PrezPrefixes } from './types';
+export declare const DEFAULT_PREFIXES: PrezPrefixes;
+export declare const PREZ_PREDICATES: {
+    namespace: string;
+    label: string;
+    description: string;
+    provenance: string;
+    focusNode: string;
+    link: string;
+    members: string;
+    identifier: string;
+    count: string;
+    searchResult: string;
+    searchResultWeight: string;
+    searchResultPredicate: string;
+    searchResultURI: string;
+    searchResultMatch: string;
+    hasChildren: string;
+};
+export declare const SYSTEM_PREDICATES: {
+    skosConceptScheme: string;
+    skosConcept: string;
+    a: string;
+    rdfLangString: string;
+    xmlString: string;
+    w3Html: string;
+    w3Markdown: string;
+    shaclAllPredicates: string;
+    shaclProperty: string;
+    shaclPath: string;
+    shaclUnion: string;
+};
+export declare const ANNOTATION_PREDICATES: {
+    label: string[];
+    description: string[];
+    provenance: string[];
+};

package/dist/factory.d.ts

@@ -0,0 +1,5 @@
+import { PrezNode, PrezLiteral, PrezBlankNode, PrezTerm } from './types';
+export declare function isTypePrezTerm(obj: any): obj is PrezTerm;
+export declare function node(objOrValue: Omit<PrezNode, "termType" | "equals"> | string): PrezNode;
+export declare function literal(objOrValue: Omit<PrezLiteral, "termType" | "equals"> | string): PrezLiteral;
+export declare function bnode(objOrValue: Omit<PrezBlankNode, "termType" | "equals"> | string): PrezBlankNode;

package/dist/helpers.d.ts

@@ -0,0 +1,76 @@
+import { PrezPrefixes, PrezConceptNode, PrezFocusNode } from './types';
+/**
+ * Interprets a predicate curie into its full IRI
+ *
+ * Uses the default list of prefixes by default
+ *
+ * @param s
+ * @param prefixes
+ * @returns Predicate IRI string
+ */
+export declare function defaultToIri(s: string, prefixes?: PrezPrefixes): string;
+/**
+ * Creates a curie from an IRI
+ *
+ * Uses the default list of prefixes by default
+ *
+ * @param iri
+ * @param prefixes
+ * @returns curie string
+ */
+export declare function defaultFromIri(iri: string, prefixes?: PrezPrefixes): string;
+/**
+ * Get the base URL from a URL, protocol & host
+ *
+ * @param existingUrl existing URL to determine the base from
+ * @returns
+ */
+export declare const getBaseUrl: (existingUrl: string) => string;
+/**
+ * Get the URL path (minus the protocol & host) from a full URL
+ *
+ *
+ * @param existingUrl existing URL to determine the base from
+ * @returns
+ */
+export declare const getUrlPath: (existingUrl: string) => string;
+/**
+ * Get the narrowers URL for a hierarchy based on an a concept and existing URL context
+ *
+ * @param concept
+ * @param existingUrl
+ * @returns
+ */
+export declare const getNarrowersUrl: (baseUrl: string, concept: PrezConceptNode) => string;
+/**
+ * Get the top concepts for a given focus node
+ *
+ * @param item
+ * @param existingOrBaseUrl to use for prefixing
+ * @returns
+ */
+export declare const getTopConceptsUrl: (item: PrezFocusNode, existingOrBaseUrl?: string) => string;
+type PathElement = {
+    "@id"?: string;
+    "@list"?: PathElement[];
+};
+/**
+ * Process a SHACL path to get the full list of predicates
+ *
+ * @param path
+ * @returns
+ */
+export declare const processShaclPath: (path: PathElement[]) => string[];
+/**
+ * Build a profile object from a list of profiles
+ *
+ * @param data - list of profiles in json-ld format
+ * @returns
+ */
+export declare const buildProfiles: (data: any[]) => Record<string, string[]>;
+/** this function is used to construct a simple object to show profile info in the debug panel */
+export declare function simplifyNodeArray(input: any): any;
+export declare function nodeArrayToTree(obj: any, prefix?: string): string;
+/** this function is used to dump a profile node array into a simple string tree */
+export declare function dumpNodeArray(obj: any): string;
+export {};

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export * from './types';
+export * from './factory';
+export * from './store';
+export * from './service';
+export * from './helpers';
+export * from './consts';