@estiva-app/interop 0.35.0 → 0.36.0
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 +38 -0
- package/README.md +40 -0
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/nesting.d.ts +9 -1
- package/dist/nesting.d.ts.map +1 -1
- package/dist/nesting.js +3 -2
- package/dist/nesting.js.map +1 -1
- package/dist/projection.d.ts +127 -4
- package/dist/projection.d.ts.map +1 -1
- package/dist/projection.js +245 -16
- package/dist/projection.js.map +1 -1
- package/package.json +3 -3
- package/src/index.ts +3 -0
- package/src/nesting.ts +14 -3
- package/src/projection.ts +368 -22
package/dist/projection.js
CHANGED
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
import { decodeNaddr, decodeNevent, encodeNaddr, encodeNevent, findNaddrs, pointerToAddress, referenceToPointer } from '@estiva-app/protocol';
|
|
16
16
|
import { imetaOf, parseProfile } from '@estiva-app/protocol';
|
|
17
17
|
import { MAX_FILTERS_PER_QUERY, RELAY_PAGE_CEILING } from '@estiva-app/protocol';
|
|
18
|
+
import { attachmentsInDocument, BLOCK_DOCUMENT_FORMAT, CONTENT_FORMAT_TAG, imetaTag, parseBlockDocument, } from '@estiva-app/protocol';
|
|
19
|
+
import { planPlaceFile, planUnlistFile } from './folders.js';
|
|
18
20
|
/** The default: one kind:0 query, straight to the relay. */
|
|
19
21
|
/**
|
|
20
22
|
* How long a *name* may be believed.
|
|
@@ -596,6 +598,10 @@ export async function commentDecorationsOf(targets, query) {
|
|
|
596
598
|
return { byId, reactionTargetsOmitted: ids.length - forReactions.length };
|
|
597
599
|
}
|
|
598
600
|
export const ACTION_EFFECTS = ['safe', 'writes', 'destructive'];
|
|
601
|
+
/** The declared format, when it is one this version writes. */
|
|
602
|
+
function proseFormatOf(declared) {
|
|
603
|
+
return declared === BLOCK_DOCUMENT_FORMAT ? BLOCK_DOCUMENT_FORMAT : undefined;
|
|
604
|
+
}
|
|
599
605
|
/**
|
|
600
606
|
* The aspects a generic app may declare — RFC 0.5 §10.2's three parts of a
|
|
601
607
|
* file, minus `properties`, which is what a *type* adds and so what a
|
|
@@ -620,7 +626,7 @@ function resolveActions(manifest, kind, folded) {
|
|
|
620
626
|
*/
|
|
621
627
|
const isChange = !!action.emits.field;
|
|
622
628
|
const isComment = action.emits.scope === 'address';
|
|
623
|
-
const isCreation = action
|
|
629
|
+
const isCreation = isCreationAction(action);
|
|
624
630
|
// Four, since 0.25.0. Decided by the kind before the other three, so a
|
|
625
631
|
// manifest that put `scope: 'address'` on its deletion — the target *is*
|
|
626
632
|
// an address — is not mistaken for a comment.
|
|
@@ -634,6 +640,7 @@ function resolveActions(manifest, kind, folded) {
|
|
|
634
640
|
...(action.description ? { description: action.description } : {}),
|
|
635
641
|
...(action.effect ? { effect: action.effect } : {}),
|
|
636
642
|
control: 'confirm',
|
|
643
|
+
...(action.emits.listed === true ? { listed: true } : {}),
|
|
637
644
|
});
|
|
638
645
|
continue;
|
|
639
646
|
}
|
|
@@ -660,6 +667,8 @@ function resolveActions(manifest, kind, folded) {
|
|
|
660
667
|
a one-line input and drawing prose.
|
|
661
668
|
*/
|
|
662
669
|
...(spec.target ? { target: spec.target } : {}),
|
|
670
|
+
// Prose only where the value is `content` — a tag is a scalar (§7.3).
|
|
671
|
+
...(spec.target === 'content' && proseFormatOf(spec.format) ? { format: proseFormatOf(spec.format) } : {}),
|
|
663
672
|
...(spec.enum && manifest.vocabularies?.[spec.enum]
|
|
664
673
|
? {
|
|
665
674
|
options: manifest.vocabularies[spec.enum].map((v) => ({
|
|
@@ -674,16 +683,22 @@ function resolveActions(manifest, kind, folded) {
|
|
|
674
683
|
// comes from `emits`, and a form that omitted it would publish an
|
|
675
684
|
// orphan the owning app cannot show anywhere.
|
|
676
685
|
...(action.emits.toAddressOf ? { createsUnder: action.emits.toAddressOf } : {}),
|
|
686
|
+
...(action.emits.listed === true ? { listed: true } : {}),
|
|
677
687
|
});
|
|
678
688
|
continue;
|
|
679
689
|
}
|
|
680
690
|
const vocab = action.input?.enum ? manifest.vocabularies?.[action.input.enum] : undefined;
|
|
691
|
+
const control = vocab ? 'select' : action.input?.type === 'pubkey' ? 'pubkey' : 'text';
|
|
692
|
+
// A change only: a comment's body is §13.2 marker text, and a format on
|
|
693
|
+
// one is nothing this version writes (`buildActionEvent` refuses it).
|
|
694
|
+
const format = control === 'text' && isChange ? proseFormatOf(action.input?.format) : undefined;
|
|
681
695
|
out.push({
|
|
682
696
|
id: action.id,
|
|
683
697
|
label: action.label,
|
|
684
698
|
...(action.description ? { description: action.description } : {}),
|
|
685
699
|
...(action.effect ? { effect: action.effect } : {}),
|
|
686
|
-
control
|
|
700
|
+
control,
|
|
701
|
+
...(format ? { format } : {}),
|
|
687
702
|
options: vocab?.map((v) => ({ value: v.value, label: v.label, colour: v.colour })),
|
|
688
703
|
current: action.emits.field ? folded[action.emits.field]?.value : undefined,
|
|
689
704
|
field: action.emits.field,
|
|
@@ -933,8 +948,6 @@ export const KIND_BARE_FILE = 30840;
|
|
|
933
948
|
* should fail loudly rather than find something.
|
|
934
949
|
*/
|
|
935
950
|
export const BARE_FILE_MANIFEST_ADDRESS = 'spec:6.7';
|
|
936
|
-
/** The field a bare file's `kind:1851` re-parent sets (SPEC §6.7). */
|
|
937
|
-
const BARE_FILE_PARENT_FIELD = 'parent';
|
|
938
951
|
const BARE_FILE_MANIFEST = {
|
|
939
952
|
name: 'File',
|
|
940
953
|
about: 'A file no app owns. Its conversation is what every file has; its type adds nothing.',
|
|
@@ -957,7 +970,11 @@ const BARE_FILE_MANIFEST = {
|
|
|
957
970
|
// of *other* kinds are found the other way round, by their own `a`
|
|
958
971
|
// (`parentRefOf` below), which is FOL-4's generic direction; this slot
|
|
959
972
|
// is the one the existing `list` machinery can draw today.
|
|
960
|
-
|
|
973
|
+
//
|
|
974
|
+
// `movedBy` is SPEC §6.7's `parent` field, declared rather than
|
|
975
|
+
// hard-coded since MAN-1, so a bare file moves by the rule every other
|
|
976
|
+
// kind does — the move action below sets the same field.
|
|
977
|
+
list: { children: { kind: KIND_BARE_FILE, via: 'a', limit: 200, movedBy: 'parent' } },
|
|
961
978
|
},
|
|
962
979
|
},
|
|
963
980
|
/*
|
|
@@ -1028,7 +1045,7 @@ const BARE_FILE_MANIFEST = {
|
|
|
1028
1045
|
'the team may; who can read the file does not change.',
|
|
1029
1046
|
effect: 'writes',
|
|
1030
1047
|
appliesTo: [String(KIND_BARE_FILE)],
|
|
1031
|
-
emits: { kind: 1851, field:
|
|
1048
|
+
emits: { kind: 1851, field: 'parent' },
|
|
1032
1049
|
input: { type: 'string' },
|
|
1033
1050
|
},
|
|
1034
1051
|
{
|
|
@@ -1558,6 +1575,47 @@ export function actionProblems(declared) {
|
|
|
1558
1575
|
problems.push(`${name} writes ${targeted.length} properties to content (${targeted.join(', ')}), and an event has one. A consumer refuses the whole action rather than choosing between them.`);
|
|
1559
1576
|
}
|
|
1560
1577
|
}
|
|
1578
|
+
/*
|
|
1579
|
+
MAN-1's three declarations, each of which fails quietly on the consumer's
|
|
1580
|
+
side: an unknown placement or format is refused or ignored at the button,
|
|
1581
|
+
and a `listed` on a change is simply never acted on.
|
|
1582
|
+
*/
|
|
1583
|
+
const emits = action.emits;
|
|
1584
|
+
const input = action.input;
|
|
1585
|
+
const creates = input?.type === 'object' && !!properties;
|
|
1586
|
+
if (emits?.placement !== undefined && !(creates && PLACEMENTS.includes(emits.placement))) {
|
|
1587
|
+
problems.push(creates
|
|
1588
|
+
? `${name} places its object with ${JSON.stringify(emits.placement)}, and a Folder is named by ${PLACEMENTS.join(' or ')} — a consumer refuses the action.`
|
|
1589
|
+
: `${name} declares a placement and creates nothing; only a new root names its Folder, so it is ignored.`);
|
|
1590
|
+
}
|
|
1591
|
+
if (emits?.listed !== undefined && emits.listed !== true) {
|
|
1592
|
+
problems.push(`${name} declares listed ${JSON.stringify(emits.listed)}; the only value is true.`);
|
|
1593
|
+
}
|
|
1594
|
+
else if (emits?.listed === true && !creates && emits.kind !== KIND_DELETION) {
|
|
1595
|
+
problems.push(`${name} declares listed on an action that neither creates nor deletes, so no Folder command follows it.`);
|
|
1596
|
+
}
|
|
1597
|
+
const formats = [
|
|
1598
|
+
// A scalar format means something on a change only: a comment's body is
|
|
1599
|
+
// marker text, and a deletion takes no value.
|
|
1600
|
+
...(input?.format !== undefined
|
|
1601
|
+
? [['its input', input.format, !creates && !!emits?.field && emits.kind !== KIND_DELETION]]
|
|
1602
|
+
: []),
|
|
1603
|
+
...Object.entries(properties && typeof properties === 'object' ? properties : {})
|
|
1604
|
+
.filter(([, spec]) => spec?.format !== undefined)
|
|
1605
|
+
.map(([property, spec]) => [
|
|
1606
|
+
`"${property}"`,
|
|
1607
|
+
spec.format,
|
|
1608
|
+
spec.target === 'content',
|
|
1609
|
+
]),
|
|
1610
|
+
];
|
|
1611
|
+
for (const [where, format, applies] of formats) {
|
|
1612
|
+
if (!applies) {
|
|
1613
|
+
problems.push(`${name} declares a format on ${where}, which is neither a creation's content nor a change's value, so it is ignored.`);
|
|
1614
|
+
}
|
|
1615
|
+
else if (!proseFormatOf(format)) {
|
|
1616
|
+
problems.push(`${name} declares format ${JSON.stringify(format)} on ${where}, and the only format is ${BLOCK_DOCUMENT_FORMAT}. A consumer draws it as plain text.`);
|
|
1617
|
+
}
|
|
1618
|
+
}
|
|
1561
1619
|
return problems;
|
|
1562
1620
|
}
|
|
1563
1621
|
export function pickWidget(declared, implemented, fallback) {
|
|
@@ -1772,7 +1830,7 @@ function buildObject(args) {
|
|
|
1772
1830
|
comments: args.comments ?? [],
|
|
1773
1831
|
listsChildren: listsChildrenOf(projection, manifest),
|
|
1774
1832
|
parentRef: parentRefOf(manifest, pointer.kind, root, folded),
|
|
1775
|
-
...(pointer.kind
|
|
1833
|
+
...parentFieldsOf(manifest, pointer.kind),
|
|
1776
1834
|
folder: tagValue(root, 'h'),
|
|
1777
1835
|
// Substituted here rather than in the component: `<bech32>` is a NIP-89
|
|
1778
1836
|
// detail, and the widget's job is to draw a link, not to know the spec.
|
|
@@ -2216,16 +2274,24 @@ function parentRefOf(manifest, kind, root, folded = {}) {
|
|
|
2216
2274
|
direction lets Ship's project list its issues without an issue knowing what
|
|
2217
2275
|
a project is; this one lets a topic sit under a project, an issue, or a kind
|
|
2218
2276
|
nobody has met, without that kind's owner declaring bare files as children.
|
|
2219
|
-
Re-parenting is a `
|
|
2220
|
-
|
|
2277
|
+
Re-parenting is a change to the declared `movedBy` field, seeded by the
|
|
2278
|
+
root tag — `parent` on a bare file, `project` on a Ship issue (SPEC §7.2).
|
|
2221
2279
|
*/
|
|
2222
|
-
|
|
2280
|
+
const movedBy = movedByOf(manifest, kind);
|
|
2281
|
+
if (movedBy) {
|
|
2223
2282
|
// A folded empty value is a move to the top, not an absence: falling back
|
|
2224
2283
|
// to the root tag would put the file straight back under the parent it
|
|
2225
2284
|
// was moved out of (FOL-4).
|
|
2226
|
-
|
|
2227
|
-
|
|
2228
|
-
|
|
2285
|
+
// A value that is not an address of the declared parent kind names nothing
|
|
2286
|
+
// this object can sit under, so it is a move to nowhere rather than a ref a
|
|
2287
|
+
// consumer might try to fetch.
|
|
2288
|
+
const moved = folded[movedBy.field];
|
|
2289
|
+
if (moved) {
|
|
2290
|
+
const prefix = movedBy.parentKind === undefined ? /^\d+:[0-9a-f]{64}:/ : new RegExp(`^${movedBy.parentKind}:[0-9a-f]{64}:`);
|
|
2291
|
+
return prefix.test(moved.value) ? moved.value : undefined;
|
|
2292
|
+
}
|
|
2293
|
+
}
|
|
2294
|
+
if (kind === KIND_BARE_FILE) {
|
|
2229
2295
|
return root.tags.find((t) => t[0] === 'a' && t[1] && /^\d+:[0-9a-f]{64}:/.test(t[1]))?.[1];
|
|
2230
2296
|
}
|
|
2231
2297
|
for (const [parentKind, projection] of Object.entries(manifest.projections ?? {})) {
|
|
@@ -2248,6 +2314,34 @@ function parentRefOf(manifest, kind, root, folded = {}) {
|
|
|
2248
2314
|
}
|
|
2249
2315
|
return undefined;
|
|
2250
2316
|
}
|
|
2317
|
+
/**
|
|
2318
|
+
* The field that moves a `kind` object to another parent, and the kind of
|
|
2319
|
+
* parent it names — SPEC §7.2's `movedBy`, read off whichever projection lists
|
|
2320
|
+
* `kind` as its children (MAN-1).
|
|
2321
|
+
*
|
|
2322
|
+
* `parentKind` is absent for a bare file: §6.7 lets one sit under a file of any
|
|
2323
|
+
* kind, so its own list naming bare files is not a limit on where it may go.
|
|
2324
|
+
* Absent too for `match: 'identifier'`, where `movedBy` is ignored because a
|
|
2325
|
+
* move's value is an address and that list compares identifiers.
|
|
2326
|
+
*/
|
|
2327
|
+
function movedByOf(manifest, kind) {
|
|
2328
|
+
for (const [parentKind, projection] of Object.entries(manifest.projections ?? {})) {
|
|
2329
|
+
const children = declaredChildSpec(projection);
|
|
2330
|
+
if (!children || children.kind !== kind || !children.movedBy || children.match === 'identifier')
|
|
2331
|
+
continue;
|
|
2332
|
+
return kind === KIND_BARE_FILE ? { field: children.movedBy } : { field: children.movedBy, parentKind: Number(parentKind) };
|
|
2333
|
+
}
|
|
2334
|
+
return undefined;
|
|
2335
|
+
}
|
|
2336
|
+
/** {@link movedByOf} as the two `ForeignObject` fields, both builders' shape. */
|
|
2337
|
+
function parentFieldsOf(manifest, kind) {
|
|
2338
|
+
const moved = movedByOf(manifest, kind);
|
|
2339
|
+
if (!moved)
|
|
2340
|
+
return {};
|
|
2341
|
+
return moved.parentKind === undefined
|
|
2342
|
+
? { parentField: moved.field }
|
|
2343
|
+
: { parentField: moved.field, parentKind: moved.parentKind };
|
|
2344
|
+
}
|
|
2251
2345
|
/** Both halves of the question a disclosure control asks. */
|
|
2252
2346
|
function listsChildrenOf(projection, manifest) {
|
|
2253
2347
|
const children = declaredChildSpec(projection);
|
|
@@ -2346,7 +2440,7 @@ function buildChildObject(args) {
|
|
|
2346
2440
|
// an inconsistent shape is what makes a consumer defensive about a value it
|
|
2347
2441
|
// should be able to trust.
|
|
2348
2442
|
parentRef: parentRefOf(manifest, root.kind, root),
|
|
2349
|
-
...(root.kind
|
|
2443
|
+
...parentFieldsOf(manifest, root.kind),
|
|
2350
2444
|
folder: tagValue(root, 'h'),
|
|
2351
2445
|
/*
|
|
2352
2446
|
`<bech32>` is whichever form this object actually has.
|
|
@@ -2914,6 +3008,47 @@ cache) {
|
|
|
2914
3008
|
* it where it looks.
|
|
2915
3009
|
*/
|
|
2916
3010
|
const isAddressableKind = (kind) => kind >= 30000 && kind < 40000;
|
|
3011
|
+
/**
|
|
3012
|
+
* The tags a new root may name its Folder with — SPEC §7.3's `placement`.
|
|
3013
|
+
*
|
|
3014
|
+
* The two a relay indexes for a Folder's containment read and {@link folderOf}
|
|
3015
|
+
* reads. Closed, because a root placed in any other tag belongs to no Folder
|
|
3016
|
+
* and nothing would say so.
|
|
3017
|
+
*/
|
|
3018
|
+
const PLACEMENTS = ['h', 'buzz-channel'];
|
|
3019
|
+
/**
|
|
3020
|
+
* The tags a prose value carries — SPEC §7.3's `format`, MAN-1.
|
|
3021
|
+
*
|
|
3022
|
+
* **Tagged only when the caller says the value is in the declared format**, and
|
|
3023
|
+
* then checked, because a reader decides the model by the tag alone (§13.4): a
|
|
3024
|
+
* `content-format` on marker text renders nothing, and one on a document the
|
|
3025
|
+
* relay cannot parse renders JSON at a person. Without `contentFormat` the value
|
|
3026
|
+
* is marker text and carries nothing, which every reader must accept — so a
|
|
3027
|
+
* consumer that draws a text box for a prose field still publishes correctly.
|
|
3028
|
+
*
|
|
3029
|
+
* A document's attachments are named again as `imeta`, which §13.3 requires of
|
|
3030
|
+
* every event holding one and which ingest verifies against stored blobs.
|
|
3031
|
+
*/
|
|
3032
|
+
function proseTags(args) {
|
|
3033
|
+
const { label, declared, contentFormat, value } = args;
|
|
3034
|
+
if (contentFormat === undefined)
|
|
3035
|
+
return [];
|
|
3036
|
+
if (proseFormatOf(declared) !== contentFormat) {
|
|
3037
|
+
return proseFormatOf(declared)
|
|
3038
|
+
? `"${label}" takes ${proseFormatOf(declared)}, not ${contentFormat}.`
|
|
3039
|
+
: `"${label}" declares no ${contentFormat} value, so it is written as plain text.`;
|
|
3040
|
+
}
|
|
3041
|
+
// Clearing a field is not a document; an empty value says nothing to tag.
|
|
3042
|
+
if (value === '')
|
|
3043
|
+
return [];
|
|
3044
|
+
try {
|
|
3045
|
+
parseBlockDocument(value);
|
|
3046
|
+
}
|
|
3047
|
+
catch (e) {
|
|
3048
|
+
return `"${label}" was handed ${contentFormat} that is ${e.message}.`;
|
|
3049
|
+
}
|
|
3050
|
+
return [[CONTENT_FORMAT_TAG, contentFormat], ...attachmentsInDocument(value, contentFormat).map(imetaTag)];
|
|
3051
|
+
}
|
|
2917
3052
|
/**
|
|
2918
3053
|
* The event an object-creating action publishes.
|
|
2919
3054
|
*
|
|
@@ -2974,6 +3109,19 @@ function buildCreationEvent(args) {
|
|
|
2974
3109
|
return `"${declared.label}" declares ${bodyFields.length} fields writing to content (${bodyFields.join(', ')}), and an event has one.`;
|
|
2975
3110
|
}
|
|
2976
3111
|
const bodyField = bodyFields[0];
|
|
3112
|
+
const placement = declared.emits.placement ?? 'h';
|
|
3113
|
+
if (!PLACEMENTS.includes(placement)) {
|
|
3114
|
+
return `"${declared.label}" places its object with "${placement}", and a Folder is named by ${PLACEMENTS.join(' or ')}.`;
|
|
3115
|
+
}
|
|
3116
|
+
// Only the content field can be prose, so only its value is ever tagged.
|
|
3117
|
+
const prose = proseTags({
|
|
3118
|
+
label: declared.label,
|
|
3119
|
+
declared: bodyField ? properties[bodyField]?.format : undefined,
|
|
3120
|
+
contentFormat: args.contentFormat,
|
|
3121
|
+
value: bodyField ? (value[bodyField] ?? '') : '',
|
|
3122
|
+
});
|
|
3123
|
+
if (typeof prose === 'string')
|
|
3124
|
+
return prose;
|
|
2977
3125
|
const tags = [];
|
|
2978
3126
|
if (isAddressableKind(declared.emits.kind))
|
|
2979
3127
|
tags.push(['d', newId]);
|
|
@@ -2989,7 +3137,7 @@ function buildCreationEvent(args) {
|
|
|
2989
3137
|
if (declared.emits.setTag && declared.emits.toAddressOf === 'self') {
|
|
2990
3138
|
tags.push([declared.emits.setTag, address]);
|
|
2991
3139
|
}
|
|
2992
|
-
tags.push([
|
|
3140
|
+
tags.push([placement, folder], ...prose);
|
|
2993
3141
|
return {
|
|
2994
3142
|
pubkey: args.pubkey,
|
|
2995
3143
|
created_at: Math.floor(args.createdAtMs / 1000),
|
|
@@ -2998,7 +3146,73 @@ function buildCreationEvent(args) {
|
|
|
2998
3146
|
content: bodyField ? (value[bodyField] ?? '') : '',
|
|
2999
3147
|
};
|
|
3000
3148
|
}
|
|
3149
|
+
/**
|
|
3150
|
+
* Build the event that performs a manifest-declared action — one event.
|
|
3151
|
+
*
|
|
3152
|
+
* **Refuses an action declaring `emits.listed`**, which is more than one event
|
|
3153
|
+
* (SPEC §7.3): building the root alone would publish an object its Folder does
|
|
3154
|
+
* not show, and report success. {@link buildActionEvents} builds those.
|
|
3155
|
+
*/
|
|
3001
3156
|
export function buildActionEvent(args) {
|
|
3157
|
+
const declared = args.manifest.actions?.find((a) => a.id === args.actionId);
|
|
3158
|
+
if (declared?.emits.listed === true && (declared.emits.kind === KIND_DELETION || isCreationAction(declared))) {
|
|
3159
|
+
return `"${declared.label}" is followed by a Folder command, so it is built with buildActionEvents.`;
|
|
3160
|
+
}
|
|
3161
|
+
return buildOneActionEvent(args);
|
|
3162
|
+
}
|
|
3163
|
+
/** An action that makes a new object rather than changing one — a form. */
|
|
3164
|
+
function isCreationAction(declared) {
|
|
3165
|
+
return declared.input?.type === 'object' && !!declared.input.properties;
|
|
3166
|
+
}
|
|
3167
|
+
/**
|
|
3168
|
+
* Every event an action publishes, **in publish order** — SPEC §7.3, MAN-1.
|
|
3169
|
+
*
|
|
3170
|
+
* The first is what {@link buildActionEvent} builds. An action declaring
|
|
3171
|
+
* `emits.listed` is followed by the Folder commands that keep its Folder's
|
|
3172
|
+
* listing true, planned by `planPlaceFile` / `planUnlistFile`:
|
|
3173
|
+
*
|
|
3174
|
+
* - a creation: `kind:1852 add` naming the new address in the Folder it was
|
|
3175
|
+
* placed in, when `folderHasState` — none when the Folder has no state, where
|
|
3176
|
+
* a command would hide everything else filed there;
|
|
3177
|
+
* - a deletion: `kind:1852 remove` from each of `listedIn` that has state.
|
|
3178
|
+
*
|
|
3179
|
+
* Both facts come from the caller's read of `kind:30890` and are required
|
|
3180
|
+
* rather than defaulted, because a guess here is silent loss. Publish in order
|
|
3181
|
+
* and stop at the first refusal: each event assumes the ones before it landed.
|
|
3182
|
+
*/
|
|
3183
|
+
export function buildActionEvents(args) {
|
|
3184
|
+
const first = buildOneActionEvent(args);
|
|
3185
|
+
if (typeof first === 'string')
|
|
3186
|
+
return first;
|
|
3187
|
+
const declared = args.manifest.actions.find((a) => a.id === args.actionId);
|
|
3188
|
+
if (declared.emits.listed !== true)
|
|
3189
|
+
return [first];
|
|
3190
|
+
if (declared.emits.kind === KIND_DELETION) {
|
|
3191
|
+
if (!args.listedIn)
|
|
3192
|
+
return `"${declared.label}" unlists what it deletes, and needs the Folders that list it.`;
|
|
3193
|
+
// One remove per Folder, however many reads it came back from.
|
|
3194
|
+
const folders = [...new Map(args.listedIn.map((listing) => [listing.id, listing])).values()];
|
|
3195
|
+
return [
|
|
3196
|
+
first,
|
|
3197
|
+
...folders.flatMap((listing) => planUnlistFile(args.pubkey, args.createdAtMs, { folder: listing.id, address: args.address, hasState: listing.hasState })),
|
|
3198
|
+
];
|
|
3199
|
+
}
|
|
3200
|
+
if (isCreationAction(declared)) {
|
|
3201
|
+
if (args.folderHasState === undefined) {
|
|
3202
|
+
return `"${declared.label}" lists what it creates, and needs to know whether the Folder has state.`;
|
|
3203
|
+
}
|
|
3204
|
+
// A listing names addresses, and an object with no `d` has none.
|
|
3205
|
+
const identifier = first.tags.find((t) => t[0] === 'd')?.[1];
|
|
3206
|
+
if (identifier === undefined) {
|
|
3207
|
+
return `"${declared.label}" lists what it creates, and a kind ${first.kind} has no address to list.`;
|
|
3208
|
+
}
|
|
3209
|
+
const created = pointerToAddress({ kind: first.kind, pubkey: first.pubkey, identifier, relays: [] });
|
|
3210
|
+
return [first, ...planPlaceFile(args.pubkey, args.createdAtMs, { folder: args.folder, address: created, hasState: args.folderHasState })];
|
|
3211
|
+
}
|
|
3212
|
+
// A change or a comment adds nothing to a Folder and removes nothing from it.
|
|
3213
|
+
return [first];
|
|
3214
|
+
}
|
|
3215
|
+
function buildOneActionEvent(args) {
|
|
3002
3216
|
const { manifest, kind, address, folder, actionId, value, replyTo } = args;
|
|
3003
3217
|
const records = manifest.records;
|
|
3004
3218
|
const declared = manifest.actions?.find((a) => a.id === actionId);
|
|
@@ -3008,13 +3222,18 @@ export function buildActionEvent(args) {
|
|
|
3008
3222
|
if (!appliesTo.includes(String(kind))) {
|
|
3009
3223
|
return `"${declared.label}" does not apply to a kind ${kind}.`;
|
|
3010
3224
|
}
|
|
3011
|
-
const isCreation = declared
|
|
3225
|
+
const isCreation = isCreationAction(declared);
|
|
3012
3226
|
// A reply is a comment with a parent — what the scalar path below builds for
|
|
3013
3227
|
// an action that is neither a deletion nor a change. Refused here, before any
|
|
3014
3228
|
// branch that would build something else and quietly drop the parent.
|
|
3015
3229
|
if (replyTo && (isCreation || declared.emits.kind === KIND_DELETION || declared.emits.field)) {
|
|
3016
3230
|
return `"${declared.label}" is not a comment, so it cannot reply to one.`;
|
|
3017
3231
|
}
|
|
3232
|
+
// Prose is a creation's content or a change's value (§7.3). A deletion has
|
|
3233
|
+
// no value, and a comment's body is §13.2 marker text.
|
|
3234
|
+
if (args.contentFormat !== undefined && !isCreation && (!declared.emits.field || declared.emits.kind === KIND_DELETION)) {
|
|
3235
|
+
return `"${declared.label}" takes no prose value, so it takes no content format.`;
|
|
3236
|
+
}
|
|
3018
3237
|
// An object-creating action is a different event entirely — a new object
|
|
3019
3238
|
// rather than a change to one — so it branches before the scalar path.
|
|
3020
3239
|
if (isCreation) {
|
|
@@ -3077,12 +3296,21 @@ export function buildActionEvent(args) {
|
|
|
3077
3296
|
return `"${value}" is not one of ${vocab.map((e) => e.value).join(', ')}.`;
|
|
3078
3297
|
}
|
|
3079
3298
|
}
|
|
3299
|
+
// A prose value's `content-format` and `imeta` — a change only, per the
|
|
3300
|
+
// refusal above. Ship's order: the tag before `ts`, the files after it.
|
|
3301
|
+
const prose = declared.emits.field
|
|
3302
|
+
? proseTags({ label: declared.label, declared: declared.input?.format, contentFormat: args.contentFormat, value })
|
|
3303
|
+
: [];
|
|
3304
|
+
if (typeof prose === 'string')
|
|
3305
|
+
return prose;
|
|
3306
|
+
const [formatTag, ...files] = prose;
|
|
3080
3307
|
const tags = declared.emits.field
|
|
3081
3308
|
? [
|
|
3082
3309
|
[records.targetTag, address],
|
|
3083
3310
|
[records.fieldTag, declared.emits.field],
|
|
3084
3311
|
[records.valueTag, value],
|
|
3085
3312
|
['h', folder],
|
|
3313
|
+
...(formatTag ? [formatTag] : []),
|
|
3086
3314
|
]
|
|
3087
3315
|
: // NIP-22 comment. Built from the ratified NIP rather than from the
|
|
3088
3316
|
// manifest, which is legitimate precisely because no app owns kind:1111 —
|
|
@@ -3112,6 +3340,7 @@ export function buildActionEvent(args) {
|
|
|
3112
3340
|
// depending on which app you asked (FRICTION.md A6).
|
|
3113
3341
|
if (records.order?.includes('ts'))
|
|
3114
3342
|
tags.push(['ts', String(args.createdAtMs)]);
|
|
3343
|
+
tags.push(...files);
|
|
3115
3344
|
return {
|
|
3116
3345
|
pubkey: args.pubkey,
|
|
3117
3346
|
created_at: Math.floor(args.createdAtMs / 1000),
|