@3sixty/data-json-ld 0.0.0-stage → 0.20.0-next.1

package/dist/types/models/IJsonLdNodeObject.d.ts

@@ -0,0 +1,19 @@
+import type { IJsonLdIdMap } from "./IJsonLdIdMap.js";
+import type { IJsonLdIncludedBlock } from "./IJsonLdIncludedBlock.js";
+import type { IJsonLdIndexMap } from "./IJsonLdIndexMap.js";
+import type { IJsonLdLanguageMap } from "./IJsonLdLanguageMap.js";
+import type { IJsonLdNodePrimitive } from "./IJsonLdNodePrimitive.js";
+import type { IJsonLdObject } from "./IJsonLdObject.js";
+import type { IJsonLdTypeMap } from "./IJsonLdTypeMap.js";
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * A node object represents zero or more properties of a node
+ * in the graph serialized by the JSON-LD document.
+ * @see https://www.w3.org/TR/json-ld11/#node-objects
+ */
+export interface IJsonLdNodeObject extends IJsonLdObject {
+    [key: string]: IJsonLdNodePrimitive | IJsonLdNodePrimitive[] | IJsonLdLanguageMap | IJsonLdIndexMap | IJsonLdIncludedBlock | IJsonLdIdMap | IJsonLdTypeMap | IJsonLdNodeObject[keyof IJsonLdNodeObject];
+}

package/dist/types/models/IJsonLdNodePrimitive.d.ts

@@ -0,0 +1,13 @@
+import type { IJsonLdGraphObject } from "./IJsonLdGraphObject.js";
+import type { IJsonLdListObject } from "./IJsonLdListObject.js";
+import type { IJsonLdNodeObject } from "./IJsonLdNodeObject.js";
+import type { IJsonLdSetObject } from "./IJsonLdSetObject.js";
+import type { IJsonLdValueObject } from "./IJsonLdValueObject.js";
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * A node primitive is a JSON-LD value which is not one of the defined NodeObject properties.
+ */
+export type IJsonLdNodePrimitive = null | boolean | number | string | IJsonLdNodeObject | IJsonLdGraphObject | IJsonLdValueObject | IJsonLdListObject | IJsonLdSetObject;

package/dist/types/models/IJsonLdObject.d.ts

@@ -0,0 +1,25 @@
+import type { IJsonLdContextDefinitionRoot } from "./IJsonLdContextDefinitionRoot.js";
+import type { IJsonLdIncludedBlock } from "./IJsonLdIncludedBlock.js";
+import type { IJsonLdJsonObject } from "./IJsonLdJsonObject.js";
+import type { IJsonLdNodeObject } from "./IJsonLdNodeObject.js";
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * An object represents the pre-defined properties of the node object
+ * in the graph serialized by the JSON-LD document.
+ * @see https://www.w3.org/TR/json-ld11/#node-objects
+ */
+export interface IJsonLdObject {
+    "@context"?: IJsonLdContextDefinitionRoot | undefined;
+    "@id"?: string | string[] | undefined;
+    "@included"?: IJsonLdIncludedBlock | undefined;
+    "@graph"?: IJsonLdNodeObject | IJsonLdNodeObject[] | undefined;
+    "@nest"?: IJsonLdJsonObject | IJsonLdJsonObject[] | undefined;
+    "@type"?: string | string[] | undefined;
+    "@reverse"?: {
+        [key: string]: string;
+    } | undefined;
+    "@index"?: string | undefined;
+}

package/dist/types/models/IJsonLdSetObject.d.ts

@@ -0,0 +1,13 @@
+import type { IJsonLdListOrSetItem } from "./IJsonLdListOrSetItem.js";
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * A set represents an unordered set of values.
+ * @see https://www.w3.org/TR/json-ld11/#lists-and-sets
+ */
+export interface IJsonLdSetObject {
+    "@set": IJsonLdListOrSetItem | IJsonLdListOrSetItem[];
+    "@index"?: string | undefined;
+}

package/dist/types/models/IJsonLdTypeMap.d.ts

@@ -0,0 +1,12 @@
+import type { IJsonLdNodeObject } from "./IJsonLdNodeObject.js";
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * A type map is used to associate an IRI with a value that allows easy programmatic access.
+ * @see https://www.w3.org/TR/json-ld11/#type-maps
+ */
+export interface IJsonLdTypeMap {
+    [key: string]: string | IJsonLdNodeObject;
+}

