@rcsb/rcsb-search-tools 0.0.1 → 0.0.2

package/lib/SearchClient/SearchClient.d.ts

@@ -0,0 +1,6 @@
+import { SearchRequest } from "@rcsb/rcsb-api-tools/build/RcsbSearch/SearchRequest";
+export declare class SearchClient {
+    private static client;
+    static get(): SearchRequest;
+    static set(client: SearchRequest): void;
+}

package/lib/SearchParseTools/SearchFacetInterface.d.ts

@@ -0,0 +1,49 @@
+import { CardinalityFacet, DateHistogramFacet, DateRangeFacet, FilterFacet, FilterQueryGroupNode, FilterQueryTerminalNode, HistogramFacet, RangeFacet, TermsFacet } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchQueryInterface";
+import { RcsbSearchAttributeType } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchMetadata";
+type TermsFacetType = Omit<TermsFacet, "attribute" | "facets"> & {
+    attribute: RcsbSearchAttributeType;
+    facets?: [(AttributeFacetType | FilterFacetType), ...(AttributeFacetType | FilterFacetType)[]];
+};
+type HistogramFacetType = Omit<HistogramFacet, "attribute" | "facets"> & {
+    attribute: RcsbSearchAttributeType;
+    facets?: [(AttributeFacetType | FilterFacetType), ...(AttributeFacetType | FilterFacetType)[]];
+};
+type DateHistogramFacetType = Omit<DateHistogramFacet, "attribute" | "facets"> & {
+    attribute: RcsbSearchAttributeType;
+    facets?: [(AttributeFacetType | FilterFacetType), ...(AttributeFacetType | FilterFacetType)[]];
+};
+type RangeFacetType = Omit<RangeFacet, "attribute" | "facets"> & {
+    attribute: RcsbSearchAttributeType;
+    facets?: [(AttributeFacetType | FilterFacetType), ...(AttributeFacetType | FilterFacetType)[]];
+};
+type DateRangeFacetType = Omit<DateRangeFacet, "attribute" | "facets"> & {
+    attribute: RcsbSearchAttributeType;
+    facets?: [(AttributeFacetType | FilterFacetType), ...(AttributeFacetType | FilterFacetType)[]];
+};
+type CardinalityFacetType = Omit<CardinalityFacet, "attribute" | "facets"> & {
+    attribute: RcsbSearchAttributeType;
+    facets?: [(AttributeFacetType | FilterFacetType), ...(AttributeFacetType | FilterFacetType)[]];
+};
+export type AttributeFacetType = TermsFacetType | HistogramFacetType | DateHistogramFacetType | RangeFacetType | DateRangeFacetType | CardinalityFacetType;
+type FilterQueryTerminalNodeType = Omit<FilterQueryTerminalNode, "parameters"> & {
+    parameters: Omit<FilterQueryTerminalNode["parameters"], "attribute"> & {
+        attribute: RcsbSearchAttributeType;
+    };
+};
+type FilterQueryGroupNodeType = Omit<FilterQueryGroupNode, "nodes"> & {
+    nodes: [FilterQueryTerminalNodeType | FilterQueryGroupNodeType, ...(FilterQueryTerminalNodeType | FilterQueryGroupNodeType)[]];
+};
+export type FilterFacetType = Omit<FilterFacet, "facets"> & {
+    facets: [AttributeFacetType | FilterFacetType, ...(AttributeFacetType | FilterFacetType)[]];
+    filter: FilterQueryGroupNodeType | FilterQueryTerminalNodeType;
+};
+export type BucketDataType = {
+    label: string | number;
+    population: number;
+};
+export type SearchBucketFacetType = {
+    name: string;
+    data: BucketDataType[];
+    labelPath: string[];
+};
+export {};

package/lib/SearchParseTools/SearchFacetTools.d.ts

@@ -0,0 +1,3 @@
+import { SearchBucketFacetType } from "./SearchFacetInterface";
+import { QueryResult } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchResultInterface";
+export declare function getFacetsFromSearch(searchResult: QueryResult): SearchBucketFacetType[];

package/lib/SearchQueryTools/SearchQueryInterfaces.d.ts

@@ -0,0 +1,18 @@
+import { RcsbSearchAttributeType } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchMetadata";
+import { AttributeTextQueryParameters, GroupNode, RequestOptions, SearchQuery, TerminalNode } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchQueryInterface";
+import { Service } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchEnums";
+import { AttributeFacetType, FilterFacetType } from "../SearchParseTools/SearchFacetInterface";
+export interface SearchAttributeInterface {
+    attribute: RcsbSearchAttributeType;
+    value: AttributeTextQueryParameters['value'];
+    operator: AttributeTextQueryParameters["operator"];
+    service: Service.Text | Service.TextChem;
+    negation?: boolean;
+}
+export type SearchQueryType = GroupNode | TerminalNode;
+export type SearchRequestType = Omit<SearchQuery, "request_options"> & {
+    request_options?: RequestOptionsType;
+};
+export type RequestOptionsType = Omit<RequestOptions, "facets"> & {
+    facets: [(FilterFacetType | AttributeFacetType), ...(FilterFacetType | AttributeFacetType)[]];
+};

package/lib/SearchQueryTools/SearchQueryTools.d.ts

@@ -0,0 +1,9 @@
+import { LogicalOperator, ReturnType } from "@rcsb/rcsb-api-tools/build/RcsbSearch/Types/SearchEnums";
+import { RequestOptionsType, SearchAttributeInterface, SearchQueryType, SearchRequestType } from "./SearchQueryInterfaces";
+export declare function buildRequestFromAttribute(searchAttribute: SearchAttributeInterface, returnType: ReturnType, requestOptions?: RequestOptionsType): SearchRequestType;
+export declare function buildRequestFromAttributeAndSearchQuery(searchAttribute: SearchAttributeInterface, searchQuery: SearchQueryType, returnType: ReturnType, logicalOperator?: LogicalOperator, requestOptions?: RequestOptionsType): SearchRequestType;
+export declare function buildRequestFromCombinedSearchQuery(additionalSearchQuery: SearchQueryType, searchQuery: SearchQueryType, returnType: ReturnType, logicalOperator?: LogicalOperator, requestOptions?: RequestOptionsType): SearchRequestType;
+export declare function buildRequestFromSearchQuery(searchQuery: SearchQueryType, returnType: ReturnType, requestOptions?: RequestOptionsType): SearchRequestType;
+export declare function addAttributeToSearchQuery(searchAttribute: SearchAttributeInterface, searchQuery: SearchQueryType, logicalOperator?: LogicalOperator): SearchQueryType;
+export declare function combineSearchQuery(additionalSearchQuery: SearchQueryType, searchQuery: SearchQueryType, logicalOperator?: LogicalOperator): SearchQueryType;
+export declare function buildAttributeQuery(searchAttribute: SearchAttributeInterface): SearchQueryType;

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@rcsb/rcsb-search-tools",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "RCSB PDB Search API request tools",
   "main": "build/app.js",
   "files": [
     "lib"
   ],
   "scripts": {
-    "test": "jest",
+    "runTest": "jest",
     "tsc": "tsc",
+    "buildApp":  "npm run tsc",
     "publishApp": "npm publish"
   },
   "repository": {
@@ -38,6 +39,6 @@
     "webpack-cli": "^5.1.1"
   },
   "dependencies": {
-    "@rcsb/rcsb-api-tools": "^4.1.5"
+    "@rcsb/rcsb-api-tools": "^4.1.8"
   }
 }