@ham2k/extension-sdk 0.2.0 → 0.4.0

package/docs/templates.md

@@ -19,7 +19,7 @@ const text = renderTemplate("{{ op.station }} — {{ op.qsoCount }} QSOs", templ
 
 A template is DATA. Liquid parses and interprets; Handlebars compiles
 through `new Function`. These templates are written by operators, copied
-between operators, and will eventually be editable in settings, so the one
+between operators, and are editable in settings, so the one
 that cannot become code is the one to have. Liquid also has comparisons
 (`{% if op.qsoCount > 100 %}`) and loops built in, where Handlebars needs a
 registered helper for `>` and Mustache cannot compare at all.
@@ -38,19 +38,19 @@ the namespaces are deliberately polo's. The syntax around them does not:
 
 ## What a template can name
 
-| namespace | panel `render` | export filename | ADIF fields |
-|---|---|---|---|
-| `app` | ✓ | — | ✓ |
-| `now` | ✓ | ✓ | ✓ |
-| `op` | ✓ | dates only | ✓ |
-| `qso` | when the placement's triggers ask for it | — | ✓ |
-| `config` | ✓ | — | — |
-| `log` | — | ✓ | ✓ |
+| namespace | panel `render` | export filename | ADIF fields | CW message |
+|---|---|---|---|---|
+| `app` | ✓ | — | ✓ | ✓ |
+| `now` | ✓ | ✓ | ✓ | ✓ |
+| `op` | ✓ | ✓ | ✓ | ✓ |
+| `qso` | when the placement's triggers ask for it | — | ✓ | the draft contact, as far as it is typed |
+| `config` | ✓ | — | — | — |
+| `log` | — | ✓ | ✓ | — |
 
 A namespace a surface has nothing for is **absent**, not blank — which is
-what makes `{% if qso %}` an honest question. Filenames get only the date
-half of `op` because a filename is built from parts rather than from an
-operation (`exportNames.ts`).
+what makes `{% if qso %}` an honest question. Registered exports get the operation plus the selected file’s `log` values.
+The low-level `exportFilename(parts)` helper still supplies only dates and
+filename parts.
 
 ### `app`
 `app.name` — the platform-appropriate name ("Ham2K Logger" on desktop,
@@ -61,7 +61,8 @@ An ISO-8601 UTC string, for the `date` filter: `{{ now | date: '%H:%M' }}`.
 
 ### `op` — the operation
 `station` (the field as typed, which may hold several comma-separated
-callsigns), `stations` (that list, uppercased and deduped), `operator`,
+callsigns; `call` is the same value, the name `qso.call` has), `stations`
+(that list, uppercased and deduped), `operator`,
 `title` (the generated, ref-derived one), `userTitle` (the operator's own
 words), `grid`, `refs`, `uuid`, `qsoCount`, `date`, `dateCompact`, `time`,
 `at`, `startDate`, `startTime`, `startAt`, `endDate`, `endTime`, `endAt`.
@@ -190,15 +191,16 @@ will jump rather than count. Show HH:MM.
 | what | where | editable |
 |---|---|---|
 | Panel documents | `custom-text`'s content and tab name | by the operator, in the panel's config form |
-| Export filenames | `sdk/src/exportNames.ts` `NAME_TEMPLATES` | not yet |
-| ADIF NOTES / COMMENT / QSLMSG | `core/adif`'s `TEXT_FIELD_TEMPLATES` | not yet |
-
-COMMENT and QSLMSG are empty, so nothing is written for them. app-polo
-defaults COMMENT to the QSO's notes and QSLMSG to the operation's
-references; both wait here until there is a settings screen to edit them in,
-since a default nobody can see is one nobody can turn off, and these fields
-travel to a program's servers.
-
-Whatever fills them must respect the private/public split: `notes` is the
-operator's own words and belongs only in a field the export withholds when
-private data is off. NOTES is such a field. COMMENT and QSLMSG are not.
+| Export filenames and titles | Registered export types and `sdk/src/exportSettings.ts` | Settings → Exports, globally and per type |
+| ADIF NOTES / COMMENT / QSLMSG | Export type settings, consumed by `core/adif` | Settings → Exports; empty templates suppress a field |
+| CW messages | Radio settings `cwMessage1..8`, keyed on F1-F8 through the radio (docs/design/cat.md § CW keying) — rendered by the `template` hook (hooks.md) | by the operator, in the Station dialog's Messages… dialog |
+
+NOTES and COMMENT default to QSO notes and are withheld when private data
+is off. QSLMSG defaults to empty for program exports, and to the operation’s
+references for the whole-log ADIF. Custom QSL messages may use contact values.
+Templates receive no withheld private or lookup values. File titles obey the
+private-data choice; filename templates are labels for the operator’s files.
+
+The `textTemplate` form field provides sample previews and an insertable
+reference; see [forms.md](forms.md). Invalid Liquid reports an error rather
+than silently replacing the operator’s template with a default.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ham2k/extension-sdk",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Write extensions for the Ham2K Logger: typed hook contracts and the host API",
   "keywords": [
     "ham2k",
@@ -10,7 +10,7 @@
     "sdk",
     "logging"
   ],
-  "license": "MPL-2.0",
+  "license": "MIT",
   "author": "Sebastian Delmont <sd@ham2k.com>",
   "homepage": "https://ham2k.com",
   "repository": {
@@ -25,8 +25,17 @@
     "subpath, so a tool asking this package its own version is told the package",
     "does not exist. Common enough that npm's own docs call it out."
   ],
+  "//ham2k-source": [
+    "A condition only this repo's own test run asks for (`--conditions=ham2k-source`),",
+    "so a test can import the SDK by name and get the TypeScript sources rather",
+    "than a build of them — the same thing esbuild's alias does when it bundles an",
+    "extension. Deliberately not the conventional `development`: the published",
+    "tarball ships `dist` and not `src`, and a consumer who happened to run with",
+    "that common condition would be pointed at files their install does not have."
+  ],
   "exports": {
     ".": {
+      "ham2k-source": "./src/index.ts",
       "types": "./dist/index.d.ts",
       "default": "./dist/index.js"
     },

package/samples/k2hrc-cqww/manifest.json

@@ -5,7 +5,6 @@
   "version": "1.0.0",
   "description": "CQ WW DX points and multipliers, as a worked example",
   "category": "contest",
-  "enabledByDefault": false,
   "icon": "earth",
   "accentColor": "#B03A2E",
   "api": 1,

package/samples/k2hrc-cqww/src/index.ts

@@ -1,5 +1,5 @@
 // Copyright ©️ 2026 Sebastian Delmont <sd@ham2k.com>
-// SPDX-License-Identifier: MPL-2.0
+// SPDX-License-Identifier: MIT
 //
 // SAMPLE — a contest: an exchange to type, and a score to keep.
 //

package/samples/k2hrc-hamqth/manifest.json

@@ -5,7 +5,6 @@
   "version": "1.0.0",
   "description": "Looks up callsign details with a free HamQTH.com account",
   "category": "lookup",
-  "enabledByDefault": true,
   "icon": "card-account-details-outline",
   "accentColor": "#1E6F5C",
   "api": 1,

package/samples/k2hrc-hamqth/src/index.ts

@@ -1,5 +1,5 @@
 // Copyright ©️ 2026 Sebastian Delmont <sd@ham2k.com>
-// SPDX-License-Identifier: MPL-2.0
+// SPDX-License-Identifier: MIT
 //
 // SAMPLE — a callsign lookup source, with the credentials one needs.
 //

package/samples/k2hrc-llota/manifest.json

@@ -5,13 +5,13 @@
   "version": "1.0.0",
   "description": "Lake references and activation scoring, as a worked example",
   "category": "activity",
-  "enabledByDefault": false,
   "icon": "waves",
   "accentColor": "#2F7FA6",
   "api": 1,
   "keywords": ["lakes", "activation", "hunting", "sample"],
   "hooks": ["activity", "adifFields", "adifImport", "dataFile", "ref:k2hrcLlota", "ref:k2hrcLlotaActivation", "scoring"],
   "domains": ["llota.app"],
+  "relevance": { "continents": ["SA"] },
   "sharedDependencies": {
     "@ham2k/lib-callsigns": "^1.0.0",
     "@ham2k/lib-country-files": "^1.0.0",

package/samples/k2hrc-llota/src/index.ts

@@ -1,5 +1,5 @@
 // Copyright ©️ 2026 Sebastian Delmont <sd@ham2k.com>
-// SPDX-License-Identifier: MPL-2.0
+// SPDX-License-Identifier: MIT
 //
 // SAMPLE — an award program: references, an offline list, and activation
 // scoring.

package/samples/k2hrc-radio/manifest.json

@@ -5,7 +5,6 @@
   "version": "1.0.0",
   "description": "A big band, mode and frequency readout across the room",
   "category": "dashboard",
-  "enabledByDefault": true,
   "icon": "radio-tower",
   "accentColor": "#4C6EF5",
   "api": 1,

package/samples/k2hrc-radio/src/index.ts

@@ -1,5 +1,5 @@
 // Copyright ©️ 2026 Sebastian Delmont <sd@ham2k.com>
-// SPDX-License-Identifier: MPL-2.0
+// SPDX-License-Identifier: MIT
 //
 // SAMPLE — an HTML panel: what the radio is doing, big enough to read from
 // across the room.