package/dist/types/models/IJsonLdValueObject.d.ts

@@ -0,0 +1,26 @@
+import type { IJsonLdContextDefinitionRoot } from "./IJsonLdContextDefinitionRoot.js";
+import type { IJsonLdJsonArray } from "./IJsonLdJsonArray.js";
+import type { IJsonLdJsonObject } from "./IJsonLdJsonObject.js";
+/**
+ * This is a copy of the types from the npm jsonld package. This is necessary as the JSON schema generators
+ * that are used in other packages cannot understand some of the types e.g. OrArray
+ */
+/**
+ * A value object is used to explicitly associate a type or a language with a value
+ * to create a typed value or a language-tagged string and possibly associate a base direction.
+ * @see https://www.w3.org/TR/json-ld11/#value-objects
+ */
+export type IJsonLdValueObject = {
+    "@index"?: string | undefined;
+    "@context"?: IJsonLdContextDefinitionRoot | undefined;
+} & ({
+    "@value": null | boolean | number | string;
+    "@language"?: string | undefined;
+    "@direction"?: "ltr" | "rtl" | null | undefined;
+} | {
+    "@value": null | boolean | number | string;
+    "@type": string;
+} | {
+    "@value": null | boolean | number | string | IJsonLdJsonObject | IJsonLdJsonArray;
+    "@type": "@json";
+});

package/dist/types/models/jsonLdContexts.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The contexts of JSON-LD data.
+ */
+export declare const JsonLdContexts: {
+    /**
+     * The canonical RDF namespace URI for JSON-LD.
+     */
+    readonly Namespace: "https://schema.3sixty.global/json-ld/";
+    /**
+     * The value to use in JSON-LD context for JSON-LD.
+     */
+    readonly Context: "https://schema.3sixty.global/json-ld/";
+    /**
+     * The JSON-LD Context URL for JSON-LD.
+     */
+    readonly JsonLdContext: "https://schema.3sixty.global/json-ld/types.jsonld";
+};
+/**
+ * The contexts of JSON-LD data.
+ */
+export type JsonLdContexts = (typeof JsonLdContexts)[keyof typeof JsonLdContexts];

package/dist/types/models/jsonLdTypes.d.ts

@@ -0,0 +1,113 @@
+/**
+ * The types of JSON-LD data.
+ */
+export declare const JsonLdTypes: {
+    /**
+     * Represents JSON-LD Document.
+     */
+    readonly Document: "JsonLdDocument";
+    /**
+     * Represents JSON-LD Object.
+     */
+    readonly Object: "JsonLdObject";
+    /**
+     * Represents JSON-LD Node Object.
+     */
+    readonly NodeObject: "JsonLdNodeObject";
+    /**
+     * Represents JSON-LD Node Primitive.
+     */
+    readonly NodePrimitive: "JsonLdNodePrimitive";
+    /**
+     * Represents JSON-LD Graph Object.
+     */
+    readonly GraphObject: "JsonLdGraphObject";
+    /**
+     * Represents JSON-LD Value Object.
+     */
+    readonly ValueObject: "JsonLdValueObject";
+    /**
+     * Represents JSON-LD List Object.
+     */
+    readonly ListObject: "JsonLdListObject";
+    /**
+     * Represents JSON-LD Set Object.
+     */
+    readonly SetObject: "JsonLdSetObject";
+    /**
+     * Represents JSON-LD Language Map.
+     */
+    readonly LanguageMap: "JsonLdLanguageMap";
+    /**
+     * Represents JSON-LD Index Map.
+     */
+    readonly IndexMap: "JsonLdIndexMap";
+    /**
+     * Represents JSON-LD Index Map Item.
+     */
+    readonly IndexMapItem: "JsonLdIndexMapItem";
+    /**
+     * Represents JSON-LD Id Map.
+     */
+    readonly IdMap: "JsonLdIdMap";
+    /**
+     * Represents JSON-LD Type Map.
+     */
+    readonly TypeMap: "JsonLdTypeMap";
+    /**
+     * Represents JSON-LD Included block.
+     */
+    readonly IncludedBlock: "JsonLdIncludedBlock";
+    /**
+     * Represents JSON-LD Context Definition.
+     */
+    readonly ContextDefinition: "JsonLdContextDefinition";
+    /**
+     * Represents JSON-LD Context Definition Element.
+     */
+    readonly ContextDefinitionElement: "JsonLdContextDefinitionElement";
+    /**
+     * Represents JSON-LD Context Definition Root.
+     */
+    readonly ContextDefinitionRoot: "JsonLdContextDefinitionRoot";
+    /**
+     * Represents JSON-LD Expanded Term Definition.
+     */
+    readonly ExpandedTermDefinition: "JsonLdExpandedTermDefinition";
+    /**
+     * Represents JSON-LD Keyword.
+     */
+    readonly Keyword: "JsonLdKeyword";
+    /**
+     * Represents JSON-LD List or Set Item.
+     */
+    readonly ListOrSetItem: "JsonLdListOrSetItem";
+    /**
+     * Represents JSON-LD Container Type.
+     */
+    readonly ContainerType: "JsonLdContainerType";
+    /**
+     * Represents JSON-LD Container Type Array.
+     */
+    readonly ContainerTypeArray: "JsonLdContainerTypeArray";
+    /**
+     * Represents JSON-LD JSON Primitive.
+     */
+    readonly JsonPrimitive: "JsonLdJsonPrimitive";
+    /**
+     * Represents JSON-LD JSON Array.
+     */
+    readonly JsonArray: "JsonLdJsonArray";
+    /**
+     * Represents JSON-LD JSON Object.
+     */
+    readonly JsonObject: "JsonLdJsonObject";
+    /**
+     * Represents JSON-LD JSON Value.
+     */
+    readonly JsonValue: "JsonLdJsonValue";
+};
+/**
+ * The types of JSON-LD data.
+ */
+export type JsonLdTypes = (typeof JsonLdTypes)[keyof typeof JsonLdTypes];

