@quiltdata/benchling-webhook 0.21.1-20261007T002351Z → 0.21.2-20261007T044206Z
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 +22 -1
- package/dist/package.json +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,6 +22,27 @@ When scientists create notebook entries in Benchling, this webhook automatically
|
|
|
22
22
|
- **Copies attachments** from that notebook into Amazon S3 as part of the package.
|
|
23
23
|
- **Enables orgnizational data discovery** by making contents available in ElasticSearch, and metadata available in Amazon Athena.
|
|
24
24
|
|
|
25
|
+
#### Package Naming
|
|
26
|
+
|
|
27
|
+
Each notebook package is named `{pkg_prefix}/{display_id}`, e.g. `benchling/EXP00000001`.
|
|
28
|
+
Set the prefix with the setup wizard's **Package S3 prefix** prompt (`packages.prefix` in the profile config).
|
|
29
|
+
|
|
30
|
+
The prefix can contain `{dotted.path}` placeholders, filled from the Benchling entry as saved in `entry_data.json`.
|
|
31
|
+
To put each scientist's notebook packages in the same namespace as their raw-data packages, use the entry creator's handle:
|
|
32
|
+
|
|
33
|
+
| `pkg_prefix` | Package name |
|
|
34
|
+
|---|---|
|
|
35
|
+
| `benchling` (default) | `benchling/EXP00000001` |
|
|
36
|
+
| `{creator.handle}` | `jdoe/EXP00000001` |
|
|
37
|
+
| `{creator.handle}`, creator `ernest.prabhakar` | `ernest-prabhakar/EXP00000001` |
|
|
38
|
+
|
|
39
|
+
- The S3 export folder follows the same name (`jdoe/EXP00000001/`).
|
|
40
|
+
- The name is computed each time, so a package moves only if its creator changes their Benchling handle.
|
|
41
|
+
- Quilt package names only allow letters, digits, `_` and `-`, so any other character in a filled-in value (such as the `.` in `ernest.prabhakar`) becomes `-`. Literal text in the prefix is used as is.
|
|
42
|
+
- If a placeholder has no value in the entry, that entry is not packaged. Its Canvas says "This entry can't be packaged" and names the missing value, and the webhook logs an error naming the placeholder and the entry. There is no fallback prefix.
|
|
43
|
+
- Existing packages are not moved when the prefix changes. An entry's Canvas looks for its package under the new name, which is created the next time the entry is packaged.
|
|
44
|
+
- If the bucket's Quilt workflow sets a `handle_pattern`, it must accept the new namespaces.
|
|
45
|
+
|
|
25
46
|
#### Package Metadata
|
|
26
47
|
|
|
27
48
|
The package metadata is the package's `entry.json`. Besides the entry's IDs, name, creator, authors, and timestamps, it includes the entry's schema `fields` and `customFields`. Benchling keys these by display name, so the webhook re-keys them in snake_case: "Experiment Type" becomes `experiment_type` and "ELN-ID #" becomes `eln_id`. Each field keeps its display name as `name`; its other values are exactly what Benchling returns. Both keys are always present, as `{}` when the entry has none. The package's `entry_data.json` keeps the raw entry.
|
|
@@ -222,7 +243,7 @@ The wizard will guide you through:
|
|
|
222
243
|
1. **Catalog discovery** - Detect your Quilt catalog configuration
|
|
223
244
|
2. **Stack validation** - Extract settings from your CloudFormation stack
|
|
224
245
|
3. **Credential collection** - Enter Benchling app credentials
|
|
225
|
-
4. **Package settings** - Configure bucket, metadata key, and optional Quilt workflow
|
|
246
|
+
4. **Package settings** - Configure bucket, package prefix (see [Package Naming](#package-naming)), metadata key, and optional Quilt workflow
|
|
226
247
|
5. **Deployment mode selection**:
|
|
227
248
|
- **Integrated**: Uses your Quilt stack's built-in webhook, if any
|
|
228
249
|
- **Standalone**: Deploys a separate webhook stack for testing
|
package/dist/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quiltdata/benchling-webhook",
|
|
3
|
-
"version": "0.21.
|
|
3
|
+
"version": "0.21.2-20261007T044206Z",
|
|
4
4
|
"description": "AWS CDK deployment for Benchling webhook processing using Fargate - Deploy directly with npx",
|
|
5
5
|
"main": "dist/lib/index.js",
|
|
6
6
|
"types": "dist/lib/index.d.ts",
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@quiltdata/benchling-webhook",
|
|
3
|
-
"version": "0.21.
|
|
3
|
+
"version": "0.21.2-20261007T044206Z",
|
|
4
4
|
"description": "AWS CDK deployment for Benchling webhook processing using Fargate - Deploy directly with npx",
|
|
5
5
|
"main": "dist/lib/index.js",
|
|
6
6
|
"types": "dist/lib/index.d.ts",
|