@rcsb/rcsb-search-tools 0.0.4 → 0.0.6
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/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
RCSB Search Tools is an open-source library that includes different tools to build queries, request and parse data from the
|
|
4
4
|
[RCSB Search API](https://search.rcsb.org/).
|
|
5
5
|
|
|
6
|
-
### Node Module
|
|
6
|
+
### Node Module Installation
|
|
7
7
|
`npm install @rcsb/rcsb-search-tools`
|
|
8
8
|
|
|
9
9
|
### Folder organization
|
|
@@ -16,3 +16,34 @@ RCSB Search Tools is an open-source library that includes different tools to bui
|
|
|
16
16
|
### Examples
|
|
17
17
|
|
|
18
18
|
Multiple examples can be found in the `test` folder as part of unit tests
|
|
19
|
+
|
|
20
|
+
Contributing
|
|
21
|
+
---
|
|
22
|
+
All contributions are welcome. Please, make a pull request or open an issue.
|
|
23
|
+
|
|
24
|
+
License
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
The MIT License
|
|
28
|
+
|
|
29
|
+
Copyright (c) 2023 - now, RCSB PDB and contributors
|
|
30
|
+
|
|
31
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
32
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
33
|
+
in the Software without restriction, including without limitation the rights
|
|
34
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
35
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
36
|
+
furnished to do so, subject to the following conditions:
|
|
37
|
+
|
|
38
|
+
The above copyright notice and this permission notice shall be included in
|
|
39
|
+
all copies or substantial portions of the Software.
|
|
40
|
+
|
|
41
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
42
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
43
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
44
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
45
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
46
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
47
|
+
THE SOFTWARE.
|
|
48
|
+
|
|
49
|
+
|
|
@@ -14,5 +14,5 @@ export type SearchRequestType = Omit<SearchQuery, "request_options"> & {
|
|
|
14
14
|
request_options?: RequestOptionsType;
|
|
15
15
|
};
|
|
16
16
|
export type RequestOptionsType = Omit<RequestOptions, "facets"> & {
|
|
17
|
-
facets
|
|
17
|
+
facets?: [(FilterFacetType | AttributeFacetType), ...(FilterFacetType | AttributeFacetType)[]];
|
|
18
18
|
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rcsb/rcsb-search-tools",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.6",
|
|
4
4
|
"description": "RCSB PDB Search API request tools",
|
|
5
5
|
"main": "build/app.js",
|
|
6
6
|
"files": [
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
"scripts": {
|
|
10
10
|
"runTest": "jest",
|
|
11
11
|
"tsc": "tsc",
|
|
12
|
-
"buildApp":
|
|
12
|
+
"buildApp": "npm run tsc",
|
|
13
13
|
"publishApp": "npm publish"
|
|
14
14
|
},
|
|
15
15
|
"repository": {
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"publishConfig": {
|
|
20
20
|
"registry": "https://registry.npmjs.org/"
|
|
21
21
|
},
|
|
22
|
-
"author": "Joan Segura Mora",
|
|
22
|
+
"author": "Joan Segura Mora <joan.segura@rcsb.org>",
|
|
23
23
|
"license": "MIT",
|
|
24
24
|
"devDependencies": {
|
|
25
25
|
"@babel/core": "^7.18.9",
|
|
@@ -39,6 +39,6 @@
|
|
|
39
39
|
"webpack-cli": "^5.1.1"
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
|
-
"@rcsb/rcsb-api-tools": "^4.1.
|
|
42
|
+
"@rcsb/rcsb-api-tools": "^4.1.11"
|
|
43
43
|
}
|
|
44
44
|
}
|