ochre-sdk 1.0.13 → 1.0.14

package/dist/schemas.d.mts

@@ -0,0 +1,84 @@
+import { Query } from "./types/index.mjs";
+import * as v from "valibot";
+
+//#region src/schemas.d.ts
+/**
+ * Schema for validating UUIDs
+ * @internal
+ */
+declare const uuidSchema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Invalid pseudo-UUID">]>;
+/**
+ * Schema for validating language codes
+ * @internal
+ */
+declare const iso639_3Schema: v.SchemaWithPipe<readonly [v.StringSchema<"Language code must be a string">, v.LengthAction<string, 3, "Language code must be exactly 3 characters">, v.RegexAction<string, "Language code must be exactly 3 lowercase letters">]>;
+/**
+ * Valid component types for web elements
+ * @internal
+ */
+declare const componentSchema: v.PicklistSchema<readonly ["3d-viewer", "advanced-search", "annotated-document", "annotated-image", "audio-player", "bibliography", "button", "collection", "empty-space", "entries", "iframe", "iiif-viewer", "image", "image-gallery", "map", "query", "search-bar", "table", "text", "timeline", "video"], "Invalid/unknown web element component">;
+/**
+ * Schema for validating gallery parameters
+ * @internal
+ */
+declare const gallerySchema: v.ObjectSchema<{
+  readonly uuid: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Invalid pseudo-UUID">]>;
+  readonly filter: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+  readonly page: v.SchemaWithPipe<readonly [v.NumberSchema<"Page must be positive">, v.CheckAction<number, "Page must be positive">]>;
+  readonly perPage: v.SchemaWithPipe<readonly [v.NumberSchema<"Per page must be positive">, v.CheckAction<number, "Per page must be positive">]>;
+}, undefined>;
+/**
+ * Schema for validating and parsing render options
+ * @internal
+ */
+declare const renderOptionsSchema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, string[]>, v.ArraySchema<v.PicklistSchema<["bold", "italic", "underline"], undefined>, undefined>]>;
+/**
+ * Schema for validating and parsing whitespace options
+ * @internal
+ */
+declare const whitespaceSchema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, string[]>, v.ArraySchema<v.PicklistSchema<["newline", "trailing", "leading"], undefined>, undefined>]>;
+/**
+ * Schema for validating the parameters for the Set property values fetching function
+ * @internal
+ */
+declare const setPropertyValuesParamsSchema: v.ObjectSchema<{
+  readonly setScopeUuids: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Invalid pseudo-UUID">]>, undefined>, v.MinLengthAction<string[], 1, "At least one set scope UUID is required">]>;
+  readonly belongsToCollectionScopeUuids: v.OptionalSchema<v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Invalid pseudo-UUID">]>, undefined>, readonly []>;
+  readonly queries: v.OptionalSchema<v.NullableSchema<v.GenericSchema<unknown, Query>, undefined>, null>;
+  readonly attributes: v.OptionalSchema<v.ObjectSchema<{
+    readonly bibliographies: v.GenericSchema<unknown, boolean>;
+    readonly periods: v.GenericSchema<unknown, boolean>;
+  }, undefined>, {
+    readonly bibliographies: false;
+    readonly periods: false;
+  }>;
+  readonly isLimitedToLeafPropertyValues: v.GenericSchema<unknown, boolean>;
+}, undefined>;
+/**
+ * Schema for validating Set items parameters
+ * @internal
+ */
+declare const setItemsParamsSchema: v.ObjectSchema<{
+  readonly setScopeUuids: v.SchemaWithPipe<readonly [v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Invalid pseudo-UUID">]>, undefined>, v.MinLengthAction<string[], 1, "At least one set scope UUID is required">]>;
+  readonly belongsToCollectionScopeUuids: v.OptionalSchema<v.ArraySchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Invalid pseudo-UUID">]>, undefined>, readonly []>;
+  readonly queries: v.OptionalSchema<v.NullableSchema<v.GenericSchema<unknown, Query>, undefined>, null>;
+  readonly sort: v.OptionalSchema<v.VariantSchema<"target", [v.StrictObjectSchema<{
+    readonly target: v.LiteralSchema<"none", undefined>;
+  }, undefined>, v.StrictObjectSchema<{
+    readonly target: v.LiteralSchema<"title", undefined>;
+    readonly direction: v.OptionalSchema<v.PicklistSchema<["asc", "desc"], undefined>, "asc">;
+    readonly language: v.GenericSchema<unknown, string>;
+  }, undefined>, v.StrictObjectSchema<{
+    readonly target: v.LiteralSchema<"propertyValue", undefined>;
+    readonly propertyVariableUuid: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.CheckAction<string, "Invalid pseudo-UUID">]>;
+    readonly dataType: v.PicklistSchema<readonly ["string", "integer", "decimal", "boolean", "date", "dateTime", "time", "IDREF"], undefined>;
+    readonly direction: v.OptionalSchema<v.PicklistSchema<["asc", "desc"], undefined>, "asc">;
+    readonly language: v.GenericSchema<unknown, string>;
+  }, undefined>], undefined>, {
+    readonly target: "none";
+  }>;
+  readonly page: v.OptionalSchema<v.GenericSchema<unknown, number>, 1>;
+  readonly pageSize: v.OptionalSchema<v.GenericSchema<unknown, number>, 48>;
+}, undefined>;
+//#endregion
+export { componentSchema, gallerySchema, iso639_3Schema, renderOptionsSchema, setItemsParamsSchema, setPropertyValuesParamsSchema, uuidSchema, whitespaceSchema };