package/dist/types/utils/jsonLdHelper.d.ts

@@ -0,0 +1,97 @@
+import { type IValidationFailure } from "@3sixty/core";
+import { type ValidationMode } from "@3sixty/data-core";
+import type { IJsonLdDocument } from "../models/IJsonLdDocument.js";
+import type { IJsonLdNodeObject } from "../models/IJsonLdNodeObject.js";
+import type { IJsonLdNodePrimitive } from "../models/IJsonLdNodePrimitive.js";
+/**
+ * Class to help with JSON LD.
+ */
+export declare class JsonLdHelper {
+    /**
+     * Validate a JSON-LD document.
+     * @param document The JSON-LD document to validate.
+     * @param validationFailures The list of validation failures to add to.
+     * @param options Optional options for validation.
+     * @param options.failOnMissingType If true, will fail validation if the data type is missing, defaults to false.
+     * @param options.validationMode The validation mode to use, defaults to either.
+     * @returns True if the document was valid.
+     */
+    static validate<T extends IJsonLdDocument = IJsonLdDocument>(document: T, validationFailures: IValidationFailure[], options?: {
+        validationMode?: ValidationMode;
+        failOnMissingType?: boolean;
+    }): Promise<boolean>;
+    /**
+     * Convert an object to a JSON-LD node object.
+     * @param object The object to convert.
+     * @returns The JSON-LD node object.
+     */
+    static toNodeObject<T = unknown>(object: T): T & IJsonLdNodeObject;
+    /**
+     * Convert the JSON-LD node object to a structured object.
+     * @param nodeObject The JSON-LD node object to convert.
+     * @returns The structured object.
+     */
+    static toStructuredObject<T = unknown>(nodeObject: IJsonLdNodeObject): T;
+    /**
+     * Expand the JSON-LD document.
+     * @param document The JSON-LD document to expand.
+     * @returns The expanded JSON-LD document.
+     */
+    static expand(document: IJsonLdDocument): Promise<IJsonLdNodeObject[]>;
+    /**
+     * Expand the JSON-LD document and check if it is of a specific type.
+     * @param documentOrExpanded The JSON-LD document to check or already expanded document.
+     * @param type The type to check for.
+     * @returns True if the document is of the specified type.
+     */
+    static isType(documentOrExpanded: IJsonLdDocument | IJsonLdNodeObject[], type: string[]): Promise<boolean>;
+    /**
+     * Get the types from the document.
+     * @param documentOrExpanded The JSON-LD document to check or already expanded document.
+     * @returns The type(s) extracted from the document.
+     */
+    static getType(documentOrExpanded: IJsonLdDocument | IJsonLdNodeObject[]): Promise<string[]>;
+    /**
+     * Get the id from the document.
+     * @param documentOrExpanded The JSON-LD document to get the id from or already expanded document.
+     * @param additionalIdProperties Optional additional properties to check for the id, in addition to "@id" and "id".
+     * @returns The id extracted from the document.
+     */
+    static getId(documentOrExpanded: IJsonLdDocument | IJsonLdNodeObject[], additionalIdProperties?: string[]): Promise<string | undefined>;
+    /**
+     * Get property values by a single full expanded property name.
+     * @param documentOrExpanded The JSON-LD document to get the property from or already expanded document.
+     * @param propertyFullName The full expanded property name.
+     * @param language Optional filter values by their language property.
+     * @returns Matching property values for the input property.
+     */
+    static getPropertyValue(documentOrExpanded: IJsonLdDocument | IJsonLdNodeObject[], propertyFullName: string, language?: string): Promise<IJsonLdNodePrimitive[] | undefined>;
+    /**
+     * Get property values by their full expanded property names.
+     * @param documentOrExpanded The JSON-LD document to get the property from or already expanded document.
+     * @param propertyFullNames The full expanded property names.
+     * @param language Optional filter values by their language property.
+     * @returns Matching property values for each input property, in the same index order.
+     */
+    static getPropertyValues(documentOrExpanded: IJsonLdDocument | IJsonLdNodeObject[], propertyFullNames: string[], language?: string): Promise<(IJsonLdNodePrimitive[] | undefined)[]>;
+    /**
+     * Prefix all properties in the document with the provided prefix, except for JSON-LD properties.
+     * This is useful for ensuring that all properties are fully qualified with a namespace.
+     * For example, if the prefix is "ex" and the document has a property "name", it will be transformed to "ex:name".
+     * @param nodeObject The JSON-LD node object to prefix properties on.
+     * @param prefix The prefix to add to the properties.
+     * @param properties Optional list of properties to prefix. If not provided, all properties except for JSON-LD properties.
+     * @returns A new JSON-LD node object with the properties prefixed.
+     */
+    static prefixProperties<T extends IJsonLdNodeObject>(nodeObject: T, prefix: string, properties?: string[]): IJsonLdNodeObject;
+    /**
+     * Strip a prefix from properties in the document, except for JSON-LD properties.
+     * This is useful for converting fully qualified namespaced properties back to local names.
+     * For example, if the prefix is "ex" and the document has a property "ex:name", it will be transformed to "name".
+     * @param nodeObject The JSON-LD node object to strip prefixed properties from.
+     * @param prefix The prefix to remove from the properties.
+     * @param properties Optional list of unprefixed properties to strip. If not provided, all matching prefixed properties.
+     * @returns A new JSON-LD node object with the prefix stripped from matching properties.
+     */
+    static stripPrefixProperties<T extends IJsonLdNodeObject>(nodeObject: T, prefix: string, properties?: string[]): IJsonLdNodeObject;
+}

