@genobank/biofs 2.4.1 → 2.5.1
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/CHANGELOG.md +2 -0
- package/LICENSE +37 -0
- package/README.md +2 -1
- package/bin/biofs.js +2 -1
- package/contracts/ClaraJobNFT.sol +101 -0
- package/dist/commands/agent/health.js +1 -1
- package/dist/commands/agent/health.js.map +1 -1
- package/dist/commands/agent/list.d.ts +14 -0
- package/dist/commands/agent/list.d.ts.map +1 -0
- package/dist/commands/agent/list.js +101 -0
- package/dist/commands/agent/list.js.map +1 -0
- package/dist/commands/agent/register.d.ts +18 -0
- package/dist/commands/agent/register.d.ts.map +1 -0
- package/dist/commands/agent/register.js +120 -0
- package/dist/commands/agent/register.js.map +1 -0
- package/dist/commands/agent/status.d.ts +14 -0
- package/dist/commands/agent/status.d.ts.map +1 -0
- package/dist/commands/agent/status.js +151 -0
- package/dist/commands/agent/status.js.map +1 -0
- package/dist/commands/annotate/status.d.ts +11 -0
- package/dist/commands/annotate/status.d.ts.map +1 -0
- package/dist/commands/annotate/status.js +123 -0
- package/dist/commands/annotate/status.js.map +1 -0
- package/dist/commands/annotate/submit.d.ts +23 -0
- package/dist/commands/annotate/submit.d.ts.map +1 -0
- package/dist/commands/annotate/submit.js +296 -0
- package/dist/commands/annotate/submit.js.map +1 -0
- package/dist/commands/family-status.d.ts +12 -0
- package/dist/commands/family-status.d.ts.map +1 -0
- package/dist/commands/family-status.js +220 -0
- package/dist/commands/family-status.js.map +1 -0
- package/dist/commands/job/status.d.ts +1 -0
- package/dist/commands/job/status.d.ts.map +1 -1
- package/dist/commands/job/status.js.map +1 -1
- package/dist/commands/link-clara.d.ts +20 -0
- package/dist/commands/link-clara.d.ts.map +1 -0
- package/dist/commands/link-clara.js +234 -0
- package/dist/commands/link-clara.js.map +1 -0
- package/dist/commands/mount-remote.d.ts +1 -1
- package/dist/commands/mount-remote.js +1 -1
- package/dist/commands/payment/balance.d.ts +12 -0
- package/dist/commands/payment/balance.d.ts.map +1 -0
- package/dist/commands/payment/balance.js +101 -0
- package/dist/commands/payment/balance.js.map +1 -0
- package/dist/commands/payment/faucet.d.ts +11 -0
- package/dist/commands/payment/faucet.d.ts.map +1 -0
- package/dist/commands/payment/faucet.js +92 -0
- package/dist/commands/payment/faucet.js.map +1 -0
- package/dist/commands/payment/history.d.ts +27 -0
- package/dist/commands/payment/history.d.ts.map +1 -0
- package/dist/commands/payment/history.js +162 -0
- package/dist/commands/payment/history.js.map +1 -0
- package/dist/commands/payment/pricing.d.ts +12 -0
- package/dist/commands/payment/pricing.d.ts.map +1 -0
- package/dist/commands/payment/pricing.js +65 -0
- package/dist/commands/payment/pricing.js.map +1 -0
- package/dist/commands/payment/setup.d.ts +25 -0
- package/dist/commands/payment/setup.d.ts.map +1 -0
- package/dist/commands/payment/setup.js +155 -0
- package/dist/commands/payment/setup.js.map +1 -0
- package/dist/commands/tokenize-biosample.d.ts +19 -0
- package/dist/commands/tokenize-biosample.d.ts.map +1 -0
- package/dist/commands/tokenize-biosample.js +253 -0
- package/dist/commands/tokenize-biosample.js.map +1 -0
- package/dist/index.js +281 -13
- package/dist/index.js.map +1 -1
- package/dist/lib/api/bionft-client.d.ts +35 -7
- package/dist/lib/api/bionft-client.d.ts.map +1 -1
- package/dist/lib/api/bionft-client.js +106 -16
- package/dist/lib/api/bionft-client.js.map +1 -1
- package/dist/lib/kite/agent.d.ts +85 -0
- package/dist/lib/kite/agent.d.ts.map +1 -0
- package/dist/lib/kite/agent.js +332 -0
- package/dist/lib/kite/agent.js.map +1 -0
- package/dist/lib/kite/index.d.ts +9 -0
- package/dist/lib/kite/index.d.ts.map +1 -0
- package/dist/lib/kite/index.js +25 -0
- package/dist/lib/kite/index.js.map +1 -0
- package/dist/lib/kite/passport.d.ts +69 -0
- package/dist/lib/kite/passport.d.ts.map +1 -0
- package/dist/lib/kite/passport.js +312 -0
- package/dist/lib/kite/passport.js.map +1 -0
- package/dist/lib/x402/client.d.ts +78 -0
- package/dist/lib/x402/client.d.ts.map +1 -0
- package/dist/lib/x402/client.js +298 -0
- package/dist/lib/x402/client.js.map +1 -0
- package/dist/lib/x402/index.d.ts +9 -0
- package/dist/lib/x402/index.d.ts.map +1 -0
- package/dist/lib/x402/index.js +37 -0
- package/dist/lib/x402/index.js.map +1 -0
- package/dist/lib/x402/middleware.d.ts +37 -0
- package/dist/lib/x402/middleware.d.ts.map +1 -0
- package/dist/lib/x402/middleware.js +220 -0
- package/dist/lib/x402/middleware.js.map +1 -0
- package/dist/types/kite.d.ts +157 -0
- package/dist/types/kite.d.ts.map +1 -0
- package/dist/types/kite.js +107 -0
- package/dist/types/kite.js.map +1 -0
- package/dist/types/x402.d.ts +78 -0
- package/dist/types/x402.d.ts.map +1 -0
- package/dist/types/x402.js +79 -0
- package/dist/types/x402.js.map +1 -0
- package/docs/AI_AGENT_MCP_MANUAL.md +1029 -0
- package/docs/USER_MANUAL.md +603 -0
- package/docs/technical-details.html +555 -0
- package/lib/bionfs-client.js +2 -0
- package/lib/consent-manager.js +2 -0
- package/lib/consent-prompt.js +2 -0
- package/package.json +9 -3
- package/presentation/biofs-x402-kite-presentation.html +813 -0
- package/scripts/build_annotator_dictionary.py +1 -0
- package/scripts/deploy-clara-nft.js +37 -0
- package/test-complete-flow.sh +1 -1
- package/test.vcf +1 -0
- package/test_23andme.txt +1 -0
- package/ADMIN_REGISTER_LAB.md +0 -252
- package/ANNOTATOR_RECOMMENDATIONS_API.md +0 -490
- package/BIOFS_QUICK_START.md +0 -200
- package/BIOFS_TOKENIZE_COMPLETE.md +0 -541
- package/BIOFS_V1.2.7_PUBLISHED.md +0 -317
- package/BIOFS_V1.2.9_FIXES.md +0 -306
- package/BIOFS_V1.3.0_DIRECT_GRANT.md +0 -381
- package/BIOFS_V1.3.1_GRANTED_FILES.md +0 -328
- package/BIONFS_DEPLOYMENT_GUIDE.md +0 -408
- package/BIONFS_MOUNT_INTEGRATION_PLAN.md +0 -415
- package/BIONFS_PROTOCOL_SPECIFICATION.md +0 -688
- package/BIONFS_SEQUENTIAS_INTEGRATION.md +0 -457
- package/BIONFT_GATED_REMOTE_MOUNTING.md +0 -1260
- package/BIONFT_NFS_PROTOCOL_ARCHITECTURE.md +0 -583
- package/BIOOS_CLI_IMPLEMENTATION_COMPLETE.md +0 -422
- package/BIOOS_JOB_MANAGEMENT.md +0 -681
- package/BUGFIX_V2.1.3.md +0 -72
- package/CHANGELOG_V2.1.0.md +0 -386
- package/CHANGELOG_V2.2.0.md +0 -284
- package/ENHANCEMENT_DOCUMENTATION.md +0 -218
- package/GDPR_BIONFS_CONSENT_ARCHITECTURE.md +0 -798
- package/GDPR_BIONFS_IMPLEMENTATION_STATUS.md +0 -462
- package/INSTALL_V1.2.7_ON_MAC.md +0 -306
- package/LABNFT_BIOFS_INTEGRATION.md +0 -396
- package/OPENCRAVAT_ANNOTATORS_REFERENCE.md +0 -340
- package/OPENCRAVAT_ANNOTATOR_INTELLIGENCE_COMPLETE.md +0 -479
- package/QUICK_START_V2.1.0.md +0 -116
- package/RELEASE_SUMMARY_V1.2.7.md +0 -479
- package/RELEASE_SUMMARY_V1.3.0.md +0 -324
- package/SEQUENTIAS_PROTOCOL_ARCHITECTURE.md +0 -880
- package/SEQUENTIA_MIGRATION_GUIDE.md +0 -337
- package/SESSION_SUMMARY_DIRECT_GRANT.md +0 -321
- package/ULTRATHINK_BIONFS_COMPLETE.md +0 -458
- package/WEB3FUSE_LICENSE_TOKEN_ANALYSIS.md +0 -494
- package/WHERE_PERMISSIONS_LIVE.md +0 -165
- package/config.json +0 -21
- package/opencravat_annotators_dictionary.json +0 -2356
- package/package.json.working.v1.9.2.20251105_023952 +0 -48
|
@@ -1,317 +0,0 @@
|
|
|
1
|
-
# BioFS v1.2.7 - Published to npm ✅
|
|
2
|
-
|
|
3
|
-
## 🎉 Successfully Published!
|
|
4
|
-
|
|
5
|
-
**Package**: `@genobank/biofs@1.2.7`
|
|
6
|
-
**npm Registry**: https://www.npmjs.com/package/@genobank/biofs
|
|
7
|
-
**Published**: October 7, 2025
|
|
8
|
-
**Package Size**: 154.4 KB
|
|
9
|
-
**Unpacked Size**: 714.2 KB
|
|
10
|
-
**Total Files**: 192
|
|
11
|
-
|
|
12
|
-
## Installation
|
|
13
|
-
|
|
14
|
-
### Quick Install (Recommended)
|
|
15
|
-
|
|
16
|
-
```bash
|
|
17
|
-
npm install -g @genobank/biofs@1.2.7
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
### Verify Installation
|
|
21
|
-
|
|
22
|
-
```bash
|
|
23
|
-
biofs --version # Should show: 1.2.7
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## What's New in v1.2.7
|
|
27
|
-
|
|
28
|
-
### 🧬 OpenCRAVAT Annotator Intelligence (NEW!)
|
|
29
|
-
|
|
30
|
-
**Complete Dictionary System**:
|
|
31
|
-
- **146 annotators** catalogued and categorized
|
|
32
|
-
- **12 categories**: clinical_significance, cancer, population_frequency, variant_effect_prediction, pharmacogenomics, mendelian_disease, splicing, regulatory, conservation, pathways, protein_function, other
|
|
33
|
-
- **7 phenotype recommendations**: cancer, cardiovascular, hereditary_cancer, rare_disease, pharmacogenomics, autism, developmental_delay
|
|
34
|
-
- **4 analysis type recommendations**: rare_coding, splicing, regulatory, de_novo
|
|
35
|
-
|
|
36
|
-
**API Endpoints Added**:
|
|
37
|
-
1. `GET /api_bioos/annotator_recommendations?phenotype={type}` - Smart recommendations
|
|
38
|
-
2. `GET /api_bioos/annotator_dictionary?category={cat}` - Browse all annotators
|
|
39
|
-
|
|
40
|
-
**Example Usage**:
|
|
41
|
-
```bash
|
|
42
|
-
# Get cancer-specific annotators
|
|
43
|
-
curl "https://genobank.app/api_bioos/annotator_recommendations?phenotype=cancer"
|
|
44
|
-
# Returns: clinvar, cosmic, cancer_genome_interpreter, cancer_hotspots, civic, oncokb, chasmplus, gnomad, alphamissense, revel
|
|
45
|
-
|
|
46
|
-
# Get rare disease annotators
|
|
47
|
-
curl "https://genobank.app/api_bioos/annotator_recommendations?phenotype=rare_disease"
|
|
48
|
-
# Returns: clinvar, clinvar_acmg, omim, hpo, gnomad, alphamissense, cadd, sift, polyphen2, spliceai
|
|
49
|
-
|
|
50
|
-
# Get splicing-specific annotators
|
|
51
|
-
curl "https://genobank.app/api_bioos/annotator_recommendations?analysis_type=splicing"
|
|
52
|
-
# Returns: clinvar, spliceai, dbscsnv, gnomad
|
|
53
|
-
|
|
54
|
-
# Look up specific annotator
|
|
55
|
-
curl "https://genobank.app/api_bioos/annotator_dictionary?name=alphamissense"
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
**Natural Language Mapping for Claude API**:
|
|
59
|
-
|
|
60
|
-
| User Says | Claude Maps To | Annotators Selected |
|
|
61
|
-
|-----------|----------------|---------------------|
|
|
62
|
-
| "find cancer variants" | `phenotype=cancer` | cosmic, civic, oncokb, chasmplus |
|
|
63
|
-
| "rare coding variants" | `analysis_type=rare_coding` | gnomad, alphamissense, revel, cadd |
|
|
64
|
-
| "splice site mutations" | `analysis_type=splicing` | spliceai, dbscsnv |
|
|
65
|
-
| "autism spectrum disorder" | `phenotype=autism` | clinvar, omim, hpo, denovo |
|
|
66
|
-
|
|
67
|
-
### 🔬 BioOS Job Management (from v1.2.6)
|
|
68
|
-
|
|
69
|
-
- Natural language job creation: `biofs job create "Annotate VCF with rare coding variants" sample.vcf`
|
|
70
|
-
- Real-time monitoring: `biofs job status <job_id> --watch`
|
|
71
|
-
- Pipeline templates: `biofs job pipelines`
|
|
72
|
-
- Story Protocol IP lineage tracking
|
|
73
|
-
- Presigned S3 download URLs
|
|
74
|
-
- SHA256 file verification
|
|
75
|
-
|
|
76
|
-
### 🎨 Enhanced User Experience
|
|
77
|
-
|
|
78
|
-
- Progress bars for job execution
|
|
79
|
-
- Color-coded status indicators
|
|
80
|
-
- Formatted tables for data display
|
|
81
|
-
- JSON output for all commands
|
|
82
|
-
|
|
83
|
-
## Available Commands
|
|
84
|
-
|
|
85
|
-
### Authentication
|
|
86
|
-
```bash
|
|
87
|
-
biofs login # Web3 wallet authentication
|
|
88
|
-
biofs logout # Clear credentials
|
|
89
|
-
biofs whoami # Show current wallet
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### File Management
|
|
93
|
-
```bash
|
|
94
|
-
biofs files # List your BioFiles
|
|
95
|
-
biofs download <file> # Download files
|
|
96
|
-
biofs upload <file> # Upload files
|
|
97
|
-
biofs tokenize <file> # Tokenize as BioIP NFT
|
|
98
|
-
```
|
|
99
|
-
|
|
100
|
-
### BioOS Job Management
|
|
101
|
-
```bash
|
|
102
|
-
biofs job pipelines # List available templates
|
|
103
|
-
biofs job create "prompt" <file> # Create research job
|
|
104
|
-
biofs job status <job_id> [--watch] # Check status
|
|
105
|
-
biofs job results <job_id> # Get results
|
|
106
|
-
biofs job list [--status <status>] # List all jobs
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
### Access Control
|
|
110
|
-
```bash
|
|
111
|
-
biofs access request <biocid> # Request access
|
|
112
|
-
biofs access grant <biocid> <wallet> # Grant access (owner)
|
|
113
|
-
biofs access revoke <biocid> <wallet> # Revoke access (owner)
|
|
114
|
-
biofs access list [biocid] # List permissions
|
|
115
|
-
biofs access check <biocid> # Check your access
|
|
116
|
-
```
|
|
117
|
-
|
|
118
|
-
## Testing the New Features
|
|
119
|
-
|
|
120
|
-
### Test Annotator Intelligence
|
|
121
|
-
|
|
122
|
-
```bash
|
|
123
|
-
# Get recommendations for cancer analysis
|
|
124
|
-
curl "https://genobank.app/api_bioos/annotator_recommendations?phenotype=cancer"
|
|
125
|
-
|
|
126
|
-
# Get recommendations for rare disease
|
|
127
|
-
curl "https://genobank.app/api_bioos/annotator_recommendations?phenotype=rare_disease"
|
|
128
|
-
|
|
129
|
-
# Browse all 146 annotators
|
|
130
|
-
curl "https://genobank.app/api_bioos/annotator_dictionary"
|
|
131
|
-
|
|
132
|
-
# Look up AlphaMissense
|
|
133
|
-
curl "https://genobank.app/api_bioos/annotator_dictionary?name=alphamissense"
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
### Create a Job with Smart Annotator Selection
|
|
137
|
-
|
|
138
|
-
```bash
|
|
139
|
-
# Natural language - Claude API picks annotators
|
|
140
|
-
biofs job create "Find pathogenic variants in BRCA1/BRCA2" sample.vcf
|
|
141
|
-
# Claude uses: phenotype=hereditary_cancer
|
|
142
|
-
# Selects: clinvar, brca1_func_assay, cosmic, alphamissense
|
|
143
|
-
|
|
144
|
-
# Specific analysis type
|
|
145
|
-
biofs job create "Analyze splice variants" sample.vcf
|
|
146
|
-
# Claude uses: analysis_type=splicing
|
|
147
|
-
# Selects: clinvar, spliceai, dbscsnv, gnomad
|
|
148
|
-
```
|
|
149
|
-
|
|
150
|
-
## Documentation Included
|
|
151
|
-
|
|
152
|
-
1. **OPENCRAVAT_ANNOTATORS_REFERENCE.md** - All 146 annotators categorized
|
|
153
|
-
2. **ANNOTATOR_RECOMMENDATIONS_API.md** - API documentation
|
|
154
|
-
3. **OPENCRAVAT_ANNOTATOR_INTELLIGENCE_COMPLETE.md** - Implementation guide
|
|
155
|
-
4. **BIOOS_JOB_MANAGEMENT.md** - Job management guide
|
|
156
|
-
5. **INSTALL_V1.2.7_ON_MAC.md** - Installation instructions
|
|
157
|
-
|
|
158
|
-
## Files Included in Package
|
|
159
|
-
|
|
160
|
-
### Core CLI (TypeScript compiled to JavaScript)
|
|
161
|
-
- Complete authentication flow
|
|
162
|
-
- BioFiles management
|
|
163
|
-
- BioIP tokenization
|
|
164
|
-
- BioOS job orchestration
|
|
165
|
-
- Access control
|
|
166
|
-
|
|
167
|
-
### Annotator Intelligence
|
|
168
|
-
- `opencravat_annotators_dictionary.json` - 146 annotators
|
|
169
|
-
- `scripts/build_annotator_dictionary.py` - Dictionary builder
|
|
170
|
-
|
|
171
|
-
### Test Files
|
|
172
|
-
- `test.vcf` - Sample VCF
|
|
173
|
-
- `test_23andme.txt` - Sample 23andMe data
|
|
174
|
-
- `test-complete-flow.sh` - Integration test
|
|
175
|
-
|
|
176
|
-
## Troubleshooting
|
|
177
|
-
|
|
178
|
-
### Update from Previous Version
|
|
179
|
-
|
|
180
|
-
```bash
|
|
181
|
-
# Uninstall old version
|
|
182
|
-
npm uninstall -g @genobank/biofs
|
|
183
|
-
|
|
184
|
-
# Install new version
|
|
185
|
-
npm install -g @genobank/biofs@1.2.7
|
|
186
|
-
|
|
187
|
-
# Verify
|
|
188
|
-
biofs --version # Should show 1.2.7
|
|
189
|
-
```
|
|
190
|
-
|
|
191
|
-
### Permission Errors
|
|
192
|
-
|
|
193
|
-
```bash
|
|
194
|
-
# Use sudo on Mac
|
|
195
|
-
sudo npm install -g @genobank/biofs@1.2.7
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
### Clear Cache if Needed
|
|
199
|
-
|
|
200
|
-
```bash
|
|
201
|
-
npm cache clean --force
|
|
202
|
-
npm install -g @genobank/biofs@1.2.7
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
## API Infrastructure
|
|
206
|
-
|
|
207
|
-
### Production API Endpoints
|
|
208
|
-
- **Base URL**: https://genobank.app/api_bioos/
|
|
209
|
-
- **annotator_recommendations** - Smart annotator selection
|
|
210
|
-
- **annotator_dictionary** - Browse all annotators
|
|
211
|
-
- **create_job** - Create research job
|
|
212
|
-
- **job_status** - Check job progress
|
|
213
|
-
- **job_results** - Get results
|
|
214
|
-
- **pipeline_list** - List templates
|
|
215
|
-
- **user_jobs** - List user jobs
|
|
216
|
-
|
|
217
|
-
### Files Modified in Production
|
|
218
|
-
1. `/home/ubuntu/Genobank_APIs/production_api/plugins/bioos/api_bioos.py` - Added 2 endpoints
|
|
219
|
-
2. `/home/ubuntu/Genobank_APIs/production_api/plugins/bioos/opencravat_annotators_dictionary.json` - 146 annotators
|
|
220
|
-
|
|
221
|
-
## Impact & Benefits
|
|
222
|
-
|
|
223
|
-
### For Researchers
|
|
224
|
-
- **Context-aware analysis**: Claude API selects the right annotators automatically
|
|
225
|
-
- **146 annotators available**: Complete OpenCRAVAT catalog
|
|
226
|
-
- **Clinical relevance**: Phenotype-driven recommendations
|
|
227
|
-
- **Time savings**: No manual annotator selection
|
|
228
|
-
|
|
229
|
-
### For Developers
|
|
230
|
-
- **REST API access**: Programmatic annotator recommendations
|
|
231
|
-
- **Natural language processing**: Map user intent → annotators
|
|
232
|
-
- **Complete metadata**: Citations, versions, descriptions
|
|
233
|
-
- **Educational**: Learn what each annotator does
|
|
234
|
-
|
|
235
|
-
### For Claude API
|
|
236
|
-
- **Intelligent selection**: Recommend annotators based on phenotype/analysis type
|
|
237
|
-
- **Quick reference**: Browse 146 annotators instantly
|
|
238
|
-
- **Flexible queries**: By category, name, phenotype, or analysis type
|
|
239
|
-
- **Up-to-date**: Versions and citations included
|
|
240
|
-
|
|
241
|
-
## Example Workflows
|
|
242
|
-
|
|
243
|
-
### Cancer Analysis
|
|
244
|
-
```bash
|
|
245
|
-
# User creates job
|
|
246
|
-
biofs job create "Find pathogenic variants in cancer genes" tumor.vcf
|
|
247
|
-
|
|
248
|
-
# Claude API queries
|
|
249
|
-
GET /api_bioos/annotator_recommendations?phenotype=cancer
|
|
250
|
-
|
|
251
|
-
# Claude receives
|
|
252
|
-
{
|
|
253
|
-
"recommended_annotators": [
|
|
254
|
-
"clinvar", "cosmic", "cancer_genome_interpreter",
|
|
255
|
-
"cancer_hotspots", "civic", "oncokb", "chasmplus",
|
|
256
|
-
"gnomad", "alphamissense", "revel"
|
|
257
|
-
]
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
# Job created with these annotators
|
|
261
|
-
```
|
|
262
|
-
|
|
263
|
-
### Rare Disease Analysis
|
|
264
|
-
```bash
|
|
265
|
-
# User creates job
|
|
266
|
-
biofs job create "Analyze for rare Mendelian disease" proband.vcf
|
|
267
|
-
|
|
268
|
-
# Claude API queries
|
|
269
|
-
GET /api_bioos/annotator_recommendations?phenotype=rare_disease
|
|
270
|
-
|
|
271
|
-
# Claude receives comprehensive rare disease panel
|
|
272
|
-
{
|
|
273
|
-
"recommended_annotators": [
|
|
274
|
-
"clinvar", "clinvar_acmg", "omim", "hpo",
|
|
275
|
-
"gnomad", "alphamissense", "cadd",
|
|
276
|
-
"sift", "polyphen2", "spliceai"
|
|
277
|
-
]
|
|
278
|
-
}
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
### Splicing Analysis
|
|
282
|
-
```bash
|
|
283
|
-
# User creates job
|
|
284
|
-
biofs job create "Find splice site variants" patient.vcf
|
|
285
|
-
|
|
286
|
-
# Claude API queries
|
|
287
|
-
GET /api_bioos/annotator_recommendations?analysis_type=splicing
|
|
288
|
-
|
|
289
|
-
# Focused splicing panel returned
|
|
290
|
-
{
|
|
291
|
-
"recommended_annotators": [
|
|
292
|
-
"clinvar", "spliceai", "dbscsnv", "gnomad"
|
|
293
|
-
]
|
|
294
|
-
}
|
|
295
|
-
```
|
|
296
|
-
|
|
297
|
-
## Version History
|
|
298
|
-
|
|
299
|
-
- **v1.2.7** (Oct 7, 2025): Added OpenCRAVAT annotator intelligence
|
|
300
|
-
- **v1.2.6** (Oct 5, 2025): Added BioOS job management
|
|
301
|
-
- **v1.2.4** (Sep 2025): Initial BioIP tokenization support
|
|
302
|
-
|
|
303
|
-
## Support
|
|
304
|
-
|
|
305
|
-
- **npm Package**: https://www.npmjs.com/package/@genobank/biofs
|
|
306
|
-
- **Installation Guide**: See `INSTALL_V1.2.7_ON_MAC.md`
|
|
307
|
-
- **API Documentation**: See `ANNOTATOR_RECOMMENDATIONS_API.md`
|
|
308
|
-
- **GitHub**: https://github.com/Genobank/genobank-cli
|
|
309
|
-
- **Support**: support@genobank.io
|
|
310
|
-
|
|
311
|
-
---
|
|
312
|
-
|
|
313
|
-
**Package**: @genobank/biofs@1.2.7
|
|
314
|
-
**Published**: October 7, 2025
|
|
315
|
-
**Status**: ✅ Live on npm registry
|
|
316
|
-
**Total Annotators**: 146
|
|
317
|
-
**API Endpoints**: 7 (5 from v1.2.6 + 2 new in v1.2.7)
|
package/BIOFS_V1.2.9_FIXES.md
DELETED
|
@@ -1,306 +0,0 @@
|
|
|
1
|
-
# BioFS v1.2.9 - Bug Fixes
|
|
2
|
-
|
|
3
|
-
## ✅ Successfully Published to npm
|
|
4
|
-
|
|
5
|
-
**Package**: `@genobank/biofs@1.2.9`
|
|
6
|
-
**Published**: October 7, 2025
|
|
7
|
-
**npm URL**: https://www.npmjs.com/package/@genobank/biofs
|
|
8
|
-
|
|
9
|
-
## Issues Fixed
|
|
10
|
-
|
|
11
|
-
### 1. ✅ ESM/CommonJS Warning Fixed
|
|
12
|
-
|
|
13
|
-
**Problem**:
|
|
14
|
-
```
|
|
15
|
-
(node:4097) ExperimentalWarning: CommonJS module is loading ES Module using require().
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
**Cause**:
|
|
19
|
-
- chalk v5+, boxen v7+, ora v8+, open v10+ are ESM-only
|
|
20
|
-
- Our CLI uses CommonJS (require/module.exports)
|
|
21
|
-
- Node.js threw experimental warnings when CommonJS loaded ESM modules
|
|
22
|
-
|
|
23
|
-
**Fix**:
|
|
24
|
-
Downgraded to CommonJS-compatible versions:
|
|
25
|
-
- `chalk`: ^5.3.0 → ^4.1.2 ✅
|
|
26
|
-
- `boxen`: ^7.1.0 → ^5.1.2 ✅
|
|
27
|
-
- `ora`: ^8.0.0 → ^5.4.1 ✅
|
|
28
|
-
- `open`: ^10.0.0 → ^8.4.2 ✅
|
|
29
|
-
|
|
30
|
-
**Result**: No more warnings! Clean output.
|
|
31
|
-
|
|
32
|
-
### 2. ✅ Added Debug/Verbose Mode
|
|
33
|
-
|
|
34
|
-
**Problem**:
|
|
35
|
-
```bash
|
|
36
|
-
biofs files
|
|
37
|
-
# Output: "No files found matching your criteria"
|
|
38
|
-
# But why? What's happening behind the scenes?
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
**Fix**:
|
|
42
|
-
Added `--verbose` flag to show what's actually happening:
|
|
43
|
-
|
|
44
|
-
```bash
|
|
45
|
-
biofs files --verbose
|
|
46
|
-
# Now shows:
|
|
47
|
-
# 🔍 Fetching S3 files...
|
|
48
|
-
# ✅ Found 0 S3 files
|
|
49
|
-
# 🔍 Fetching Story Protocol IP assets...
|
|
50
|
-
# ✅ Found 0 IP assets
|
|
51
|
-
# 🔍 Fetching BioIP files...
|
|
52
|
-
# ✅ Found 0 BioIP files
|
|
53
|
-
# 🔍 Fetching VCF files...
|
|
54
|
-
# ✅ Found 0 VCF files
|
|
55
|
-
# 📊 Total files discovered: 0
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
This helps diagnose:
|
|
59
|
-
- Are API calls failing?
|
|
60
|
-
- Is authentication working?
|
|
61
|
-
- Which sources have files?
|
|
62
|
-
- Why no files are showing up
|
|
63
|
-
|
|
64
|
-
## Installation
|
|
65
|
-
|
|
66
|
-
### Update to v1.2.9
|
|
67
|
-
|
|
68
|
-
```bash
|
|
69
|
-
# Uninstall old version
|
|
70
|
-
npm uninstall -g @genobank/biofs
|
|
71
|
-
|
|
72
|
-
# Install new version (no warnings!)
|
|
73
|
-
npm install -g @genobank/biofs@1.2.9
|
|
74
|
-
|
|
75
|
-
# Verify
|
|
76
|
-
biofs --version # Should show: 1.2.9
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
## Testing the Fixes
|
|
80
|
-
|
|
81
|
-
### 1. No More Warnings
|
|
82
|
-
|
|
83
|
-
```bash
|
|
84
|
-
biofs whoami
|
|
85
|
-
# Clean output - no experimental warnings!
|
|
86
|
-
# Current Authentication:
|
|
87
|
-
# Wallet: 0xb3c3a584491b8ca4df45116a1e250098a0d6192d
|
|
88
|
-
# Authenticated: 10/5/2025, 2:22:32 AM
|
|
89
|
-
# Expires: 11/4/2025, 2:22:32 AM
|
|
90
|
-
```
|
|
91
|
-
|
|
92
|
-
### 2. Debug File Discovery
|
|
93
|
-
|
|
94
|
-
```bash
|
|
95
|
-
biofs files --verbose
|
|
96
|
-
# Shows exactly what's happening:
|
|
97
|
-
# 🔍 Fetching S3 files...
|
|
98
|
-
# ✅ Found X S3 files
|
|
99
|
-
# 🔍 Fetching Story Protocol IP assets...
|
|
100
|
-
# ✅ Found X IP assets
|
|
101
|
-
# 🔍 Fetching BioIP files...
|
|
102
|
-
# ✅ Found X BioIP files
|
|
103
|
-
# 🔍 Fetching VCF files...
|
|
104
|
-
# ✅ Found X VCF files
|
|
105
|
-
# 📊 Total files discovered: X
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
### 3. All Commands Work Cleanly
|
|
109
|
-
|
|
110
|
-
```bash
|
|
111
|
-
# No warnings on any command
|
|
112
|
-
biofs --help
|
|
113
|
-
biofs whoami
|
|
114
|
-
biofs files
|
|
115
|
-
biofs job pipelines
|
|
116
|
-
biofs access list
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
## Files Modified
|
|
120
|
-
|
|
121
|
-
### 1. package.json
|
|
122
|
-
```json
|
|
123
|
-
{
|
|
124
|
-
"dependencies": {
|
|
125
|
-
"chalk": "^4.1.2", // Was: ^5.3.0
|
|
126
|
-
"boxen": "^5.1.2", // Was: ^7.1.0
|
|
127
|
-
"ora": "^5.4.1", // Was: ^8.0.0
|
|
128
|
-
"open": "^8.4.2" // Was: ^10.0.0
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
### 2. src/commands/files.ts
|
|
134
|
-
- Added `verbose?: boolean` to `FilesOptions`
|
|
135
|
-
- Pass verbose flag to resolver
|
|
136
|
-
|
|
137
|
-
### 3. src/lib/biofiles/resolver.ts
|
|
138
|
-
- Added `verbose` parameter to `discoverAllBioFiles()`
|
|
139
|
-
- Added debug logging for each file source:
|
|
140
|
-
- S3 files
|
|
141
|
-
- Story Protocol IP assets
|
|
142
|
-
- BioIP files
|
|
143
|
-
- VCF files
|
|
144
|
-
- Show total count at end
|
|
145
|
-
|
|
146
|
-
### 4. src/index.ts
|
|
147
|
-
- Added `--verbose` flag to `files` command
|
|
148
|
-
- Updated version to 1.2.9
|
|
149
|
-
- Updated welcome banner to v1.2.9
|
|
150
|
-
|
|
151
|
-
## Why "No Files Found" on Mac
|
|
152
|
-
|
|
153
|
-
The verbose output will help diagnose. Possible reasons:
|
|
154
|
-
|
|
155
|
-
1. **API Authentication Issue**
|
|
156
|
-
- Signature might not be passing correctly
|
|
157
|
-
- Check: `biofs whoami --verbose`
|
|
158
|
-
|
|
159
|
-
2. **No Files Uploaded Yet**
|
|
160
|
-
- If this is a new account, files need to be uploaded first
|
|
161
|
-
- Try: `biofs upload <file>` to add your first file
|
|
162
|
-
|
|
163
|
-
3. **API Endpoint Errors**
|
|
164
|
-
- The verbose flag will show if API calls are failing
|
|
165
|
-
- Shows which sources are unavailable
|
|
166
|
-
|
|
167
|
-
4. **Wrong Environment**
|
|
168
|
-
- Check if API is pointing to production
|
|
169
|
-
- Verbose mode shows API responses
|
|
170
|
-
|
|
171
|
-
## Usage Examples
|
|
172
|
-
|
|
173
|
-
### Basic File Listing (Clean Output)
|
|
174
|
-
```bash
|
|
175
|
-
biofs files
|
|
176
|
-
# Shows files if found, or "No files found" if empty
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
### Debug Mode (Detailed Info)
|
|
180
|
-
```bash
|
|
181
|
-
biofs files --verbose
|
|
182
|
-
# Shows:
|
|
183
|
-
# - Which sources are being checked
|
|
184
|
-
# - How many files from each source
|
|
185
|
-
# - Total discovered
|
|
186
|
-
# - Any errors that occur
|
|
187
|
-
```
|
|
188
|
-
|
|
189
|
-
### With Filters
|
|
190
|
-
```bash
|
|
191
|
-
# Show only VCF files with debug info
|
|
192
|
-
biofs files --filter vcf --verbose
|
|
193
|
-
|
|
194
|
-
# Show only S3 files with debug info
|
|
195
|
-
biofs files --source s3 --verbose
|
|
196
|
-
```
|
|
197
|
-
|
|
198
|
-
### JSON Output with Debug
|
|
199
|
-
```bash
|
|
200
|
-
biofs files --json --verbose
|
|
201
|
-
# Verbose logs go to stderr
|
|
202
|
-
# JSON output goes to stdout (for piping)
|
|
203
|
-
```
|
|
204
|
-
|
|
205
|
-
## Help System
|
|
206
|
-
|
|
207
|
-
All help commands work cleanly (no warnings):
|
|
208
|
-
|
|
209
|
-
```bash
|
|
210
|
-
biofs --help # Main help
|
|
211
|
-
biofs files --help # Files command help
|
|
212
|
-
biofs job --help # Job management help
|
|
213
|
-
biofs access --help # Access control help
|
|
214
|
-
biofs tokenize --help # Tokenization help
|
|
215
|
-
```
|
|
216
|
-
|
|
217
|
-
New `--verbose` flag is documented:
|
|
218
|
-
```
|
|
219
|
-
Options:
|
|
220
|
-
--filter <type> Filter by file type (vcf, fastq, bam, pdf, etc.)
|
|
221
|
-
--source <source> Filter by source (s3, ipfs, story)
|
|
222
|
-
--json Output as JSON
|
|
223
|
-
--refresh Clear cache and fetch fresh data
|
|
224
|
-
--verbose Show debug information
|
|
225
|
-
-h, --help display help for command
|
|
226
|
-
```
|
|
227
|
-
|
|
228
|
-
## Next Steps for User (Dra. Claudia)
|
|
229
|
-
|
|
230
|
-
1. **Update to v1.2.9**:
|
|
231
|
-
```bash
|
|
232
|
-
npm install -g @genobank/biofs@1.2.9
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
2. **Test Authentication**:
|
|
236
|
-
```bash
|
|
237
|
-
biofs whoami
|
|
238
|
-
# Should show clean output (no warnings)
|
|
239
|
-
```
|
|
240
|
-
|
|
241
|
-
3. **Debug File Discovery**:
|
|
242
|
-
```bash
|
|
243
|
-
biofs files --verbose
|
|
244
|
-
# This will show exactly what's happening
|
|
245
|
-
```
|
|
246
|
-
|
|
247
|
-
4. **Share Results**:
|
|
248
|
-
- Copy the verbose output
|
|
249
|
-
- This will help diagnose why no files are showing
|
|
250
|
-
|
|
251
|
-
## Technical Details
|
|
252
|
-
|
|
253
|
-
### CommonJS vs ESM
|
|
254
|
-
|
|
255
|
-
**Why the change?**
|
|
256
|
-
- Our CLI is built with TypeScript → JavaScript (CommonJS)
|
|
257
|
-
- Newer npm packages (chalk 5+, boxen 7+) are ESM-only
|
|
258
|
-
- Node.js warns when CommonJS uses `require()` to load ESM
|
|
259
|
-
- We downgraded to last CommonJS-compatible versions
|
|
260
|
-
|
|
261
|
-
**Benefits**:
|
|
262
|
-
- ✅ No experimental warnings
|
|
263
|
-
- ✅ Stable, well-tested versions
|
|
264
|
-
- ✅ Full CommonJS compatibility
|
|
265
|
-
- ✅ Clean console output
|
|
266
|
-
|
|
267
|
-
### Verbose Logging
|
|
268
|
-
|
|
269
|
-
**Implementation**:
|
|
270
|
-
```typescript
|
|
271
|
-
async discoverAllBioFiles(verbose: boolean = false): Promise<BioFile[]> {
|
|
272
|
-
if (verbose) console.log('🔍 Fetching S3 files...');
|
|
273
|
-
const s3Files = await this.api.getMyUploadedFilesUrls();
|
|
274
|
-
if (verbose) console.log(`✅ Found ${s3Files.length} S3 files`);
|
|
275
|
-
|
|
276
|
-
// Repeat for Story, BioIP, VCF...
|
|
277
|
-
|
|
278
|
-
if (verbose) console.log(`\n📊 Total: ${bioFiles.length}`);
|
|
279
|
-
return bioFiles;
|
|
280
|
-
}
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
**Output**:
|
|
284
|
-
- Logs to `stderr` (doesn't break JSON output)
|
|
285
|
-
- Shows progress for each source
|
|
286
|
-
- Reports errors with details
|
|
287
|
-
- Counts total files discovered
|
|
288
|
-
|
|
289
|
-
## Version History
|
|
290
|
-
|
|
291
|
-
- **v1.2.9** (Oct 7, 2025): Fixed ESM warnings, added verbose mode
|
|
292
|
-
- **v1.2.8** (Oct 7, 2025): Version banner fix
|
|
293
|
-
- **v1.2.7** (Oct 7, 2025): Added annotator intelligence
|
|
294
|
-
- **v1.2.6** (Oct 5, 2025): Added BioOS job management
|
|
295
|
-
|
|
296
|
-
## Support
|
|
297
|
-
|
|
298
|
-
- **npm Package**: https://www.npmjs.com/package/@genobank/biofs
|
|
299
|
-
- **GitHub**: https://github.com/Genobank/genobank-cli
|
|
300
|
-
- **Support**: support@genobank.io
|
|
301
|
-
|
|
302
|
-
---
|
|
303
|
-
|
|
304
|
-
**Version**: 1.2.9
|
|
305
|
-
**Status**: ✅ Published and ready for testing
|
|
306
|
-
**Key Fixes**: ESM warnings removed, verbose debug mode added
|