package/dist/schemas.mjs

@@ -0,0 +1,232 @@
+import { isPseudoUuid } from "./utils.mjs";
+import "./helpers.mjs";
+import * as v from "valibot";
+//#region src/schemas.ts
+const positiveNumber = (message) => v.pipe(v.number(), v.minValue(1, message));
+const defaultString = (value) => v.optional(v.string(), value);
+const defaultBoolean = (value) => v.optional(v.boolean(), value);
+const sortDirectionSchema = v.optional(v.picklist(["asc", "desc"]), "asc");
+/**
+* Schema for validating UUIDs
+* @internal
+*/
+const uuidSchema = v.pipe(v.string(), v.check(isPseudoUuid, "Invalid pseudo-UUID"));
+/**
+* Schema for validating language codes
+* @internal
+*/
+const iso639_3Schema = v.pipe(v.string("Language code must be a string"), v.length(3, "Language code must be exactly 3 characters"), v.regex(/^[a-z]{3}$/, "Language code must be exactly 3 lowercase letters"));
+/**
+* Valid component types for web elements
+* @internal
+*/
+const componentSchema = v.picklist([
+	"3d-viewer",
+	"advanced-search",
+	"annotated-document",
+	"annotated-image",
+	"audio-player",
+	"bibliography",
+	"button",
+	"collection",
+	"empty-space",
+	"entries",
+	"iframe",
+	"iiif-viewer",
+	"image",
+	"image-gallery",
+	"map",
+	"query",
+	"search-bar",
+	"table",
+	"text",
+	"timeline",
+	"video"
+], "Invalid/unknown web element component");
+/**
+* Schema for validating gallery parameters
+* @internal
+*/
+const gallerySchema = v.object({
+	uuid: v.pipe(v.string(), v.check(isPseudoUuid, "Invalid pseudo-UUID")),
+	filter: v.optional(v.string()),
+	page: v.pipe(v.number("Page must be positive"), v.check((n) => n > 0, "Page must be positive")),
+	perPage: v.pipe(v.number("Per page must be positive"), v.check((n) => n > 0, "Per page must be positive"))
+});
+/**
+* Schema for validating and parsing render options
+* @internal
+*/
+const renderOptionsSchema = v.pipe(v.string(), v.transform((str) => str.split(" ")), v.array(v.picklist([
+	"bold",
+	"italic",
+	"underline"
+])));
+/**
+* Schema for validating and parsing whitespace options
+* @internal
+*/
+const whitespaceSchema = v.pipe(v.string(), v.transform((str) => str.split(" ")), v.array(v.picklist([
+	"newline",
+	"trailing",
+	"leading"
+])));
+/**
+* Schema for validating date data types
+* @internal
+*/
+const dateDataTypeSchema = v.picklist(["date", "dateTime"]);
+/**
+* Shared schema for query fields
+* @internal
+*/
+const standardQueryFields = {
+	matchMode: v.picklist(["includes", "exact"]),
+	isCaseSensitive: v.boolean(),
+	language: defaultString("eng"),
+	isNegated: defaultBoolean(false)
+};
+/**
+* Shared schema for Set queries
+* @internal
+*/
+const setQueryLeafSchema = v.union([
+	v.pipe(v.strictObject({
+		target: v.literal("property"),
+		propertyVariable: v.optional(uuidSchema),
+		dataType: v.picklist([
+			"string",
+			"integer",
+			"decimal",
+			"boolean",
+			"time",
+			"IDREF"
+		]),
+		value: v.optional(v.string()),
+		...standardQueryFields
+	}), v.check((value) => value.propertyVariable != null || value.value != null, "Property queries must include at least one propertyVariable or value")),
+	v.strictObject({
+		target: v.literal("property"),
+		propertyVariable: uuidSchema,
+		dataType: dateDataTypeSchema,
+		value: v.string(),
+		from: v.optional(v.never()),
+		to: v.optional(v.never()),
+		...standardQueryFields
+	}),
+	v.strictObject({
+		target: v.literal("property"),
+		propertyVariable: uuidSchema,
+		dataType: dateDataTypeSchema,
+		value: v.optional(v.never()),
+		from: v.string(),
+		to: v.optional(v.string()),
+		...standardQueryFields
+	}),
+	v.strictObject({
+		target: v.literal("property"),
+		propertyVariable: uuidSchema,
+		dataType: dateDataTypeSchema,
+		value: v.optional(v.never()),
+		from: v.optional(v.string()),
+		to: v.string(),
+		...standardQueryFields
+	}),
+	v.strictObject({
+		target: v.literal("property"),
+		propertyVariable: v.optional(uuidSchema),
+		dataType: v.literal("all"),
+		value: v.string(),
+		...standardQueryFields
+	}),
+	v.strictObject({
+		target: v.literal("string"),
+		value: v.string(),
+		...standardQueryFields
+	}),
+	v.strictObject({
+		target: v.picklist([
+			"title",
+			"description",
+			"image",
+			"periods",
+			"bibliography",
+			"notes"
+		]),
+		value: v.string(),
+		...standardQueryFields
+	})
+]);
+/**
+* Schema for validating Set queries
+* @internal
+*/
+const setQuerySchema = v.lazy(() => v.union([
+	setQueryLeafSchema,
+	v.strictObject({ and: v.pipe(v.array(setQuerySchema), v.minLength(1, "AND groups must contain at least one query")) }),
+	v.strictObject({ or: v.pipe(v.array(setQuerySchema), v.minLength(1, "OR groups must contain at least one query")) })
+]));
+/**
+* Schema for validating Set queries
+* @internal
+*/
+const setQueriesSchema = v.optional(v.nullable(setQuerySchema), null);
+/**
+* Schema for validating Set items sort
+* @internal
+*/
+const setItemsSortSchema = v.optional(v.variant("target", [
+	v.strictObject({ target: v.literal("none") }),
+	v.strictObject({
+		target: v.literal("title"),
+		direction: sortDirectionSchema,
+		language: defaultString("eng")
+	}),
+	v.strictObject({
+		target: v.literal("propertyValue"),
+		propertyVariableUuid: uuidSchema,
+		dataType: v.picklist([
+			"string",
+			"integer",
+			"decimal",
+			"boolean",
+			"date",
+			"dateTime",
+			"time",
+			"IDREF"
+		]),
+		direction: sortDirectionSchema,
+		language: defaultString("eng")
+	})
+]), { target: "none" });
+/**
+* Schema for validating the parameters for the Set property values fetching function
+* @internal
+*/
+const setPropertyValuesParamsSchema = v.object({
+	setScopeUuids: v.pipe(v.array(uuidSchema), v.minLength(1, "At least one set scope UUID is required")),
+	belongsToCollectionScopeUuids: v.optional(v.array(uuidSchema), []),
+	queries: setQueriesSchema,
+	attributes: v.optional(v.object({
+		bibliographies: defaultBoolean(false),
+		periods: defaultBoolean(false)
+	}), {
+		bibliographies: false,
+		periods: false
+	}),
+	isLimitedToLeafPropertyValues: defaultBoolean(false)
+});
+/**
+* Schema for validating Set items parameters
+* @internal
+*/
+const setItemsParamsSchema = v.object({
+	setScopeUuids: v.pipe(v.array(uuidSchema), v.minLength(1, "At least one set scope UUID is required")),
+	belongsToCollectionScopeUuids: v.optional(v.array(uuidSchema), []),
+	queries: setQueriesSchema,
+	sort: setItemsSortSchema,
+	page: v.optional(positiveNumber("Page must be positive"), 1),
+	pageSize: v.optional(positiveNumber("Page size must be positive"), 48)
+});
+//#endregion
+export { componentSchema, gallerySchema, iso639_3Schema, renderOptionsSchema, setItemsParamsSchema, setPropertyValuesParamsSchema, uuidSchema, whitespaceSchema };