@soton.ac.uk/cape3 0.8.0 → 0.10.0

package/dist/index.d.ts

@@ -1,12 +1,24 @@
 export { default as createCapeApp } from './createCapeApp';
 export { default as CapePlugin } from './plugins/CapePlugin';
+export { type CapeOptions } from './plugins/CapeOptions';
 export { useFilterStore } from "./stores/filterStore";
 export { useDatasetStore } from "./stores/datasetStore";
 export { useFieldStore } from "./stores/fieldStore";
 export { usePropertyStore } from "./stores/propertyStore";
 export { useSearchResultsStore } from "./stores/searchResultsStore";
 export { Filter } from "./filters/Filter";
-export { type CapeOptions } from './plugins/CapeOptions';
-export { type FieldValuePair } from './model/processed/FieldValuePair';
 export { type RecordModel } from './model/processed/RecordModel';
+export { type FieldValuePair } from './model/processed/FieldValuePair';
+export { type EnvironmentMode } from './model/EnvironmentMode';
+export { type CapeAgent } from './model/unprocessed/CapeAgent';
+export { type CapeDataset } from './model/unprocessed/CapeDataset';
+export { type CapeDateField } from './model/unprocessed/CapeDateField';
+export { type CapeEnumField } from './model/unprocessed/CapeEnumField';
+export { type CapeField } from './model/unprocessed/CapeField';
 export { type CapeFieldValue } from './model/unprocessed/CapeFieldValue';
+export { type CapeIntegerField } from './model/unprocessed/CapeIntegerField';
+export { type CapeMetadata } from './model/unprocessed/CapeMetadata';
+export { type CapeNamedLink } from './model/unprocessed/CapeNamedLink';
+export { type CapeProperties } from './model/unprocessed/CapeProperties';
+export { type CapeRecord } from './model/unprocessed/CapeRecord';
+export { type CapeTextField } from './model/unprocessed/CapeTextField';

package/dist/model/EnvironmentMode.d.ts

@@ -0,0 +1 @@
+export type EnvironmentMode = "DEV" | "PPRD" | "PROD" | "UNKNOWN";

package/dist/model/unprocessed/CapeAgent.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Information about an agent.
+ * We are using the FOAF semantics definition of Agent: http://xmlns.com/foaf/0.1/#term_Agent
+ */
+export interface CapeAgent {
+    name?: string;
+    email?: string;
+}

package/dist/model/unprocessed/CapeDataset.d.ts

@@ -0,0 +1,11 @@
+import type { CapeField } from './CapeField';
+import type { CapeRecord } from './CapeRecord';
+import type { CapeProperties } from './CapeProperties';
+/**
+ * A single dataset in the site-data.json
+ */
+export interface CapeDataset {
+    fields: CapeField[];
+    records: CapeRecord[];
+    properties: CapeProperties;
+}

package/dist/model/unprocessed/CapeDateField.d.ts

@@ -0,0 +1,10 @@
+import type { CapeField } from './CapeField';
+import type { DateFilterMode } from '../DateFilterMode';
+export interface CapeDateField extends CapeField {
+    type: 'date';
+    placeholderIs?: string;
+    placeholderBetween?: [string, string];
+    defaultFilterMode?: DateFilterMode;
+    min?: string;
+    max?: string;
+}

package/dist/model/unprocessed/CapeEnumField.d.ts

@@ -0,0 +1,9 @@
+import type { CapeField } from './CapeField';
+import type { EnumFilterMode } from '../EnumFilterMode';
+export interface CapeEnumField extends CapeField {
+    type: 'enum';
+    defaultFilterMode?: EnumFilterMode;
+    filterInputStyleOnIs?: 'radio' | 'select';
+    filterInputStyleOnOneOf?: 'checkbox' | 'multiselect';
+    values: string[];
+}

package/dist/model/unprocessed/CapeField.d.ts

@@ -0,0 +1,18 @@
+/**
+ * A single field in the site-data.json
+ */
+import type { FilterDisplayOptions } from '../FilterDisplayOptions';
+/**
+ * A single field definition in the config.json file. These are only the methods on all types.
+ * It is extended for each subtype.
+ */
+export interface CapeField {
+    id: string;
+    type: 'text' | 'enum' | 'integer' | 'date';
+    isMultiple?: boolean;
+    label: string;
+    description?: string;
+    filterDisplay?: FilterDisplayOptions;
+    changeFilterMode?: boolean;
+    default?: string | string[];
+}

package/dist/model/unprocessed/CapeIntegerField.d.ts

@@ -0,0 +1,11 @@
+import type { CapeField } from './CapeField';
+import type { IntegerFilterMode } from '../IntegerFilterMode';
+export interface CapeIntegerField extends CapeField {
+    type: 'integer';
+    placeholderIs?: string;
+    placeholderBetween?: [string, string];
+    defaultFilterMode?: IntegerFilterMode;
+    min?: number;
+    max?: number;
+    step?: number;
+}

package/dist/model/unprocessed/CapeMetadata.d.ts

@@ -0,0 +1,11 @@
+import type { CapeNamedLink } from './CapeNamedLink';
+import type { CapeAgent } from './CapeAgent';
+/**
+ * The metadata section in a dataset in site-data.json AND config.json
+ */
+export interface CapeMetadata {
+    license?: CapeNamedLink;
+    copyright?: CapeNamedLink;
+    creators?: CapeAgent[];
+    attribution?: CapeNamedLink;
+}

package/dist/model/unprocessed/CapeNamedLink.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A URL with a title
+ */
+export interface CapeNamedLink {
+    title: string;
+    url: string;
+}

package/dist/model/unprocessed/CapeProperties.d.ts

@@ -0,0 +1,11 @@
+import type { CapeMetadata } from './CapeMetadata';
+/**
+ * A single dataset in the site-data.json
+ */
+export interface CapeProperties {
+    title: string;
+    idField: string;
+    sortableFields: string[];
+    metadata?: CapeMetadata;
+    resultMode: "search" | "filter";
+}

package/dist/model/unprocessed/CapeRecord.d.ts

@@ -0,0 +1,6 @@
+import type { CapeFieldValue } from './CapeFieldValue';
+/**
+ * A single dataset in the site-data.json
+ * The string is the ID of a CapeField, defined in the dataset.
+ */
+export type CapeRecord = Record<string, CapeFieldValue>;

package/dist/model/unprocessed/CapeTextField.d.ts

@@ -0,0 +1,8 @@
+import type { CapeField } from './CapeField';
+import type { TextFilterMode } from '../TextFilterMode';
+export interface CapeTextField extends CapeField {
+    type: 'text';
+    placeholderIs?: string;
+    placeholderContains?: string;
+    defaultFilterMode?: TextFilterMode;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soton.ac.uk/cape3",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "private": false,
   "type": "module",
   "main": "./dist/cape3.umd.js",