pompelmi 0.3.2 → 0.3.3
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 +25 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -283,7 +283,14 @@ The adapters share the same behavior and defaults:
|
|
|
283
283
|
> **Note:** Diagrams are embedded as images via mermaid.ink so they render on GitHub, npm, and other Markdown viewers. The Mermaid source is included below each image.
|
|
284
284
|
> **Tip:** To avoid parser issues across renderers, labels use quotes inside node shapes (e.g., `A["text"]`, `C{"text"}`) when they include parentheses, slashes, or other symbols.
|
|
285
285
|
|
|
286
|
+
|
|
286
287
|
### Upload scanning flow
|
|
288
|
+
<p align="center">
|
|
289
|
+
<img alt="Upload scanning flow diagram" src="https://mermaid.ink/img/eyJjb2RlIjogImZsb3djaGFydCBURFxuICBBW1wiQ2xpZW50IHVwbG9hZHMgZmlsZShzKVwiXSAtLT4gQltcIldlYiBBcHAgUm91dGVcIl1cbiAgQiAtLT4gQ3tcIlByZS1maWx0ZXJzPGJyLz4oZXh0LCBzaXplLCBNSU1FKVwifVxuICBDIC0tIGZhaWwgLS0+IFhbXCJIVFRQIDR4eFwiXVxuICBDIC0tIHBhc3MgLS0+IER7XCJJcyBaSVA/XCJ9XG4gIEQgLS0geWVzIC0tPiBFW1wiSXRlcmF0ZSBlbnRyaWVzPGJyLz4obGltaXRzICYgc2NhbilcIl1cbiAgRSAtLT4gRntcIlZlcmRpY3Q/XCJ9XG4gIEQgLS0gbm8gLS0+IEZ7XCJTY2FuIGJ5dGVzXCJ9XG4gIEYgLS0gbWFsaWNpb3VzL3N1c3BpY2lvdXMgLS0+IFlbXCJIVFRQIDQyMiBibG9ja2VkXCJdXG4gIEYgLS0gY2xlYW4gLS0+IFpbXCJIVFRQIDIwMCBvayArIHJlc3VsdHNcIl0iLCAibWVybWFpZCI6IHsidGhlbWUiOiAiZGVmYXVsdCJ9fQ==?bgColor=white" />
|
|
290
|
+
</p>
|
|
291
|
+
|
|
292
|
+
<details>
|
|
293
|
+
<summary>Mermaid source</summary>
|
|
287
294
|
|
|
288
295
|
```mermaid
|
|
289
296
|
flowchart TD
|
|
@@ -297,8 +304,15 @@ flowchart TD
|
|
|
297
304
|
F -- malicious/suspicious --> Y["HTTP 422 blocked"]
|
|
298
305
|
F -- clean --> Z["HTTP 200 ok + results"]
|
|
299
306
|
```
|
|
307
|
+
</details>
|
|
300
308
|
|
|
301
309
|
### Sequence (App ↔ pompelmi ↔ YARA)
|
|
310
|
+
<p align="center">
|
|
311
|
+
<img alt="App ↔ pompelmi ↔ YARA sequence diagram" src="https://mermaid.ink/img/eyJjb2RlIjogInNlcXVlbmNlRGlhZ3JhbVxuICBwYXJ0aWNpcGFudCBVIGFzIFVzZXJcbiAgcGFydGljaXBhbnQgQSBhcyBBcHAgUm91dGUgKC91cGxvYWQpXG4gIHBhcnRpY2lwYW50IFAgYXMgcG9tcGVsbWkgKGFkYXB0ZXIpXG4gIHBhcnRpY2lwYW50IFkgYXMgWUFSQSBlbmdpbmVcblxuICBVLT4+QTogUE9TVCBtdWx0aXBhcnQvZm9ybS1kYXRhXG4gIEEtPj5QOiBndWFyZChmaWxlcywgcG9saWNpZXMpXG4gIFAtPj5QOiBNSU1FIHNuaWZmICsgc2l6ZSArIGV4dCBjaGVja3NcbiAgYWx0IFpJUCBhcmNoaXZlXG4gICAgUC0+PlA6IHVucGFjayBlbnRyaWVzIHdpdGggbGltaXRzXG4gIGVuZFxuICBQLT4+WTogc2NhbihieXRlcylcbiAgWS0tPj5QOiBtYXRjaGVzW11cbiAgUC0tPj5BOiB2ZXJkaWN0IChjbGVhbi9zdXNwaWNpb3VzL21hbGljaW91cylcbiAgQS0tPj5VOiAyMDAgb3IgNHh4LzQyMiB3aXRoIHJlYXNvbiIsICJtZXJtYWlkIjogeyJ0aGVtZSI6ICJkZWZhdWx0In19?bgColor=white" />
|
|
312
|
+
</p>
|
|
313
|
+
|
|
314
|
+
<details>
|
|
315
|
+
<summary>Mermaid source</summary>
|
|
302
316
|
|
|
303
317
|
```mermaid
|
|
304
318
|
sequenceDiagram
|
|
@@ -318,8 +332,15 @@ sequenceDiagram
|
|
|
318
332
|
P-->>A: verdict (clean/suspicious/malicious)
|
|
319
333
|
A-->>U: 200 or 4xx/422 with reason
|
|
320
334
|
```
|
|
335
|
+
</details>
|
|
321
336
|
|
|
322
337
|
### Components (monorepo)
|
|
338
|
+
<p align="center">
|
|
339
|
+
<img alt="Monorepo components diagram" src="https://mermaid.ink/img/eyJjb2RlIjogImZsb3djaGFydCBMUlxuICBzdWJncmFwaCBSZXBvXG4gICAgY29yZVtcInBvbXBlbG1pIChjb3JlKVwiXVxuICAgIGV4cHJlc3NbXCJAcG9tcGVsbWkvZXhwcmVzcy1taWRkbGV3YXJlXCJdXG4gICAga29hW1wiQHBvbXBlbG1pL2tvYS1taWRkbGV3YXJlXCJdXG4gICAgbmV4dFtcIkBwb21wZWxtaS9uZXh0LXVwbG9hZFwiXVxuICAgIGZhc3RpZnkoKFwiZmFzdGlmeS1wbHVnaW4gwrcgcGxhbm5lZFwiKSlcbiAgICBuZXN0KChcIm5lc3RqcyDCtyBwbGFubmVkXCIpKVxuICAgIHJlbWl4KChcInJlbWl4IMK3IHBsYW5uZWRcIikpXG4gICAgaGFwaSgoXCJoYXBpLXBsdWdpbiDCtyBwbGFubmVkXCIpKVxuICAgIHN2ZWx0ZSgoXCJzdmVsdGVraXQgwrcgcGxhbm5lZFwiKSlcbiAgZW5kXG4gIGNvcmUgLS0+IGV4cHJlc3NcbiAgY29yZSAtLT4ga29hXG4gIGNvcmUgLS0+IG5leHRcbiAgY29yZSAtLi0+IGZhc3RpZnlcbiAgY29yZSAtLi0+IG5lc3RcbiAgY29yZSAtLi0+IHJlbWl4XG4gIGNvcmUgLS4tPiBoYXBpXG4gIGNvcmUgLS4tPiBzdmVsdGUiLCAibWVybWFpZCI6IHsidGhlbWUiOiAiZGVmYXVsdCJ9fQ==?bgColor=white" />
|
|
340
|
+
</p>
|
|
341
|
+
|
|
342
|
+
<details>
|
|
343
|
+
<summary>Mermaid source</summary>
|
|
323
344
|
|
|
324
345
|
```mermaid
|
|
325
346
|
flowchart LR
|
|
@@ -343,6 +364,7 @@ flowchart LR
|
|
|
343
364
|
core -.-> hapi
|
|
344
365
|
core -.-> svelte
|
|
345
366
|
```
|
|
367
|
+
</details>
|
|
346
368
|
|
|
347
369
|
---
|
|
348
370
|
|
|
@@ -433,12 +455,12 @@ PRs and issues are welcome!
|
|
|
433
455
|
|
|
434
456
|
## Versioning
|
|
435
457
|
|
|
436
|
-
Channel: **`0.
|
|
437
|
-
Expect minor API changes before a stable `0.
|
|
458
|
+
Channel: **`0.3.3`**
|
|
459
|
+
Expect minor API changes before a stable `0.3.3`.
|
|
438
460
|
|
|
439
461
|
Suggested publish:
|
|
440
462
|
```bash
|
|
441
|
-
npm version 0.
|
|
463
|
+
npm version 0.3.3
|
|
442
464
|
npm publish --tag next
|
|
443
465
|
```
|
|
444
466
|
|