@thomasfosterau/effect-rdf 0.0.0 → 0.1.0

package/dist/ShExJ-C1u_wgyD.d.mts

@@ -0,0 +1,531 @@
+import { r as ShExJError } from "./ShExError-BeYFD9rv.mjs";
+import * as S from "effect/Schema";
+import * as Effect from "effect/Effect";
+declare namespace ShExJ_d_exports {
+  export { Annotation, AnnotationSchema, Bounds, Cardinality, EachOf, EachOfSchema, Facets, IriStem, IriStemRange, IriStemRangeSchema, IriStemSchema, Label, Language, LanguageSchema, LanguageStem, LanguageStemRange, LanguageStemRangeSchema, LanguageStemSchema, LiteralStem, LiteralStemRange, LiteralStemRangeSchema, LiteralStemSchema, NodeConstraint, NodeConstraintSchema, NodeKind, ObjectLiteral, ObjectLiteralSchema, ObjectValue, ObjectValueSchema, OneOf, OneOfSchema, Schema, SchemaSchema, SemAct, SemActSchema, Shape, ShapeAnd, ShapeAndSchema, ShapeDecl, ShapeDeclSchema, ShapeExpr, ShapeExprOrRef, ShapeExprOrRefSchema, ShapeExprSchema, ShapeExternal, ShapeExternalSchema, ShapeNot, ShapeNotSchema, ShapeOr, ShapeOrSchema, ShapeSchema, TripleConstraint, TripleConstraintSchema, TripleExpr, TripleExprOrRef, TripleExprOrRefSchema, TripleExprSchema, ValueSetValue, ValueSetValueSchema, Wildcard, WildcardSchema, cardinality, context, decode, isBlankLabel, isObjectLiteral, mapIris, parse, resolveIris, stringify, toJson };
+}
+/**
+ * An IRI (absolute, after parsing) or a blank node label (`_:label`).
+ *
+ * @since 0.1.0
+ * @category models
+ */
+type Label = string;
+/**
+ * A ShEx schema.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface Schema {
+  readonly type: 'Schema';
+  readonly '@context'?: string;
+  readonly imports?: ReadonlyArray<string>;
+  readonly startActs?: ReadonlyArray<SemAct>;
+  readonly start?: ShapeExprOrRef;
+  readonly shapes?: ReadonlyArray<ShapeDecl>;
+}
+/**
+ * A labelled shape expression declaration.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface ShapeDecl {
+  readonly type: 'ShapeDecl';
+  readonly id: Label;
+  readonly abstract?: boolean;
+  readonly restricts?: ReadonlyArray<ShapeExprOrRef>;
+  readonly shapeExpr: ShapeExprOrRef;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+type ShapeExpr = ShapeOr | ShapeAnd | ShapeNot | NodeConstraint | Shape | ShapeExternal;
+/**
+ * A shape expression or a reference (label) to a declared shape expression.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+type ShapeExprOrRef = ShapeExpr | Label;
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface ShapeOr {
+  readonly type: 'ShapeOr';
+  readonly shapeExprs: ReadonlyArray<ShapeExprOrRef>;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface ShapeAnd {
+  readonly type: 'ShapeAnd';
+  readonly shapeExprs: ReadonlyArray<ShapeExprOrRef>;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface ShapeNot {
+  readonly type: 'ShapeNot';
+  readonly shapeExpr: ShapeExprOrRef;
+}
+/**
+ * A shape defined outside the schema (supplied by the validator).
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface ShapeExternal {
+  readonly type: 'ShapeExternal';
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+type NodeKind = 'iri' | 'bnode' | 'nonliteral' | 'literal';
+/**
+ * XML Schema string and numeric facets.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface Facets {
+  readonly length?: number;
+  readonly minlength?: number;
+  readonly maxlength?: number;
+  readonly pattern?: string;
+  readonly flags?: string;
+  readonly mininclusive?: number;
+  readonly minexclusive?: number;
+  readonly maxinclusive?: number;
+  readonly maxexclusive?: number;
+  readonly totaldigits?: number;
+  readonly fractiondigits?: number;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface NodeConstraint extends Facets {
+  readonly type: 'NodeConstraint';
+  readonly nodeKind?: NodeKind;
+  readonly datatype?: string;
+  readonly values?: ReadonlyArray<ValueSetValue>;
+  readonly semActs?: ReadonlyArray<SemAct>;
+  readonly annotations?: ReadonlyArray<Annotation>;
+}
+/**
+ * A literal in a value set or annotation. `type` is the datatype IRI (absent
+ * for `xsd:string` and language-tagged strings).
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface ObjectLiteral {
+  readonly value: string;
+  readonly language?: string;
+  readonly type?: string;
+}
+/**
+ * An IRI (string) or a literal.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+type ObjectValue = string | ObjectLiteral;
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface Wildcard {
+  readonly type: 'Wildcard';
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface IriStem {
+  readonly type: 'IriStem';
+  readonly stem: string;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface IriStemRange {
+  readonly type: 'IriStemRange';
+  readonly stem: string | Wildcard;
+  readonly exclusions: ReadonlyArray<string | IriStem>;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface LiteralStem {
+  readonly type: 'LiteralStem';
+  readonly stem: string;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface LiteralStemRange {
+  readonly type: 'LiteralStemRange';
+  readonly stem: string | Wildcard;
+  readonly exclusions: ReadonlyArray<string | LiteralStem>;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface Language {
+  readonly type: 'Language';
+  readonly languageTag: string;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface LanguageStem {
+  readonly type: 'LanguageStem';
+  readonly stem: string;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface LanguageStemRange {
+  readonly type: 'LanguageStemRange';
+  readonly stem: string | Wildcard;
+  readonly exclusions: ReadonlyArray<string | LanguageStem>;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+type ValueSetValue = ObjectValue | IriStem | IriStemRange | LiteralStem | LiteralStemRange | Language | LanguageStem | LanguageStemRange;
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface Shape {
+  readonly type: 'Shape';
+  readonly closed?: boolean;
+  readonly extends?: ReadonlyArray<ShapeExprOrRef>;
+  readonly extra?: ReadonlyArray<string>;
+  readonly expression?: TripleExprOrRef;
+  readonly semActs?: ReadonlyArray<SemAct>;
+  readonly annotations?: ReadonlyArray<Annotation>;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+type TripleExpr = EachOf | OneOf | TripleConstraint;
+/**
+ * A triple expression or a reference (inclusion, `&label`) to a labelled
+ * triple expression.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+type TripleExprOrRef = TripleExpr | Label;
+/**
+ * Cardinality: `max` of `-1` means unbounded. Both default to 1.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface Cardinality {
+  readonly min?: number;
+  readonly max?: number;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface EachOf extends Cardinality {
+  readonly type: 'EachOf';
+  readonly id?: Label;
+  readonly expressions: ReadonlyArray<TripleExprOrRef>;
+  readonly semActs?: ReadonlyArray<SemAct>;
+  readonly annotations?: ReadonlyArray<Annotation>;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface OneOf extends Cardinality {
+  readonly type: 'OneOf';
+  readonly id?: Label;
+  readonly expressions: ReadonlyArray<TripleExprOrRef>;
+  readonly semActs?: ReadonlyArray<SemAct>;
+  readonly annotations?: ReadonlyArray<Annotation>;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface TripleConstraint extends Cardinality {
+  readonly type: 'TripleConstraint';
+  readonly id?: Label;
+  readonly inverse?: boolean;
+  readonly predicate: string;
+  readonly valueExpr?: ShapeExprOrRef;
+  readonly semActs?: ReadonlyArray<SemAct>;
+  readonly annotations?: ReadonlyArray<Annotation>;
+}
+/**
+ * A semantic action.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface SemAct {
+  readonly type: 'SemAct';
+  readonly name: string;
+  readonly code?: string;
+}
+/**
+ * @since 0.1.0
+ * @category models
+ */
+interface Annotation {
+  readonly type: 'Annotation';
+  readonly predicate: string;
+  readonly object: ObjectValue;
+}
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const SemActSchema: S.Codec<SemAct>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const ObjectLiteralSchema: S.Codec<ObjectLiteral>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const ObjectValueSchema: S.Codec<ObjectValue>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const AnnotationSchema: S.Codec<Annotation>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const WildcardSchema: S.Codec<Wildcard>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const IriStemSchema: S.Codec<IriStem>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const LiteralStemSchema: S.Codec<LiteralStem>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const LanguageStemSchema: S.Codec<LanguageStem>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const IriStemRangeSchema: S.Codec<IriStemRange>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const LiteralStemRangeSchema: S.Codec<LiteralStemRange>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const LanguageSchema: S.Codec<Language>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const LanguageStemRangeSchema: S.Codec<LanguageStemRange>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const ValueSetValueSchema: S.Codec<ValueSetValue>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const NodeConstraintSchema: S.Codec<NodeConstraint>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const ShapeExternalSchema: S.Codec<ShapeExternal>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const ShapeOrSchema: S.Codec<ShapeOr>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const ShapeAndSchema: S.Codec<ShapeAnd>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const ShapeNotSchema: S.Codec<ShapeNot>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const ShapeSchema: S.Codec<Shape>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const ShapeExprSchema: S.Codec<ShapeExpr>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const ShapeExprOrRefSchema: S.Codec<ShapeExprOrRef>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const TripleConstraintSchema: S.Codec<TripleConstraint>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const EachOfSchema: S.Codec<EachOf>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const OneOfSchema: S.Codec<OneOf>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const TripleExprSchema: S.Codec<TripleExpr>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const TripleExprOrRefSchema: S.Codec<TripleExprOrRef>;
+/**
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const ShapeDeclSchema: S.Codec<ShapeDecl>;
+/**
+ * The schema of a complete ShExJ document.
+ *
+ * @since 0.1.0
+ * @category schemas
+ */
+declare const SchemaSchema: S.Codec<Schema>;
+/**
+ * The ShEx JSON-LD context IRI.
+ *
+ * @since 0.1.0
+ * @category constants
+ */
+declare const context = "http://www.w3.org/ns/shex.jsonld";
+/**
+ * Decodes and validates an already-parsed JSON value as a ShExJ schema.
+ *
+ * @since 0.1.0
+ * @category decoding
+ */
+declare const decode: (input: unknown) => Effect.Effect<Schema, ShExJError>;
+/**
+ * Parses and validates a ShExJ JSON document.
+ *
+ * @since 0.1.0
+ * @category decoding
+ */
+declare const parse: (input: string) => Effect.Effect<Schema, ShExJError>;
+/**
+ * Encodes a schema as a ShExJ JSON value (adding the JSON-LD `@context`).
+ *
+ * @since 0.1.0
+ * @category encoding
+ */
+declare const toJson: (schema: Schema) => unknown;
+/**
+ * Serialises a schema as a ShExJ JSON document.
+ *
+ * @since 0.1.0
+ * @category encoding
+ */
+declare const stringify: (schema: Schema, space?: number | string) => string;
+/**
+ * Applies `f` to every IRI in a schema (labels, predicates, datatypes, value
+ * set IRIs and stems, imports, semantic action names and annotations). Blank
+ * node labels are left untouched.
+ *
+ * @since 0.1.0
+ * @category combinators
+ */
+declare const mapIris: (schema: Schema, f: (iri: string) => string) => Schema;
+/**
+ * Resolves every relative IRI of a schema (e.g. one read from a ShExJ file)
+ * against a base IRI.
+ *
+ * @since 0.1.0
+ * @category combinators
+ */
+declare const resolveIris: (schema: Schema, base: string) => Schema;
+/**
+ * Whether a label is a blank node label (`_:x`).
+ *
+ * @since 0.1.0
+ * @category guards
+ */
+declare const isBlankLabel: (label: Label) => boolean;
+/**
+ * Whether a value set value is an `ObjectLiteral`.
+ *
+ * @since 0.1.0
+ * @category guards
+ */
+declare const isObjectLiteral: (v: unknown) => v is ObjectLiteral;
+/**
+ * Inclusive repetition bounds of a triple expression; `max` may be
+ * `Infinity`.
+ *
+ * @since 0.1.0
+ * @category utils
+ */
+interface Bounds {
+  readonly min: number;
+  readonly max: number;
+}
+/**
+ * Normalised cardinality, with `max` of `-1` (unbounded) mapped to
+ * `Infinity`.
+ *
+ * @since 0.1.0
+ * @category utils
+ */
+declare const cardinality: (c: Cardinality) => Bounds;
+export { TripleConstraint as $, OneOf as A, ShapeDecl as B, NodeConstraint as C, ObjectLiteralSchema as D, ObjectLiteral as E, SemActSchema as F, ShapeExprSchema as G, ShapeExpr as H, ShExJ_d_exports as I, ShapeNot as J, ShapeExternal as K, Shape as L, Schema as M, SchemaSchema as N, ObjectValue as O, SemAct as P, ShapeSchema as Q, ShapeAnd as R, LiteralStemSchema as S, NodeKind as T, ShapeExprOrRef as U, ShapeDeclSchema as V, ShapeExprOrRefSchema as W, ShapeOr as X, ShapeNotSchema as Y, ShapeOrSchema as Z, LanguageStemRangeSchema as _, stringify as _t, EachOf as a, ValueSetValue as at, LiteralStemRange as b, IriStem as c, WildcardSchema as ct, IriStemSchema as d, decode as dt, TripleConstraintSchema as et, Label as f, isBlankLabel as ft, LanguageStemRange as g, resolveIris as gt, LanguageStem as h, parse as ht, Cardinality as i, TripleExprSchema as it, OneOfSchema as j, ObjectValueSchema as k, IriStemRange as l, cardinality as lt, LanguageSchema as m, mapIris as mt, AnnotationSchema as n, TripleExprOrRef as nt, EachOfSchema as o, ValueSetValueSchema as ot, Language as p, isObjectLiteral as pt, ShapeExternalSchema as q, Bounds as r, TripleExprOrRefSchema as rt, Facets as s, Wildcard as st, Annotation as t, TripleExpr as tt, IriStemRangeSchema as u, context as ut, LanguageStemSchema as v, toJson as vt, NodeConstraintSchema as w, LiteralStemRangeSchema as x, LiteralStem as y, ShapeAndSchema as z };
+//# sourceMappingURL=ShExJ-C1u_wgyD.d.mts.map