package/dist/types/utils/jsonLdProcessor.d.ts

@@ -0,0 +1,117 @@
+import type { RemoteDocument, Url } from "jsonld/jsonld-spec.js";
+import type { IJsonLdContextDefinitionElement } from "../models/IJsonLdContextDefinitionElement.js";
+import type { IJsonLdContextDefinitionRoot } from "../models/IJsonLdContextDefinitionRoot.js";
+import type { IJsonLdNodeObject } from "../models/IJsonLdNodeObject.js";
+/**
+ * JSON-LD Processor.
+ */
+export declare class JsonLdProcessor {
+    /**
+     * Set the document loader used for retrieving JSON-LD documents.
+     * @param documentLoader The document loader to use.
+     */
+    static setDocumentLoader(documentLoader: (url: Url) => Promise<RemoteDocument>): void;
+    /**
+     * Get the document loader used for retrieving JSON-LD documents.
+     * @returns The active document loader function.
+     */
+    static getDocumentLoader(): (url: Url) => Promise<RemoteDocument>;
+    /**
+     * Set the cache time limit for documents.
+     * @param cacheLimitMs The cache limit in milliseconds.
+     */
+    static setCacheLimit(cacheLimitMs: number): void;
+    /**
+     * Get the cache limit for documents.
+     * @returns The cache limit in milliseconds.
+     */
+    static getCacheLimit(): number;
+    /**
+     * Replace the global redirect list (use {@link JsonLdProcessor.addRedirect} to append without replacing).
+     * Redirects run before any HTTP GET or `Link` discovery; use them for stable overrides, tests, or hosts that do not expose a suitable `Link` header.
+     * @param redirects The redirects to use.
+     */
+    static setRedirects(redirects: {
+        from: RegExp;
+        to: string;
+    }[]): void;
+    /**
+     * Get the global redirects for JSON-LD.
+     * @returns The registered redirects.
+     */
+    static getRedirects(): {
+        from: RegExp;
+        to: string;
+    }[];
+    /**
+     * Append a redirect rule (ignored if the same `RegExp.source` is already registered).
+     * Optional when the vocabulary URL supports HTTP `Link` discovery (`rel` includes `alternate`, `type` is `application/ld+json`) via the default document loader.
+     * Standards packages often expose `registerRedirects()` helpers that call this method; those are optional for the same reason.
+     * @param from The URL to redirect from.
+     * @param to The URL to redirect to.
+     */
+    static addRedirect(from: RegExp, to: string): void;
+    /**
+     * Compact a document according to a particular context.
+     * @param document The JSON-LD document to compact.
+     * @param context The context to compact the document to, if not provided will use the one in the document.
+     * @param options The options for compacting the document.
+     * @param options.compactArrays Whether to allow single-item arrays to be compacted to scalars, defaults to true (matches jsonld.js default behaviour). Set to false to preserve all single-item arrays.
+     * @param options.noCompactProperties Additional dot-notation property paths that must always remain arrays, merged with the built-in always-array set.
+     * @returns The compacted JSON-LD document.
+     */
+    static compact<T>(document: T, context?: IJsonLdContextDefinitionRoot, options?: {
+        compactArrays?: boolean;
+        noCompactProperties?: string[];
+    }): Promise<T>;
+    /**
+     * Expand a document, removing its context.
+     * @param compacted The compacted JSON-LD document to expand.
+     * @returns The expanded JSON-LD document.
+     */
+    static expand<T>(compacted: T): Promise<IJsonLdNodeObject[]>;
+    /**
+     * Canonize a document.
+     * @param document The document to canonize.
+     * @param options The options for canonization.
+     * @param options.algorithm The algorithm to use for canonization, defaults to URDNA2015.
+     * @returns The canonized document.
+     */
+    static canonize<T extends IJsonLdNodeObject>(document: T, options?: {
+        algorithm?: "URDNA2015" | "URGNA2012" | undefined;
+    }): Promise<string>;
+    /**
+     * Combine contexts.
+     * @param context1 The first JSON-LD context to combine.
+     * @param context2 The second JSON-LD context to combine.
+     * @returns The combined context.
+     */
+    static combineContexts(context1: IJsonLdContextDefinitionRoot | undefined, context2: IJsonLdContextDefinitionRoot | undefined): IJsonLdContextDefinitionRoot | undefined;
+    /**
+     * Gather all the contexts from the element and it's children.
+     * @param element The element to gather the contexts from.
+     * @param initial The initial context.
+     * @returns The combined contexts.
+     */
+    static gatherContexts<T>(element: T, initial?: IJsonLdContextDefinitionRoot): IJsonLdContextDefinitionRoot | undefined;
+    /**
+     * Remove all the contexts that match the pattern.
+     * @param context The context to remove the entries from.
+     * @param match The element to try and match.
+     * @returns The updated contexts.
+     */
+    static removeContexts(context: IJsonLdContextDefinitionRoot | undefined, match?: IJsonLdContextDefinitionElement[]): IJsonLdContextDefinitionRoot | undefined;
+    /**
+     * Add a context directly to the document loader cache.
+     * @param url The url the ld context is for.
+     * @param ldContext The context to add.
+     * @returns A promise that resolves when the entry has been stored in the cache.
+     */
+    static documentCacheAdd(url: string, ldContext: unknown): Promise<void>;
+    /**
+     * Remove a context from the document loader cache.
+     * @param url The url the ld context is for.
+     * @returns A promise that resolves when the entry has been removed from the cache.
+     */
+    static documentCacheRemove(url: string): Promise<void>;
+}

package/docs/changelog.md

@@ -0,0 +1,15 @@
+# Changelog
+
+## [0.20.0-next.1](https://github.com/3sixtyglobal/data/compare/data-json-ld-v0.20.0-next.0...data-json-ld-v0.20.0-next.1) (2026-10-09)
+
+
+### Features
+
+* publish packages under the [@3sixty](https://github.com/3sixty) namespace ([a556efc](https://github.com/3sixtyglobal/data/commit/a556efcb6b4c0143b1c4012731a9860f035c9ee8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @3sixty/data-core bumped from 0.20.0-next.0 to 0.20.0-next.1