ochre-sdk 1.3.13 → 1.3.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/categories.d.mts +1 -3
- package/dist/categories.mjs +1 -2
- package/dist/constants.d.mts +1 -3
- package/dist/constants.mjs +11 -4
- package/dist/errors.d.mts +0 -2
- package/dist/errors.mjs +1 -2
- package/dist/fetchers/container-items.d.mts +1 -3
- package/dist/fetchers/container-items.mjs +1 -2
- package/dist/fetchers/gallery.d.mts +1 -3
- package/dist/fetchers/gallery.mjs +1 -2
- package/dist/fetchers/item-children.d.mts +0 -2
- package/dist/fetchers/item-children.mjs +1 -2
- package/dist/fetchers/item-links.d.mts +1 -3
- package/dist/fetchers/item-links.mjs +1 -2
- package/dist/fetchers/item-locations.d.mts +1 -3
- package/dist/fetchers/item-locations.mjs +1 -2
- package/dist/fetchers/item-ocr-data.d.mts +1 -3
- package/dist/fetchers/item-ocr-data.mjs +1 -2
- package/dist/fetchers/item.d.mts +0 -2
- package/dist/fetchers/item.mjs +1 -2
- package/dist/fetchers/map-layers.d.mts +1 -3
- package/dist/fetchers/map-layers.mjs +1 -2
- package/dist/fetchers/request.d.mts +1 -3
- package/dist/fetchers/request.mjs +1 -2
- package/dist/fetchers/set/items.d.mts +0 -2
- package/dist/fetchers/set/items.mjs +1 -2
- package/dist/fetchers/set/property-values.d.mts +1 -3
- package/dist/fetchers/set/property-values.mjs +1 -2
- package/dist/fetchers/tree/items.d.mts +0 -2
- package/dist/fetchers/tree/items.mjs +1 -2
- package/dist/fetchers/website-metadata.d.mts +1 -3
- package/dist/fetchers/website-metadata.mjs +1 -2
- package/dist/fetchers/website.d.mts +1 -3
- package/dist/fetchers/website.mjs +1 -2
- package/dist/getters.d.mts +0 -2
- package/dist/getters.mjs +1 -2
- package/dist/helpers.d.mts +0 -2
- package/dist/helpers.mjs +1 -2
- package/dist/index.d.mts +2 -2
- package/dist/languages.d.mts +1 -3
- package/dist/languages.mjs +1 -2
- package/dist/ocr.d.mts +1 -3
- package/dist/ocr.mjs +1 -2
- package/dist/parsers/helpers.d.mts +1 -3
- package/dist/parsers/helpers.mjs +1 -2
- package/dist/parsers/index.d.mts +0 -2
- package/dist/parsers/index.mjs +11 -2
- package/dist/parsers/languages.d.mts +1 -3
- package/dist/parsers/languages.mjs +1 -2
- package/dist/parsers/mdx.d.mts +1 -3
- package/dist/parsers/mdx.mjs +1 -2
- package/dist/parsers/multilingual.d.mts +0 -2
- package/dist/parsers/multilingual.mjs +1 -2
- package/dist/parsers/property-token.d.mts +0 -2
- package/dist/parsers/property-token.mjs +1 -2
- package/dist/parsers/string.d.mts +1 -3
- package/dist/parsers/string.mjs +1 -2
- package/dist/parsers/website/bounds.d.mts +1 -3
- package/dist/parsers/website/bounds.mjs +1 -2
- package/dist/parsers/website/components.d.mts +0 -2
- package/dist/parsers/website/components.mjs +1 -2
- package/dist/parsers/website/index.d.mts +1 -3
- package/dist/parsers/website/index.mjs +1 -2
- package/dist/parsers/website/links.d.mts +1 -3
- package/dist/parsers/website/links.mjs +1 -2
- package/dist/parsers/website/messages.d.mts +1 -3
- package/dist/parsers/website/messages.mjs +1 -2
- package/dist/parsers/website/options.d.mts +1 -3
- package/dist/parsers/website/options.mjs +1 -2
- package/dist/parsers/website/properties.d.mts +1 -3
- package/dist/parsers/website/properties.mjs +1 -2
- package/dist/parsers/website/reader.d.mts +0 -2
- package/dist/parsers/website/reader.mjs +1 -2
- package/dist/parsers/website/slug.d.mts +1 -3
- package/dist/parsers/website/slug.mjs +1 -2
- package/dist/parsers/website/styles.d.mts +1 -3
- package/dist/parsers/website/styles.mjs +1 -2
- package/dist/parsers/website/walk.d.mts +1 -3
- package/dist/parsers/website/walk.mjs +1 -2
- package/dist/query.d.mts +0 -2
- package/dist/query.mjs +1 -2
- package/dist/reflection.d.mts +1 -3
- package/dist/reflection.mjs +1 -2
- package/dist/schemas.d.mts +1 -3
- package/dist/schemas.mjs +1 -2
- package/dist/types/index.d.mts +11 -2
- package/dist/types/utilities.d.mts +1 -3
- package/dist/types/website.d.mts +1 -3
- package/dist/xml/dates.d.mts +1 -3
- package/dist/xml/dates.mjs +1 -2
- package/dist/xml/metadata.d.mts +1 -3
- package/dist/xml/metadata.mjs +1 -2
- package/dist/xml/schemas.d.mts +22 -3
- package/dist/xml/schemas.mjs +14 -2
- package/dist/xml/types.d.mts +11 -3
- package/dist/xquery.d.mts +1 -3
- package/dist/xquery.mjs +1 -2
- package/package.json +7 -6
package/dist/categories.d.mts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { ContextItemCategory, HeadingItemCategory, ItemCategory, ItemCategoryWithEmbeddedItems, ItemContainerCategory, ItemLinkCategory, TreeItemCategory } from "./types/index.mjs";
|
|
2
|
-
//#region src/categories.d.ts
|
|
3
2
|
/**
|
|
4
3
|
* Every category an item hierarchy entry can carry, including the
|
|
5
4
|
* pseudo-category OCHRE uses to group entries
|
|
@@ -245,5 +244,4 @@ export declare function isHeadingItemCategory(category: TreeItemCategory): categ
|
|
|
245
244
|
* @returns The canonical category, or null when the name is not one
|
|
246
245
|
* @internal
|
|
247
246
|
*/
|
|
248
|
-
export declare function normalizeItemCategory(category: string | undefined): ItemCategory | null;
|
|
249
|
-
//#endregion
|
|
247
|
+
export declare function normalizeItemCategory(category: string | undefined): ItemCategory | null;
|
package/dist/categories.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
// src/categories.ts
|
|
2
2
|
/**
|
|
3
3
|
* The one table describing the OCHRE item categories
|
|
4
4
|
* @internal
|
|
@@ -255,5 +255,4 @@ function normalizeItemCategory(category) {
|
|
|
255
255
|
const normalizedCategory = ITEM_CATEGORY_BY_ALIAS.get(category);
|
|
256
256
|
return normalizedCategory != null && ITEM_CATEGORY_FACTS[normalizedCategory].isSetItem ? normalizedCategory : null;
|
|
257
257
|
}
|
|
258
|
-
//#endregion
|
|
259
258
|
export { CONTEXT_CATEGORY_ALIASES, HEADING_ITEM_CATEGORIES, ITEM_CATEGORIES_WITH_EMBEDDED_ITEMS, ITEM_CATEGORY_ALIASES, ITEM_CATEGORY_BY_ALIAS, ITEM_CATEGORY_FACTS, ITEM_CONTAINER_CATEGORIES, OCHRE_COLLECTION_CATEGORIES, SET_ITEM_CATEGORIES, TREE_ITEM_CATEGORIES, isHeadingItemCategory, isItemCategoryWithEmbeddedItems, isItemContainerCategory, normalizeItemCategory };
|
package/dist/constants.d.mts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { X2jOptions } from "fast-xml-parser";
|
|
2
|
-
//#region src/constants.d.ts
|
|
3
2
|
export declare const XML_ARRAY_TAGS: ReadonlyArray<string>;
|
|
4
3
|
export declare const XML_PARSER_OPTIONS: X2jOptions;
|
|
5
4
|
export declare const DEFAULT_LANGUAGES: readonly ["eng"];
|
|
@@ -25,5 +24,4 @@ export declare const TEXT_ANNOTATION_ITEM_PAGE_VARIANT_UUID = "bf4476ab-6bc8-40d
|
|
|
25
24
|
export declare const TEXT_ANNOTATION_ENTRY_PAGE_VARIANT_UUID = "9d52db95-a9cf-45f7-a0bf-fc9ba9f0aae0";
|
|
26
25
|
export declare const TEXT_ANNOTATION_TEXT_STYLING_UUID = "3e6f86ab-df81-45ae-8257-e2867357df56";
|
|
27
26
|
export declare const TEXT_ANNOTATION_TEXT_STYLING_VARIANT_UUID = "e1647bef-d801-4100-bdde-d081c422f763";
|
|
28
|
-
export declare const TEXT_ANNOTATION_TEXT_STYLING_HEADING_LEVEL_UUID = "d4266f0b-3f8d-4b32-8c15-4b229c8bb11e";
|
|
29
|
-
//#endregion
|
|
27
|
+
export declare const TEXT_ANNOTATION_TEXT_STYLING_HEADING_LEVEL_UUID = "d4266f0b-3f8d-4b32-8c15-4b229c8bb11e";
|
package/dist/constants.mjs
CHANGED
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
|
|
1
|
+
import { COMMON_HTML, CURRENCY, ENTITY_ACTION, EntityDecoder } from "@nodable/entities";
|
|
2
|
+
// src/constants.ts
|
|
2
3
|
const XML_ARRAY_TAGS = [
|
|
3
4
|
"string",
|
|
4
5
|
"content",
|
|
@@ -51,7 +52,8 @@ const XML_ARRAY_TAGS = [
|
|
|
51
52
|
"detailContexts",
|
|
52
53
|
"downloadContexts",
|
|
53
54
|
"labelContexts",
|
|
54
|
-
"prominentContexts"
|
|
55
|
+
"prominentContexts",
|
|
56
|
+
"option"
|
|
55
57
|
];
|
|
56
58
|
const XML_PARSER_OPTIONS = {
|
|
57
59
|
alwaysCreateTextNode: true,
|
|
@@ -65,7 +67,13 @@ const XML_PARSER_OPTIONS = {
|
|
|
65
67
|
attributeNamePrefix: "",
|
|
66
68
|
textNodeName: "payload",
|
|
67
69
|
stopNodes: ["*.referenceFormatDiv", "*.citationFormatSpan"],
|
|
68
|
-
|
|
70
|
+
entityDecoder: new EntityDecoder({
|
|
71
|
+
namedEntities: {
|
|
72
|
+
...COMMON_HTML,
|
|
73
|
+
...CURRENCY
|
|
74
|
+
},
|
|
75
|
+
onInputEntity: () => ENTITY_ACTION.BLOCK
|
|
76
|
+
}),
|
|
69
77
|
isArray(tagName, _, __, isAttribute) {
|
|
70
78
|
if (isAttribute) return false;
|
|
71
79
|
return XML_ARRAY_TAGS.includes(tagName);
|
|
@@ -102,5 +110,4 @@ const TEXT_ANNOTATION_ENTRY_PAGE_VARIANT_UUID = "9d52db95-a9cf-45f7-a0bf-fc9ba9f
|
|
|
102
110
|
const TEXT_ANNOTATION_TEXT_STYLING_UUID = "3e6f86ab-df81-45ae-8257-e2867357df56";
|
|
103
111
|
const TEXT_ANNOTATION_TEXT_STYLING_VARIANT_UUID = "e1647bef-d801-4100-bdde-d081c422f763";
|
|
104
112
|
const TEXT_ANNOTATION_TEXT_STYLING_HEADING_LEVEL_UUID = "d4266f0b-3f8d-4b32-8c15-4b229c8bb11e";
|
|
105
|
-
//#endregion
|
|
106
113
|
export { BELONGS_TO_COLLECTION_UUID, DEFAULT_LANGUAGES, DEFAULT_PAGE_SIZE, OCHRE_ENDPOINT, PERMANENT_IDENTIFICATION_URL_PREFIX, PRESENTATION_ITEM_UUID, TEXT_ANNOTATION_ENTRY_PAGE_VARIANT_UUID, TEXT_ANNOTATION_HOVER_CARD_UUID, TEXT_ANNOTATION_ITEM_PAGE_VARIANT_UUID, TEXT_ANNOTATION_TEXT_STYLING_HEADING_LEVEL_UUID, TEXT_ANNOTATION_TEXT_STYLING_UUID, TEXT_ANNOTATION_TEXT_STYLING_VARIANT_UUID, TEXT_ANNOTATION_UUID, XML_ARRAY_TAGS, XML_PARSER_OPTIONS, getOchreItemUrl };
|
package/dist/errors.d.mts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import * as v from "valibot";
|
|
2
|
-
//#region src/errors.d.ts
|
|
3
2
|
type SchemaValidationIssue = v.BaseIssue<unknown>;
|
|
4
3
|
/**
|
|
5
4
|
* Render an error as a short message and a fully detailed report
|
|
@@ -20,5 +19,4 @@ export declare function getErrorOutput(error: unknown, fallbackMessage: string):
|
|
|
20
19
|
* @internal
|
|
21
20
|
*/
|
|
22
21
|
export declare function createSchemaValidationError(message: string, issues: ReadonlyArray<SchemaValidationIssue>): Error;
|
|
23
|
-
//#endregion
|
|
24
22
|
export {};
|
package/dist/errors.mjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { isObject, readEntries } from "./reflection.mjs";
|
|
2
2
|
import * as v from "valibot";
|
|
3
|
-
|
|
3
|
+
// src/errors.ts
|
|
4
4
|
/**
|
|
5
5
|
* The shape a valibot issue has to have for this module to render it
|
|
6
6
|
*
|
|
@@ -160,5 +160,4 @@ function createSchemaValidationError(message, issues) {
|
|
|
160
160
|
* @returns True if the string is a valid pseudo-UUID, false otherwise
|
|
161
161
|
* @internal
|
|
162
162
|
*/
|
|
163
|
-
//#endregion
|
|
164
163
|
export { createSchemaValidationError, getErrorOutput };
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { ItemCategory, Query, SetItem, SetItemsSort } from "../types/index.mjs";
|
|
2
2
|
import { XMLSetItems } from "../xml/types.mjs";
|
|
3
3
|
import { FetchRuntimeOptions } from "../parsers/helpers.mjs";
|
|
4
|
-
//#region src/fetchers/container-items.d.ts
|
|
5
4
|
/**
|
|
6
5
|
* Whether a container payload carries any item of a category
|
|
7
6
|
* @param items - The parsed `<items>` payload
|
|
@@ -48,5 +47,4 @@ export declare function fetchContainerItems(parameters: {
|
|
|
48
47
|
page: number;
|
|
49
48
|
pageSize: number;
|
|
50
49
|
items: Array<SetItem<ItemCategory, ReadonlyArray<string>>>;
|
|
51
|
-
}>;
|
|
52
|
-
//#endregion
|
|
50
|
+
}>;
|
|
@@ -4,7 +4,7 @@ import { parseSetItems } from "../parsers/index.mjs";
|
|
|
4
4
|
import { XMLSetItemsData } from "../xml/schemas.mjs";
|
|
5
5
|
import { getContentLanguage, stringLiteral } from "../xquery.mjs";
|
|
6
6
|
import { compileContainerItemsQuery } from "../query.mjs";
|
|
7
|
-
|
|
7
|
+
// src/fetchers/container-items.ts
|
|
8
8
|
function hasArray(items) {
|
|
9
9
|
return items != null && items.length > 0;
|
|
10
10
|
}
|
|
@@ -180,5 +180,4 @@ async function fetchContainerItems(parameters) {
|
|
|
180
180
|
items: itemsByUuid.values().toArray()
|
|
181
181
|
};
|
|
182
182
|
}
|
|
183
|
-
//#endregion
|
|
184
183
|
export { fetchContainerItems, hasItemsCategory };
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { Gallery } from "../types/index.mjs";
|
|
2
2
|
import { FetchBaseOptions, FetchLanguages } from "../parsers/helpers.mjs";
|
|
3
|
-
//#region src/fetchers/gallery.d.ts
|
|
4
3
|
/**
|
|
5
4
|
* Fetches and parses a gallery from the OCHRE API
|
|
6
5
|
*
|
|
@@ -27,5 +26,4 @@ export declare function fetchGallery<const TLanguages extends ReadonlyArray<stri
|
|
|
27
26
|
gallery: null;
|
|
28
27
|
error: string;
|
|
29
28
|
detailedError: string;
|
|
30
|
-
}>;
|
|
31
|
-
//#endregion
|
|
29
|
+
}>;
|
|
@@ -6,7 +6,7 @@ import { parseGallery } from "../parsers/index.mjs";
|
|
|
6
6
|
import { XMLGalleryData } from "../xml/schemas.mjs";
|
|
7
7
|
import { OCHRE_RESPONSE_PADDING, compileOchreQuery, getContentLanguage, stringLiteral } from "../xquery.mjs";
|
|
8
8
|
import * as v from "valibot";
|
|
9
|
-
|
|
9
|
+
// src/fetchers/gallery.ts
|
|
10
10
|
function buildXQuery(parameters) {
|
|
11
11
|
const { uuid, filter, page, perPage, contentLanguage } = parameters;
|
|
12
12
|
const start = (page - 1) * perPage + 1;
|
|
@@ -61,5 +61,4 @@ async function fetchGallery(parameters, options) {
|
|
|
61
61
|
};
|
|
62
62
|
}
|
|
63
63
|
}
|
|
64
|
-
//#endregion
|
|
65
64
|
export { fetchGallery };
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { ContainedItemCategoryFromOption, ContainedItemCategoryOption, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemContainerCategory, SetItemCategory, TreeItemCategory } from "../types/index.mjs";
|
|
2
2
|
import { FetchBaseOptions, FetchLanguages } from "../parsers/helpers.mjs";
|
|
3
|
-
//#region src/fetchers/item-children.d.ts
|
|
4
3
|
type FetchItemChildrenResult<TItems> = Promise<{
|
|
5
4
|
items: TItems;
|
|
6
5
|
error: null;
|
|
@@ -32,5 +31,4 @@ export declare function fetchItemChildren<const TCategory extends ItemCategoryOp
|
|
|
32
31
|
category: TCategory;
|
|
33
32
|
containedItemCategory?: TContainedItemCategory;
|
|
34
33
|
}): FetchItemChildrenResult<Array<Item<TChildCategory, ContainedItemCategoryFromOption<TChildCategory, TContainedItemCategory>, FetchLanguages<TLanguages>, ItemChildrenPayloadKind<ItemCategoryFromOption<TCategory>>>>>;
|
|
35
|
-
//#endregion
|
|
36
34
|
export {};
|
|
@@ -7,7 +7,7 @@ import { parseLinkedItems } from "../parsers/index.mjs";
|
|
|
7
7
|
import { XMLItemLinksData } from "../xml/schemas.mjs";
|
|
8
8
|
import { OCHRE_RESPONSE_PADDING, compileOchreQuery, getContentLanguage, stringLiteral } from "../xquery.mjs";
|
|
9
9
|
import * as v from "valibot";
|
|
10
|
-
|
|
10
|
+
// src/fetchers/item-children.ts
|
|
11
11
|
function buildXQuery(uuid, category, contentLanguage) {
|
|
12
12
|
const categories = category == null ? OCHRE_COLLECTION_CATEGORIES : typeof category === "string" ? [category] : category;
|
|
13
13
|
const collectionQueries = Array.from(categories, (possibleCategory) => `cts:search(fn:collection("ochre/${possibleCategory}")/ochre, $uuid-query)`);
|
|
@@ -81,5 +81,4 @@ async function fetchItemChildren(uuid, options) {
|
|
|
81
81
|
};
|
|
82
82
|
}
|
|
83
83
|
}
|
|
84
|
-
//#endregion
|
|
85
84
|
export { fetchItemChildren };
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { ContainedItemCategoryFromOption, ContainedItemCategoryOption, Item, ItemCategory, ItemContainerCategory } from "../types/index.mjs";
|
|
2
2
|
import { FetchBaseOptions, FetchLanguages } from "../parsers/helpers.mjs";
|
|
3
|
-
//#region src/fetchers/item-links.d.ts
|
|
4
3
|
/**
|
|
5
4
|
* Fetches linked OCHRE items by source-item UUID.
|
|
6
5
|
*
|
|
@@ -21,5 +20,4 @@ export declare function fetchItemLinks<const TContainedItemCategory extends Cont
|
|
|
21
20
|
items: null;
|
|
22
21
|
error: string;
|
|
23
22
|
detailedError: string;
|
|
24
|
-
}>;
|
|
25
|
-
//#endregion
|
|
23
|
+
}>;
|
|
@@ -7,7 +7,7 @@ import { parseLinkedItems } from "../parsers/index.mjs";
|
|
|
7
7
|
import { XMLItemLinksData } from "../xml/schemas.mjs";
|
|
8
8
|
import { OCHRE_RESPONSE_PADDING, compileOchreQuery, getContentLanguage, stringLiteral } from "../xquery.mjs";
|
|
9
9
|
import * as v from "valibot";
|
|
10
|
-
|
|
10
|
+
// src/fetchers/item-links.ts
|
|
11
11
|
/**
|
|
12
12
|
* Build an XQuery string to fetch linked items from the OCHRE API.
|
|
13
13
|
*
|
|
@@ -70,5 +70,4 @@ async function fetchItemLinks(uuid, options) {
|
|
|
70
70
|
};
|
|
71
71
|
}
|
|
72
72
|
}
|
|
73
|
-
//#endregion
|
|
74
73
|
export { fetchItemLinks };
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { ItemLocation, Query } from "../types/index.mjs";
|
|
2
2
|
import { FetchBaseOptions, FetchLanguages } from "../parsers/helpers.mjs";
|
|
3
|
-
//#region src/fetchers/item-locations.d.ts
|
|
4
3
|
/**
|
|
5
4
|
* Fetches the location of every Set or Tree item that matches a query, without paging
|
|
6
5
|
*
|
|
@@ -37,5 +36,4 @@ export declare function fetchItemLocations<const TLanguages extends ReadonlyArra
|
|
|
37
36
|
items: null;
|
|
38
37
|
error: string;
|
|
39
38
|
detailedError: string;
|
|
40
|
-
}>;
|
|
41
|
-
//#endregion
|
|
39
|
+
}>;
|
|
@@ -9,7 +9,7 @@ import { XMLItemLocationsData } from "../xml/schemas.mjs";
|
|
|
9
9
|
import { getContentLanguage, stringLiteral } from "../xquery.mjs";
|
|
10
10
|
import { compileContainerItemsQuery } from "../query.mjs";
|
|
11
11
|
import * as v from "valibot";
|
|
12
|
-
|
|
12
|
+
// src/fetchers/item-locations.ts
|
|
13
13
|
async function fetchItemLocations(parameters, options) {
|
|
14
14
|
try {
|
|
15
15
|
const { setScopeUuids, treeScopeUuids, belongsToCollectionScopeUuids, queries, propertyVariableUuids, isMapDataIncluded } = v.parse(itemLocationsParametersSchema, parameters);
|
|
@@ -95,5 +95,4 @@ async function fetchItemLocations(parameters, options) {
|
|
|
95
95
|
};
|
|
96
96
|
}
|
|
97
97
|
}
|
|
98
|
-
//#endregion
|
|
99
98
|
export { fetchItemLocations };
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { OcrString } from "../types/index.mjs";
|
|
2
2
|
import { OchreRequestOptions } from "./request.mjs";
|
|
3
|
-
//#region src/fetchers/item-ocr-data.d.ts
|
|
4
3
|
/**
|
|
5
4
|
* Fetches and parses the OCR strings of an OCHRE item that match a search value
|
|
6
5
|
*
|
|
@@ -35,5 +34,4 @@ export declare function fetchItemOcrData(uuid: string, value: string, options?:
|
|
|
35
34
|
ocrStrings: null;
|
|
36
35
|
error: string;
|
|
37
36
|
detailedError: string;
|
|
38
|
-
}>;
|
|
39
|
-
//#endregion
|
|
37
|
+
}>;
|
|
@@ -4,7 +4,7 @@ import { itemOcrDataParametersSchema } from "../schemas.mjs";
|
|
|
4
4
|
import { OCHRE_RESPONSE_PADDING, stringLiteral } from "../xquery.mjs";
|
|
5
5
|
import { buildOcrWordPath } from "../ocr.mjs";
|
|
6
6
|
import * as v from "valibot";
|
|
7
|
-
|
|
7
|
+
// src/fetchers/item-ocr-data.ts
|
|
8
8
|
const OCR_STRING_VERTEX_REGEX = /\(\s*(-?\d+(?:\.\d+)?)\s*,\s*(-?\d+(?:\.\d+)?)\s*\)/g;
|
|
9
9
|
/**
|
|
10
10
|
* Schema for a single matched OCR string in the OCHRE API response
|
|
@@ -164,5 +164,4 @@ async function fetchItemOcrData(uuid, value, options) {
|
|
|
164
164
|
};
|
|
165
165
|
}
|
|
166
166
|
}
|
|
167
|
-
//#endregion
|
|
168
167
|
export { fetchItemOcrData };
|
package/dist/fetchers/item.d.mts
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { ContainedItemCategoryFromOption, ContainedItemCategoryOption, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemCategoryWithEmbeddedItems, ItemContainerCategory, ItemWithoutEmbeddedItems } from "../types/index.mjs";
|
|
2
2
|
import { FetchBaseOptions, FetchLanguages } from "../parsers/helpers.mjs";
|
|
3
|
-
//#region src/fetchers/item.d.ts
|
|
4
3
|
type FetchItemResult<TItem> = Promise<{
|
|
5
4
|
item: TItem;
|
|
6
5
|
error: null;
|
|
@@ -44,5 +43,4 @@ export declare function fetchItem<const TCategory extends ItemCategoryOption, co
|
|
|
44
43
|
containedItemCategory?: TContainedItemCategory;
|
|
45
44
|
shouldOmitEmbeddedItems: true;
|
|
46
45
|
}): FetchItemResult<ItemWithoutEmbeddedItems<Extract<ItemCategoryFromOption<TCategory>, ItemCategoryWithEmbeddedItems>, ContainedItemCategoryFromOption<Extract<ItemCategoryFromOption<TCategory>, ItemCategoryWithEmbeddedItems>, TContainedItemCategory>, FetchLanguages<TLanguages>> | Item<Exclude<ItemCategoryFromOption<TCategory>, ItemCategoryWithEmbeddedItems>, never, FetchLanguages<TLanguages>>>;
|
|
47
|
-
//#endregion
|
|
48
46
|
export {};
|
package/dist/fetchers/item.mjs
CHANGED
|
@@ -8,7 +8,7 @@ import { XMLData } from "../xml/schemas.mjs";
|
|
|
8
8
|
import { OCHRE_RESPONSE_PADDING, compileOchreQuery, getContentLanguage, stringLiteral } from "../xquery.mjs";
|
|
9
9
|
import { parseWebpageView } from "../parsers/website/index.mjs";
|
|
10
10
|
import * as v from "valibot";
|
|
11
|
-
|
|
11
|
+
// src/fetchers/item.ts
|
|
12
12
|
function isItemWithEmbeddedItems(item) {
|
|
13
13
|
return isItemCategoryWithEmbeddedItems(item.category);
|
|
14
14
|
}
|
|
@@ -100,5 +100,4 @@ async function fetchItem(uuid, options) {
|
|
|
100
100
|
};
|
|
101
101
|
}
|
|
102
102
|
}
|
|
103
|
-
//#endregion
|
|
104
103
|
export { fetchItem };
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { MapLayer } from "../types/index.mjs";
|
|
2
2
|
import { FetchBaseOptions, FetchLanguages } from "../parsers/helpers.mjs";
|
|
3
|
-
//#region src/fetchers/map-layers.d.ts
|
|
4
3
|
/**
|
|
5
4
|
* Fetches the layers a map draws from the Sets and Trees it links to
|
|
6
5
|
*
|
|
@@ -26,5 +25,4 @@ export declare function fetchMapLayers<const TLanguages extends ReadonlyArray<st
|
|
|
26
25
|
layers: null;
|
|
27
26
|
error: string;
|
|
28
27
|
detailedError: string;
|
|
29
|
-
}>;
|
|
30
|
-
//#endregion
|
|
28
|
+
}>;
|
|
@@ -6,7 +6,7 @@ import { parseIdentification } from "../parsers/index.mjs";
|
|
|
6
6
|
import { XMLMapSourcesData } from "../xml/schemas.mjs";
|
|
7
7
|
import { OCHRE_RESPONSE_PADDING, compileOchreQuery, getContentLanguage, stringLiteral } from "../xquery.mjs";
|
|
8
8
|
import * as v from "valibot";
|
|
9
|
-
|
|
9
|
+
// src/fetchers/map-layers.ts
|
|
10
10
|
const REGEX_TILE_TEMPLATE_LEVEL = /\{(?:level|z)\}/i;
|
|
11
11
|
const REGEX_TILE_TEMPLATE_ROW = /\{(?:row|y)\}/i;
|
|
12
12
|
const REGEX_TILE_TEMPLATE_COLUMN = /\{(?:col|x)\}/i;
|
|
@@ -157,5 +157,4 @@ async function fetchMapLayers(uuids, options) {
|
|
|
157
157
|
};
|
|
158
158
|
}
|
|
159
159
|
}
|
|
160
|
-
//#endregion
|
|
161
160
|
export { fetchMapLayers };
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { FetchFunction } from "../parsers/helpers.mjs";
|
|
2
2
|
import * as v from "valibot";
|
|
3
|
-
//#region src/fetchers/request.d.ts
|
|
4
3
|
export type OchreRequestOptions = {
|
|
5
4
|
fetch?: FetchFunction;
|
|
6
5
|
signal?: AbortSignal;
|
|
@@ -66,5 +65,4 @@ export declare function isOchreJsonAccepted(parameters: {
|
|
|
66
65
|
body: unknown;
|
|
67
66
|
label: string;
|
|
68
67
|
options?: OchreRequestOptions;
|
|
69
|
-
}): Promise<boolean>;
|
|
70
|
-
//#endregion
|
|
68
|
+
}): Promise<boolean>;
|
|
@@ -3,7 +3,7 @@ import { createSchemaValidationError } from "../errors.mjs";
|
|
|
3
3
|
import { restoreXMLMetadata } from "../xml/metadata.mjs";
|
|
4
4
|
import * as v from "valibot";
|
|
5
5
|
import { XMLParser } from "fast-xml-parser";
|
|
6
|
-
|
|
6
|
+
// src/fetchers/request.ts
|
|
7
7
|
const OCHRE_XQUERY_ENDPOINT = `${OCHRE_ENDPOINT}?xquery&xsl=none&lang="*"`;
|
|
8
8
|
const xmlParser = new XMLParser(XML_PARSER_OPTIONS);
|
|
9
9
|
function resolveSignal(options) {
|
|
@@ -97,5 +97,4 @@ async function isOchreJsonAccepted(parameters) {
|
|
|
97
97
|
if (response.status >= 500) throw new Error(`Failed to post ${label}: OCHRE API responded with status ${response.status}`, { cause: response.statusText });
|
|
98
98
|
return response.ok;
|
|
99
99
|
}
|
|
100
|
-
//#endregion
|
|
101
100
|
export { decodeOchreResponse, isOchreJsonAccepted, requestOchre };
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { Query, SetItem, SetItemCategory, SetItemsSort } from "../../types/index.mjs";
|
|
2
2
|
import { FetchBaseOptions, FetchLanguages } from "../../parsers/helpers.mjs";
|
|
3
|
-
//#region src/fetchers/set/items.d.ts
|
|
4
3
|
type FetchSetItemsCategory<TContainedItemCategories extends ReadonlyArray<SetItemCategory> | undefined> = TContainedItemCategories extends ReadonlyArray<infer U> ? Extract<U, SetItemCategory> : SetItemCategory;
|
|
5
4
|
/**
|
|
6
5
|
* Fetches and parses Set items from the OCHRE API
|
|
@@ -38,5 +37,4 @@ export declare function fetchSetItems<const TContainedItemCategories extends Rea
|
|
|
38
37
|
error: string;
|
|
39
38
|
detailedError: string;
|
|
40
39
|
}>;
|
|
41
|
-
//#endregion
|
|
42
40
|
export {};
|
|
@@ -2,7 +2,7 @@ import { getErrorOutput } from "../../errors.mjs";
|
|
|
2
2
|
import { setItemsParametersSchema } from "../../schemas.mjs";
|
|
3
3
|
import { fetchContainerItems } from "../container-items.mjs";
|
|
4
4
|
import * as v from "valibot";
|
|
5
|
-
|
|
5
|
+
// src/fetchers/set/items.ts
|
|
6
6
|
async function fetchSetItems(parameters, containedItemCategories, options) {
|
|
7
7
|
try {
|
|
8
8
|
const { setScopeUuids, belongsToCollectionScopeUuids, queries, sort, page, pageSize } = v.parse(setItemsParametersSchema, parameters);
|
|
@@ -32,5 +32,4 @@ async function fetchSetItems(parameters, containedItemCategories, options) {
|
|
|
32
32
|
};
|
|
33
33
|
}
|
|
34
34
|
}
|
|
35
|
-
//#endregion
|
|
36
35
|
export { fetchSetItems };
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { PropertyValueQueryItem, Query, SetAttributeValueQueryItem } from "../../types/index.mjs";
|
|
2
2
|
import { OchreRequestOptions } from "../request.mjs";
|
|
3
|
-
//#region src/fetchers/set/property-values.d.ts
|
|
4
3
|
/**
|
|
5
4
|
* Fetches and parses Set property values from the OCHRE API
|
|
6
5
|
*
|
|
@@ -41,5 +40,4 @@ export declare function fetchSetPropertyValues(parameters: {
|
|
|
41
40
|
attributeValues: null;
|
|
42
41
|
error: string;
|
|
43
42
|
detailedError: string;
|
|
44
|
-
}>;
|
|
45
|
-
//#endregion
|
|
43
|
+
}>;
|
|
@@ -7,7 +7,7 @@ import { parseXMLContent } from "../../parsers/string.mjs";
|
|
|
7
7
|
import { stringLiteral } from "../../xquery.mjs";
|
|
8
8
|
import { compileContainerItemsQuery, getItemFilterQueries, getPropertyFacetSelectors } from "../../query.mjs";
|
|
9
9
|
import * as v from "valibot";
|
|
10
|
-
|
|
10
|
+
// src/fetchers/set/property-values.ts
|
|
11
11
|
function getLabelContentLanguages(content) {
|
|
12
12
|
const languages = [];
|
|
13
13
|
for (const contentItem of content) if (contentItem.lang !== "zxx" && !languages.includes(contentItem.lang)) languages.push(contentItem.lang);
|
|
@@ -491,5 +491,4 @@ async function fetchSetPropertyValues(parameters, options) {
|
|
|
491
491
|
};
|
|
492
492
|
}
|
|
493
493
|
}
|
|
494
|
-
//#endregion
|
|
495
494
|
export { fetchSetPropertyValues };
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { Query, SetItem, SetItemsSort, TreeItemCategory } from "../../types/index.mjs";
|
|
2
2
|
import { FetchBaseOptions, FetchLanguages } from "../../parsers/helpers.mjs";
|
|
3
|
-
//#region src/fetchers/tree/items.d.ts
|
|
4
3
|
type FetchTreeItemsCategory<TContainedItemCategories extends ReadonlyArray<TreeItemCategory> | undefined> = TContainedItemCategories extends ReadonlyArray<infer U> ? Extract<U, TreeItemCategory> : TreeItemCategory;
|
|
5
4
|
/**
|
|
6
5
|
* Fetches and parses Tree items from the OCHRE API
|
|
@@ -50,5 +49,4 @@ export declare function fetchTreeItems<const TContainedItemCategories extends Re
|
|
|
50
49
|
error: string;
|
|
51
50
|
detailedError: string;
|
|
52
51
|
}>;
|
|
53
|
-
//#endregion
|
|
54
52
|
export {};
|
|
@@ -2,7 +2,7 @@ import { getErrorOutput } from "../../errors.mjs";
|
|
|
2
2
|
import { treeItemsParametersSchema } from "../../schemas.mjs";
|
|
3
3
|
import { fetchContainerItems } from "../container-items.mjs";
|
|
4
4
|
import * as v from "valibot";
|
|
5
|
-
|
|
5
|
+
// src/fetchers/tree/items.ts
|
|
6
6
|
async function fetchTreeItems(parameters, containedItemCategories, options) {
|
|
7
7
|
try {
|
|
8
8
|
const { treeScopeUuids, belongsToCollectionScopeUuids, queries, sort, page, pageSize } = v.parse(treeItemsParametersSchema, parameters);
|
|
@@ -34,5 +34,4 @@ async function fetchTreeItems(parameters, containedItemCategories, options) {
|
|
|
34
34
|
};
|
|
35
35
|
}
|
|
36
36
|
}
|
|
37
|
-
//#endregion
|
|
38
37
|
export { fetchTreeItems };
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { WebsiteMetadata } from "../types/website.mjs";
|
|
2
2
|
import { FetchBaseOptions, FetchLanguages } from "../parsers/helpers.mjs";
|
|
3
|
-
//#region src/fetchers/website-metadata.d.ts
|
|
4
3
|
/**
|
|
5
4
|
* Fetches and parses a page-scoped website metadata projection from the OCHRE
|
|
6
5
|
* API.
|
|
@@ -15,5 +14,4 @@ export declare function fetchWebsiteMetadata<const TLanguages extends ReadonlyAr
|
|
|
15
14
|
websiteMetadata: null;
|
|
16
15
|
error: string;
|
|
17
16
|
detailedError: string;
|
|
18
|
-
}>;
|
|
19
|
-
//#endregion
|
|
17
|
+
}>;
|
|
@@ -7,7 +7,7 @@ import { XMLWebsiteData } from "../xml/schemas.mjs";
|
|
|
7
7
|
import { OCHRE_RESPONSE_PADDING, compileOchreQuery, stringLiteral } from "../xquery.mjs";
|
|
8
8
|
import { websitePresentationReader } from "../parsers/website/reader.mjs";
|
|
9
9
|
import { WEBSITE_WALK_DECLARATIONS } from "../parsers/website/walk.mjs";
|
|
10
|
-
|
|
10
|
+
// src/fetchers/website-metadata.ts
|
|
11
11
|
/**
|
|
12
12
|
* The presentation properties the metadata projection carries
|
|
13
13
|
*
|
|
@@ -154,5 +154,4 @@ async function fetchWebsiteMetadata(abbreviation, options) {
|
|
|
154
154
|
};
|
|
155
155
|
}
|
|
156
156
|
}
|
|
157
|
-
//#endregion
|
|
158
157
|
export { fetchWebsiteMetadata };
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
import { ProtectedWebsite, Website } from "../types/website.mjs";
|
|
2
2
|
import { LanguageCodes } from "../types/index.mjs";
|
|
3
3
|
import { OchreRequestOptions } from "./request.mjs";
|
|
4
|
-
//#region src/fetchers/website.d.ts
|
|
5
4
|
/**
|
|
6
5
|
* Fetches and parses a website configuration from the OCHRE API.
|
|
7
6
|
*
|
|
@@ -32,5 +31,4 @@ export declare function fetchWebsite<const T extends LanguageCodes = LanguageCod
|
|
|
32
31
|
protectedWebsite: null;
|
|
33
32
|
error: string;
|
|
34
33
|
detailedError: string;
|
|
35
|
-
}>;
|
|
36
|
-
//#endregion
|
|
34
|
+
}>;
|
|
@@ -4,7 +4,7 @@ import { parseLanguages } from "../parsers/languages.mjs";
|
|
|
4
4
|
import { XMLWebsiteData } from "../xml/schemas.mjs";
|
|
5
5
|
import { OCHRE_RESPONSE_PADDING, compileOchreQuery, stringLiteral } from "../xquery.mjs";
|
|
6
6
|
import { parseWebsite } from "../parsers/website/index.mjs";
|
|
7
|
-
|
|
7
|
+
// src/fetchers/website.ts
|
|
8
8
|
async function areWebsiteCredentialsValid(uuid, credentials, options) {
|
|
9
9
|
const security = typeof credentials === "string" ? { validate: credentials } : {
|
|
10
10
|
validate: credentials.password,
|
|
@@ -87,5 +87,4 @@ async function fetchWebsite(abbreviation, options) {
|
|
|
87
87
|
};
|
|
88
88
|
}
|
|
89
89
|
}
|
|
90
|
-
//#endregion
|
|
91
90
|
export { fetchWebsite };
|
package/dist/getters.d.mts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { LanguageCodes, PropertyLike, PropertyValueContent } from "./types/index.mjs";
|
|
2
|
-
//#region src/getters.d.ts
|
|
3
2
|
/**
|
|
4
3
|
* Options for property search operations.
|
|
5
4
|
*/
|
|
@@ -135,5 +134,4 @@ export declare function isPropertyMatchingFilter<T extends LanguageCodes = Langu
|
|
|
135
134
|
variableLabel: string;
|
|
136
135
|
value: PropertyValueContent<T>;
|
|
137
136
|
}, options?: PropertyOptions): boolean;
|
|
138
|
-
//#endregion
|
|
139
137
|
export {};
|
package/dist/getters.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { deepEqual } from "fast-equals";
|
|
2
|
-
|
|
2
|
+
// src/getters.ts
|
|
3
3
|
/**
|
|
4
4
|
* The variable label that asks a filter to match against every property
|
|
5
5
|
*/
|
|
@@ -233,5 +233,4 @@ function isPropertyMatchingFilter(property, filter, options = DEFAULT_OPTIONS) {
|
|
|
233
233
|
}
|
|
234
234
|
return false;
|
|
235
235
|
}
|
|
236
|
-
//#endregion
|
|
237
236
|
export { getLeafPropertyValues, getProperty, getPropertyValue, getPropertyValues, getUniqueProperties, getUniquePropertyVariableLabels, isPropertyMatchingFilter, normalizePropertyVariableLabel };
|
package/dist/helpers.d.mts
CHANGED
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { ContainedItemCategory, Item, ItemCategory, ItemPayloadKind, LanguageCodes, SetItemProperty } from "./types/index.mjs";
|
|
2
|
-
//#region src/helpers.d.ts
|
|
3
2
|
type FlattenedItem<U, T extends LanguageCodes> = Omit<U, "properties"> & {
|
|
4
3
|
properties: Array<SetItemProperty<T>>;
|
|
5
4
|
};
|
|
@@ -9,5 +8,4 @@ type FlattenedItem<U, T extends LanguageCodes> = Omit<U, "properties"> & {
|
|
|
9
8
|
* @returns The item with the properties flattened
|
|
10
9
|
*/
|
|
11
10
|
export declare function flattenItemProperties<U extends ItemCategory = ItemCategory, V extends ContainedItemCategory<U> = ContainedItemCategory<U>, T extends LanguageCodes = LanguageCodes, W extends ItemPayloadKind = "topLevel">(item: Item<U, V, T, W>): FlattenedItem<Item<U, V, T, W>, T>;
|
|
12
|
-
//#endregion
|
|
13
11
|
export {};
|
package/dist/helpers.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
// src/helpers.ts
|
|
2
2
|
/**
|
|
3
3
|
* Flatten the properties of an item
|
|
4
4
|
* @param item - The item whose properties to flatten
|
|
@@ -42,5 +42,4 @@ function flattenProperties(properties) {
|
|
|
42
42
|
}
|
|
43
43
|
return result;
|
|
44
44
|
}
|
|
45
|
-
//#endregion
|
|
46
45
|
export { flattenItemProperties };
|
package/dist/index.d.mts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { MultilingualOptions, MultilingualString, MultilingualStringEntries, MultilingualStringEntry, MultilingualStringInput, MultilingualStringJSON, MultilingualStringObject, MultilingualStringText } from "./parsers/multilingual.mjs";
|
|
2
2
|
import { AccordionWebBlock, ContextTree, ContextTreeFilterLevel, ContextTreeFilterVariant, ContextTreeLevel, ContextTreeLevelItem, ProtectedWebsite, ResponsiveStyles, Scope, Style, StylesheetCategory, StylesheetItem, WebAccordionItem, WebBlock, WebBlockByLayout, WebBlockItem, WebBlockLayout, WebElement, WebElementComponent, WebElementComponentName, WebElementComponentOf, WebElementOf, WebIiifViewer, WebImage, WebLoadingVariant, WebOptions, WebRelationVariant, WebSectionDisplay, WebSectionVariant, WebSidebar, WebTitle, Webpage, Website, WebsiteMetadata, WebsitePrivacy, WebsitePropertyQuery, WebsitePropertyQueryNode, WebsiteSegment, WebsiteType } from "./types/website.mjs";
|
|
3
|
-
import { AnyBibliography, AnyConcept, AnyItem, AnyPeriod, AnyPerson, AnyPropertyValue, AnyPropertyVariable, AnyResource, AnySet, AnySpatialUnit, AnyText, AnyTree, BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, ContainedItemCategory, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Context, ContextItem, ContextItemCategory, ContextNode, Coordinates, CoordinatesSource, DictionaryUnitItemLink, EmbeddedBibliography, EmbeddedConcept, EmbeddedItem, EmbeddedPeriod, EmbeddedPerson, EmbeddedPropertyValue, EmbeddedPropertyVariable, EmbeddedResource, EmbeddedSet, EmbeddedSpatialUnit, EmbeddedText, EmbeddedTree, Event, Gallery, Heading, HeadingItemCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemCategoryWithEmbeddedItems, ItemContainerCategory, ItemLink, ItemLinkCategory, ItemLinks, ItemLocation, ItemPayloadKind, ItemProperty, ItemWithoutEmbeddedItems, LanguageCodes, License, MapLayer, Metadata, Note, Observation, OcrString, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyLike, PropertyRelation, PropertyValue, PropertyValueContent, PropertyValueDataType, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, QueryablePropertyValueDataType, RecursiveItemCategory, Resource, ResourceItemLink, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemCategory, SetItemLink, SetItemProperty, SetItemSimplifiedProperty, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetStyle, SetStyleProperty, SetTree, SimplifiedProperty, SpatialUnit, SpatialUnitItemLink, Text, TextItemLink, TopLevelItem, Tree, TreeItemCategory, TreeItemLink } from "./types/index.mjs";
|
|
3
|
+
import { AnyBibliography, AnyConcept, AnyItem, AnyPeriod, AnyPerson, AnyPropertyValue, AnyPropertyVariable, AnyResource, AnySet, AnySpatialUnit, AnyText, AnyTree, BaseItem, BaseItemLink, BelongsTo, Bibliography, BibliographyEntryInfo, BibliographyItemLink, BibliographySourceDocument, Concept, ConceptItemLink, ContainedItemCategory, ContainedItemCategoryFromOption, ContainedItemCategoryOption, Context, ContextItem, ContextItemCategory, ContextNode, Coordinates, CoordinatesSource, DictionaryUnitItemLink, DownloadOption, EmbeddedBibliography, EmbeddedConcept, EmbeddedItem, EmbeddedPeriod, EmbeddedPerson, EmbeddedPropertyValue, EmbeddedPropertyVariable, EmbeddedResource, EmbeddedSet, EmbeddedSpatialUnit, EmbeddedText, EmbeddedTree, Event, Gallery, Heading, HeadingItemCategory, Identification, Image, ImageMap, ImageMapArea, Interpretation, Item, ItemCategory, ItemCategoryFromOption, ItemCategoryOption, ItemCategoryWithEmbeddedItems, ItemContainerCategory, ItemLink, ItemLinkCategory, ItemLinks, ItemLocation, ItemPayloadKind, ItemProperty, ItemWithoutEmbeddedItems, LanguageCodes, License, MapLayer, Metadata, Note, Observation, OcrString, Period, PeriodItemLink, Person, PersonItemLink, Property, PropertyLike, PropertyRelation, PropertyValue, PropertyValueContent, PropertyValueDataType, PropertyValueItemLink, PropertyValueQueryItem, PropertyVariable, PropertyVariableItemLink, Query, QueryGroup, QueryLeaf, QueryablePropertyValueDataType, RecursiveItemCategory, Resource, ResourceItemLink, Section, Set, SetAttributeValueQueryItem, SetBibliography, SetConcept, SetItem, SetItemCategory, SetItemLink, SetItemProperty, SetItemSimplifiedProperty, SetItemsSort, SetItemsSortDirection, SetPeriod, SetResource, SetSpatialUnit, SetStyle, SetStyleProperty, SetTree, SimplifiedProperty, SpatialUnit, SpatialUnitItemLink, Text, TextItemLink, TopLevelItem, Tree, TreeItemCategory, TreeItemLink } from "./types/index.mjs";
|
|
4
4
|
import { DEFAULT_PAGE_SIZE } from "./constants.mjs";
|
|
5
5
|
import { fetchGallery } from "./fetchers/gallery.mjs";
|
|
6
6
|
import { fetchItemChildren } from "./fetchers/item-children.mjs";
|
|
@@ -18,4 +18,4 @@ import { PropertyOptions, PropertySelector, getLeafPropertyValues, getProperty,
|
|
|
18
18
|
import { flattenItemProperties } from "./helpers.mjs";
|
|
19
19
|
import { OCHRE_LANGUAGES, OchreLanguage, OchreLanguageCode, OchreLanguageKind, OchreLanguageStandard, getOchreLanguage, getOchreLanguageCode, isOchreLanguageCode } from "./languages.mjs";
|
|
20
20
|
import { defineLanguages } from "./parsers/languages.mjs";
|
|
21
|
-
export { type AccordionWebBlock, type AnyBibliography, type AnyConcept, type AnyItem, type AnyPeriod, type AnyPerson, type AnyPropertyValue, type AnyPropertyVariable, type AnyResource, type AnySet, type AnySpatialUnit, type AnyText, type AnyTree, type BaseItem, type BaseItemLink, type BelongsTo, type Bibliography, type BibliographyEntryInfo, type BibliographyItemLink, type BibliographySourceDocument, type Concept, type ConceptItemLink, type ContainedItemCategory, type ContainedItemCategoryFromOption, type ContainedItemCategoryOption, type Context, type ContextItem, type ContextItemCategory, type ContextNode, type ContextTree, type ContextTreeFilterLevel, type ContextTreeFilterVariant, type ContextTreeLevel, type ContextTreeLevelItem, type Coordinates, type CoordinatesSource, DEFAULT_PAGE_SIZE, type DictionaryUnitItemLink, type EmbeddedBibliography, type EmbeddedConcept, type EmbeddedItem, type EmbeddedPeriod, type EmbeddedPerson, type EmbeddedPropertyValue, type EmbeddedPropertyVariable, type EmbeddedResource, type EmbeddedSet, type EmbeddedSpatialUnit, type EmbeddedText, type EmbeddedTree, type Event, type Gallery, type Heading, type HeadingItemCategory, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type Item, type ItemCategory, type ItemCategoryFromOption, type ItemCategoryOption, type ItemCategoryWithEmbeddedItems, type ItemContainerCategory, type ItemLink, type ItemLinkCategory, type ItemLinks, type ItemLocation, type ItemPayloadKind, type ItemProperty, type ItemWithoutEmbeddedItems, type LanguageCodes, type License, type MapLayer, type Metadata, type MultilingualOptions, MultilingualString, type MultilingualStringEntries, type MultilingualStringEntry, type MultilingualStringInput, type MultilingualStringJSON, type MultilingualStringObject, type MultilingualStringText, type Note, OCHRE_LANGUAGES, type Observation, type OchreLanguage, type OchreLanguageCode, type OchreLanguageKind, type OchreLanguageStandard, type OcrString, type Period, type PeriodItemLink, type Person, type PersonItemLink, type Property, type PropertyLike, type PropertyOptions, type PropertyRelation, type PropertySelector, type PropertyValue, type PropertyValueContent, type PropertyValueDataType, type PropertyValueItemLink, type PropertyValueQueryItem, type PropertyVariable, type PropertyVariableItemLink, type ProtectedWebsite, type Query, type QueryGroup, type QueryLeaf, type QueryablePropertyValueDataType, type RecursiveItemCategory, type Resource, type ResourceItemLink, type ResponsiveStyles, type Scope, type Section, type Set, type SetAttributeValueQueryItem, type SetBibliography, type SetConcept, type SetItem, type SetItemCategory, type SetItemLink, type SetItemProperty, type SetItemSimplifiedProperty, type SetItemsSort, type SetItemsSortDirection, type SetPeriod, type SetResource, type SetSpatialUnit, type SetStyle, type SetStyleProperty, type SetTree, type SimplifiedProperty, type SpatialUnit, type SpatialUnitItemLink, type Style, type StylesheetCategory, type StylesheetItem, type Text, type TextItemLink, type TopLevelItem, type Tree, type TreeItemCategory, type TreeItemLink, type WebAccordionItem, type WebBlock, type WebBlockByLayout, type WebBlockItem, type WebBlockLayout, type WebElement, type WebElementComponent, type WebElementComponentName, type WebElementComponentOf, type WebElementOf, type WebIiifViewer, type WebImage, type WebLoadingVariant, type WebOptions, type WebRelationVariant, type WebSectionDisplay, type WebSectionVariant, type WebSidebar, type WebTitle, type Webpage, type Website, type WebsiteMetadata, type WebsitePrivacy, type WebsitePropertyQuery, type WebsitePropertyQueryNode, type WebsiteSegment, type WebsiteType, defineLanguages, fetchGallery, fetchItem, fetchItemChildren, fetchItemLinks, fetchItemLocations, fetchItemOcrData, fetchMapLayers, fetchSetItems, fetchSetPropertyValues, fetchTreeItems, fetchWebsite, fetchWebsiteMetadata, flattenItemProperties, getLeafPropertyValues, getOchreLanguage, getOchreLanguageCode, getProperty, getPropertyValue, getPropertyValues, getUniqueProperties, getUniquePropertyVariableLabels, isOchreLanguageCode, isPropertyMatchingFilter, normalizePropertyVariableLabel };
|
|
21
|
+
export { type AccordionWebBlock, type AnyBibliography, type AnyConcept, type AnyItem, type AnyPeriod, type AnyPerson, type AnyPropertyValue, type AnyPropertyVariable, type AnyResource, type AnySet, type AnySpatialUnit, type AnyText, type AnyTree, type BaseItem, type BaseItemLink, type BelongsTo, type Bibliography, type BibliographyEntryInfo, type BibliographyItemLink, type BibliographySourceDocument, type Concept, type ConceptItemLink, type ContainedItemCategory, type ContainedItemCategoryFromOption, type ContainedItemCategoryOption, type Context, type ContextItem, type ContextItemCategory, type ContextNode, type ContextTree, type ContextTreeFilterLevel, type ContextTreeFilterVariant, type ContextTreeLevel, type ContextTreeLevelItem, type Coordinates, type CoordinatesSource, DEFAULT_PAGE_SIZE, type DictionaryUnitItemLink, type DownloadOption, type EmbeddedBibliography, type EmbeddedConcept, type EmbeddedItem, type EmbeddedPeriod, type EmbeddedPerson, type EmbeddedPropertyValue, type EmbeddedPropertyVariable, type EmbeddedResource, type EmbeddedSet, type EmbeddedSpatialUnit, type EmbeddedText, type EmbeddedTree, type Event, type Gallery, type Heading, type HeadingItemCategory, type Identification, type Image, type ImageMap, type ImageMapArea, type Interpretation, type Item, type ItemCategory, type ItemCategoryFromOption, type ItemCategoryOption, type ItemCategoryWithEmbeddedItems, type ItemContainerCategory, type ItemLink, type ItemLinkCategory, type ItemLinks, type ItemLocation, type ItemPayloadKind, type ItemProperty, type ItemWithoutEmbeddedItems, type LanguageCodes, type License, type MapLayer, type Metadata, type MultilingualOptions, MultilingualString, type MultilingualStringEntries, type MultilingualStringEntry, type MultilingualStringInput, type MultilingualStringJSON, type MultilingualStringObject, type MultilingualStringText, type Note, OCHRE_LANGUAGES, type Observation, type OchreLanguage, type OchreLanguageCode, type OchreLanguageKind, type OchreLanguageStandard, type OcrString, type Period, type PeriodItemLink, type Person, type PersonItemLink, type Property, type PropertyLike, type PropertyOptions, type PropertyRelation, type PropertySelector, type PropertyValue, type PropertyValueContent, type PropertyValueDataType, type PropertyValueItemLink, type PropertyValueQueryItem, type PropertyVariable, type PropertyVariableItemLink, type ProtectedWebsite, type Query, type QueryGroup, type QueryLeaf, type QueryablePropertyValueDataType, type RecursiveItemCategory, type Resource, type ResourceItemLink, type ResponsiveStyles, type Scope, type Section, type Set, type SetAttributeValueQueryItem, type SetBibliography, type SetConcept, type SetItem, type SetItemCategory, type SetItemLink, type SetItemProperty, type SetItemSimplifiedProperty, type SetItemsSort, type SetItemsSortDirection, type SetPeriod, type SetResource, type SetSpatialUnit, type SetStyle, type SetStyleProperty, type SetTree, type SimplifiedProperty, type SpatialUnit, type SpatialUnitItemLink, type Style, type StylesheetCategory, type StylesheetItem, type Text, type TextItemLink, type TopLevelItem, type Tree, type TreeItemCategory, type TreeItemLink, type WebAccordionItem, type WebBlock, type WebBlockByLayout, type WebBlockItem, type WebBlockLayout, type WebElement, type WebElementComponent, type WebElementComponentName, type WebElementComponentOf, type WebElementOf, type WebIiifViewer, type WebImage, type WebLoadingVariant, type WebOptions, type WebRelationVariant, type WebSectionDisplay, type WebSectionVariant, type WebSidebar, type WebTitle, type Webpage, type Website, type WebsiteMetadata, type WebsitePrivacy, type WebsitePropertyQuery, type WebsitePropertyQueryNode, type WebsiteSegment, type WebsiteType, defineLanguages, fetchGallery, fetchItem, fetchItemChildren, fetchItemLinks, fetchItemLocations, fetchItemOcrData, fetchMapLayers, fetchSetItems, fetchSetPropertyValues, fetchTreeItems, fetchWebsite, fetchWebsiteMetadata, flattenItemProperties, getLeafPropertyValues, getOchreLanguage, getOchreLanguageCode, getProperty, getPropertyValue, getPropertyValues, getUniqueProperties, getUniquePropertyVariableLabels, isOchreLanguageCode, isPropertyMatchingFilter, normalizePropertyVariableLabel };
|
package/dist/languages.d.mts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
//#region src/languages.d.ts
|
|
2
1
|
/**
|
|
3
2
|
* What an OCHRE language code tags
|
|
4
3
|
*
|
|
@@ -672,5 +671,4 @@ export declare function getOchreLanguage(code: string): OchreLanguage | null;
|
|
|
672
671
|
* @returns The OCHRE code of the language itself, not of a transliteration,
|
|
673
672
|
* or null when OCHRE publishes no code for it
|
|
674
673
|
*/
|
|
675
|
-
export declare function getOchreLanguageCode(iso639_3: string): OchreLanguageCode | null;
|
|
676
|
-
//#endregion
|
|
674
|
+
export declare function getOchreLanguageCode(iso639_3: string): OchreLanguageCode | null;
|