@byuhbll/components 0.0.8

package/lib/ss-search-bar/simple-search/simple-search.component.d.ts

@@ -0,0 +1,28 @@
+import { EventEmitter, OnDestroy, OnInit } from '@angular/core';
+import { FormControl } from '@angular/forms';
+import { SearchConfig } from '../ss-search-bar.component';
+import * as i0 from "@angular/core";
+export declare class SimpleSearchComponent implements OnInit, OnDestroy {
+    private readonly fb;
+    private searchInput;
+    private inputTooltip;
+    private subscription;
+    private _config;
+    set config(config: SearchConfig);
+    get config(): SearchConfig;
+    simpleSearch: EventEmitter<SearchConfig>;
+    clearSimpleSearch: EventEmitter<void>;
+    protected isSubmitted: boolean;
+    protected searchForm: import("@angular/forms").FormGroup<{
+        simpleQuery: FormControl<string>;
+    }>;
+    get simpleQuery(): FormControl<any>;
+    ngOnInit(): void;
+    ngOnDestroy(): void;
+    protected emitSimpleSearch: () => void;
+    protected clearQuery: () => void;
+    private setupForm;
+    private showSearchValidationToolTip;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SimpleSearchComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SimpleSearchComponent, "lib-ss-simple-search", never, { "config": { "alias": "config"; "required": true; }; }, { "simpleSearch": "simpleSearch"; "clearSimpleSearch": "clearSimpleSearch"; }, never, never, true, never>;
+}

package/lib/ss-search-bar/ss-search-bar.component.d.ts

