@thomasfosterau/effect-rdf 0.0.0-stage → 0.1.0

package/dist/Datatype-CxMpamHC.d.mts

@@ -0,0 +1,212 @@
+import * as Option from "effect/Option";
+import * as Schema from "effect/Schema";
+import * as Result from "effect/Result";
+declare namespace Datatype_d_exports {
+  export { Bound, Datatype, NumericFormat, Value, boundKey, builtIn, canonicalName, checkFormat, datatypeIri, fromIri, iri, isBinary, isBuiltIn, isDateTime, isDecimal, isDuration, isInteger, isNumeric, isString, parse, string, stringValue };
+}
+/**
+ * The names of the built-in datatypes, including the CSVW aliases (`number`,
+ * `binary`, `datetime`, `any`, `xml`, `html`, `json`).
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const builtIn: ReadonlyArray<string>;
+/**
+ * Whether `name` names a built-in datatype.
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const isBuiltIn: (name: string) => boolean;
+/**
+ * The XML Schema name of a built-in datatype (`number` is `double`, …).
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const canonicalName: (name: string) => string;
+/**
+ * The IRI of a built-in datatype.
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const iri: (name: string) => string;
+/**
+ * The built-in datatype an IRI identifies, if any.
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const fromIri: (url: string) => Option.Option<string>;
+/**
+ * Whether a built-in datatype is an integer type.
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const isInteger: (name: string) => boolean;
+/**
+ * Whether a built-in datatype is `decimal` or one of its subtypes.
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const isDecimal: (name: string) => boolean;
+/**
+ * Whether a built-in datatype is numeric.
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const isNumeric: (name: string) => boolean;
+/**
+ * Whether a built-in datatype is a date or time type.
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const isDateTime: (name: string) => boolean;
+/**
+ * Whether a built-in datatype is a duration type.
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const isDuration: (name: string) => boolean;
+/**
+ * Whether a built-in datatype is `string` or one of its subtypes.
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const isString: (name: string) => boolean;
+/**
+ * Whether a built-in datatype is a binary type.
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const isBinary: (name: string) => boolean;
+/**
+ * A numeric format object (`decimalChar`, `groupChar`, `pattern`).
+ *
+ * @since 0.1.0
+ * @category models
+ */
+declare const NumericFormat: Schema.Struct<{
+  readonly decimalChar: Schema.optional<Schema.String>;
+  readonly groupChar: Schema.optional<Schema.String>;
+  readonly pattern: Schema.optional<Schema.String>;
+}>;
+/**
+ * @since 0.1.0
+ * @category models
+ */
+type NumericFormat = typeof NumericFormat.Type;
+/**
+ * A bound of a value constraint, as written in the metadata.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+declare const Bound: Schema.Union<readonly [Schema.String, Schema.Finite]>;
+/**
+ * @since 0.1.0
+ * @category models
+ */
+type Bound = typeof Bound.Type;
+/**
+ * A normalized datatype description: a built-in `base`, an optional `@id`,
+ * a `format`, and length and value constraints.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+declare const Datatype: Schema.Struct<{
+  readonly base: Schema.String;
+  readonly id: Schema.optional<Schema.String>;
+  readonly format: Schema.optional<Schema.Union<readonly [Schema.String, Schema.Struct<{
+    readonly decimalChar: Schema.optional<Schema.String>;
+    readonly groupChar: Schema.optional<Schema.String>;
+    readonly pattern: Schema.optional<Schema.String>;
+  }>]>>;
+  readonly length: Schema.optional<Schema.Int>;
+  readonly minLength: Schema.optional<Schema.Int>;
+  readonly maxLength: Schema.optional<Schema.Int>;
+  readonly minInclusive: Schema.optional<Schema.Union<readonly [Schema.String, Schema.Finite]>>;
+  readonly maxInclusive: Schema.optional<Schema.Union<readonly [Schema.String, Schema.Finite]>>;
+  readonly minExclusive: Schema.optional<Schema.Union<readonly [Schema.String, Schema.Finite]>>;
+  readonly maxExclusive: Schema.optional<Schema.Union<readonly [Schema.String, Schema.Finite]>>;
+  readonly common: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+}>;
+/**
+ * @since 0.1.0
+ * @category models
+ */
+type Datatype = typeof Datatype.Type;
+/**
+ * The `string` datatype.
+ *
+ * @since 0.1.0
+ * @category constructors
+ */
+declare const string: Datatype;
+/**
+ * The IRI a value of the datatype has in RDF: its `@id`, or its base's IRI.
+ *
+ * @since 0.1.0
+ * @category datatypes
+ */
+declare const datatypeIri: (datatype: Datatype) => string;
+/**
+ * A parsed cell value: its XML Schema lexical form, its datatype and, for
+ * strings, its language.
+ *
+ * @since 0.1.0
+ * @category models
+ */
+interface Value {
+  /** The lexical form (canonical where the format changed the string). */
+  readonly lexical: string;
+  /** The built-in base datatype. */
+  readonly base: string;
+  /** The datatype IRI used in RDF (`@id` or the base's IRI). */
+  readonly datatype: string;
+  /** The language of a string value. */
+  readonly language: Option.Option<string>;
+}
+/**
+ * Checks a datatype's `format` against its base, returning a warning when the
+ * format is unusable (it is then ignored).
+ *
+ * @since 0.1.0
+ * @category validation
+ */
+declare const checkFormat: (base: string, format: string | NumericFormat) => Option.Option<string>;
+/**
+ * The order key of a constraint bound for a base datatype, if it is a valid
+ * value of that datatype.
+ *
+ * @since 0.1.0
+ * @category validation
+ */
+declare const boundKey: (bound: Bound, base: string) => Option.Option<number>;
+/**
+ * Parses a (non-empty, non-null) cell string with a datatype: the value, or
+ * the errors that make the cell invalid.
+ *
+ * @since 0.1.0
+ * @category parsing
+ */
+declare const parse: (text: string, datatype: Datatype, language: Option.Option<string>) => Result.Result<Value, ReadonlyArray<string>>;
+/**
+ * A plain string value, as an invalid cell's value.
+ *
+ * @since 0.1.0
+ * @category constructors
+ */
+declare const stringValue: (text: string, language: Option.Option<string>) => Value;
+export { stringValue as C, string as S, isDuration as _, Value as a, isString as b, canonicalName as c, fromIri as d, iri as f, isDecimal as g, isDateTime as h, NumericFormat as i, checkFormat as l, isBuiltIn as m, Datatype as n, boundKey as o, isBinary as p, Datatype_d_exports as r, builtIn as s, Bound as t, datatypeIri as u, isInteger as v, parse as x, isNumeric as y };
+//# sourceMappingURL=Datatype-CxMpamHC.d.mts.map