@@ -0,0 +1,121 @@
+import { EventEmitter } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare const ADVANCED_SEARCH_QUERIES_LIMIT = 12;
+export declare const PERIOD_OPTIONS: readonly ["", "1", "2", "5", "10", "custom"];
+export declare const ADVANCED_SEARCH_OPTIONS: {
+    readonly boolean: readonly ["AND", "OR", "NOT"];
+    readonly localFields: readonly ["any", "title", "callNumber", "creator", "contributor", "isbn", "issn", "genre", "subject", "series"];
+    readonly externalFields: readonly ["allText", "creator", "title", "subject", "source", "abstract", "issn", "isbn"];
+    readonly qualifiers: {
+        readonly any: readonly ["contains"];
+        readonly title: readonly ["contains", "exact", "begins_with", "index"];
+        readonly callNumber: readonly ["contains", "exact", "begins_with", "index"];
+        readonly creator: readonly ["contains", "exact", "begins_with", "index"];
+        readonly contributor: readonly ["contains", "exact"];
+        readonly isbn: readonly ["contains", "exact"];
+        readonly issn: readonly ["contains", "exact"];
+        readonly genre: readonly ["contains", "exact"];
+        readonly subject: readonly ["contains", "exact", "subject_lc", "subject_expanded"];
+        readonly series: readonly ["contains", "exact"];
+    };
+    readonly resultsPerPage: readonly ["10", "20", "50", "100"];
+    readonly period: readonly ["", "1", "2", "5", "10", "custom"];
+    readonly languages: readonly ["eng", "ara", "chi", "ces", "dan", "dut", "fin", "fre", "ger", "gre", "heb", "hin", "hun", "ice", "ita", "jpn", "kor", "lat", "nor", "pol", "por", "pan", "rum", "rus", "spa", "swe", "wel", "yid"];
+};
+export type AdvancedSearchBooleanOption = (typeof ADVANCED_SEARCH_OPTIONS.boolean)[number];
+export type AdvancedSearchLocalFieldOption = (typeof ADVANCED_SEARCH_OPTIONS.localFields)[number];
+export declare const isAdvancedSearchLocalFieldOption: (field: string) => field is "any" | "title" | "callNumber" | "creator" | "contributor" | "isbn" | "issn" | "genre" | "subject" | "series";
+export type AdvancedSearchExternalFieldOption = (typeof ADVANCED_SEARCH_OPTIONS.externalFields)[number];
+export declare const isAdvancedSearchExternalFieldOption: (field: string) => field is "title" | "creator" | "isbn" | "issn" | "subject" | "allText" | "source" | "abstract";
+export type AdvancedSearchQualifierOption = (typeof ADVANCED_SEARCH_OPTIONS.qualifiers)[keyof typeof ADVANCED_SEARCH_OPTIONS.qualifiers][number];
+export type AdvancedSearchResultsPerPageOption = (typeof ADVANCED_SEARCH_OPTIONS.resultsPerPage)[number];
+export type AdvancedSearchLanguageOption = (typeof ADVANCED_SEARCH_OPTIONS.languages)[number];
+export type AdvancedSearchQualifier = keyof typeof ADVANCED_SEARCH_OPTIONS.qualifiers;
+export interface AdvancedSearchQueryRow {
+    boolean?: AdvancedSearchBooleanOption;
+    field?: AdvancedSearchLocalFieldOption | AdvancedSearchExternalFieldOption;
+    qualifier?: AdvancedSearchQualifierOption;
+    query: string;
+}
+export interface SearchConfig {
+    showExternalTab: boolean;
+    showAdvancedSearch: boolean;
+    showAdvancedSearchAsText: boolean;
+    scope: 'local' | 'external';
+    q: string;
+    isFacetSearch: boolean;
+    advancedSearchQueryRows: AdvancedSearchQueryRow[];
+    localAdvancedSearch: {
+        selectedResourceTypes: string[];
+        availableResourceTypes: Record<string, string>;
+        selectedCollections: string[];
+        availableCollections: Record<string, string>;
+    };
+    externalAdvancedSearch: {
+        datePublished: {
+            from: string;
+            to: string;
+        };
+        selectedLanguages: string[];
+        availableLanguages: Record<string, string>;
+        limitResults: {
+            peerReviewed: boolean;
+        };
+        expandResults: {
+            applyRelatedWords: boolean;
+            applyEquivalentSubjects: boolean;
+            fullText: boolean;
+        };
+    };
+}
+/**
+ * Accepts as input, and emits as events, SearchConfig objects:
+ * ```
+ * SearchConfig {
+    showExternalTab: boolean;
+    showAdvancedSearch: boolean;
+    showAdvancedSearchAsText: boolean;
+    scope: 'local' | 'external';
+    q: string;
+    isFacetSearch: boolean;
+    advancedSearchQueryRows: AdvancedSearchQueryRow[];
+    localAdvancedSearch: {
+        selectedResourceTypes: string[];
+        availableResourceTypes: Record<string, string>;
+        selectedCollections: string[];
+        availableCollections: Record<string, string>;
+    };
+    externalAdvancedSearch: {
+        datePublished: { from: string; to: string };
+        selectedLanguages: string[];
+        availableLanguages: Record<string, string>;
+        limitResults: {
+            peerReviewed: boolean;
+        };
+        expandResults: {
+            applyRelatedWords: boolean;
+            applyEquivalentSubjects: boolean;
+            fullText: boolean;
+        };
+    };
+ * ```
+ */
+export declare class SsSearchBarComponent {
+    private _config;
+    set config(config: string);
+    get config(): SearchConfig;
+    simpleSearch: EventEmitter<SearchConfig>;
+    clearSimpleSearch: EventEmitter<SearchConfig>;
+    advancedSearch: EventEmitter<SearchConfig>;
+    advancedSearchClosed: EventEmitter<SearchConfig>;
+    private barWrapperRef;
+    protected heightOfContainer: number;
+    protected emitClearSimpleSearch: () => void;
+    protected emitSimpleSearch: (updatedProps: Partial<SearchConfig>) => void;
+    protected emitAdvancedSearchClosed: () => void;
+    protected emitAdvancedSearch: (config: SearchConfig) => void;
+    protected goToFacetSearchInExternalScope: () => void;
+    protected showFullAdvancedSearch: () => void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SsSearchBarComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<SsSearchBarComponent, "lib-ss-search-bar", never, { "config": { "alias": "config"; "required": true; }; }, { "simpleSearch": "simpleSearch"; "clearSimpleSearch": "clearSimpleSearch"; "advancedSearch": "advancedSearch"; "advancedSearchClosed": "advancedSearchClosed"; }, never, never, true, never>;
+}

package/lib/ss-search-bar/utils.d.ts

@@ -0,0 +1,7 @@
+import { ValidatorFn } from '@angular/forms';
+/**
+ * Validator method to check if a `FormGroup<{ from: FormControl<string>; to: FormControl<string> }>` is valid.
+ * The FormGroup is considered valid if either both `from` and `to` are set, or both are empty strings.
+ * @returns {ValidationErrors | null} validation errors, if any
+ */
+export declare const validateDateRangeFields: () => ValidatorFn;

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@byuhbll/components",
+  "version": "0.0.8",
+  "peerDependencies": {
+    "@angular/common": "^18.0.0",
+    "@angular/core": "^18.0.0"
+  },
+  "dependencies": {
+    "tslib": "^2.3.0"
+  },
+  "sideEffects": false,
+  "module": "fesm2022/byuhbll-components.mjs",
+  "typings": "index.d.ts",
+  "exports": {
+    "./package.json": {
+      "default": "./package.json"
+    },
+    ".": {
+      "types": "./index.d.ts",
+      "esm2022": "./esm2022/byuhbll-components.mjs",
+      "esm": "./esm2022/byuhbll-components.mjs",
+      "default": "./fesm2022/byuhbll-components.mjs"
+    }
+  }
+}

package/public-api.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/hbll-header/hbll-header.component';
+export * from './lib/ss-search-bar/ss-search-bar.component';