@agentshouse/app-bridge 0.1.0-c895bda3a3f6a → 0.1.0-c8a7dd564e490
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 +6 -6
- package/dist/index.d.ts +91 -59
- package/dist/mdmodel/definition.d.ts +1 -1
- package/dist/mdmodel/document.d.ts +1 -2
- package/dist/mdmodel/event.d.ts +77 -0
- package/dist/mdmodel/facts.d.ts +14 -0
- package/dist/mdmodel/index.d.ts +19 -6
- package/dist/mdmodel/kinds.d.ts +18 -0
- package/dist/mdmodel/pattern.d.ts +9 -0
- package/dist/mdmodel/query/language.d.ts +253 -0
- package/dist/mdmodel/query/match.d.ts +13 -0
- package/dist/mdmodel/query/rows.d.ts +31 -0
- package/dist/mdmodel/query/sql.d.ts +38 -0
- package/dist/mdmodel/reserved.d.ts +4 -0
- package/dist/mdmodel/types.d.ts +7 -5
- package/dist/mdmodel/validate.d.ts +7 -5
- package/dist/mdruntime/adapter.d.ts +37 -25
- package/dist/mdruntime/chain.d.ts +2 -1
- package/dist/mdruntime/change.d.ts +1 -0
- package/dist/mdruntime/client.d.ts +7 -3
- package/dist/mdruntime/collection.d.ts +2 -1
- package/dist/mdruntime/compile.d.ts +2 -7
- package/dist/mdruntime/connection.d.ts +7 -6
- package/dist/mdruntime/conversation-row.d.ts +32 -0
- package/dist/mdruntime/conversation.d.ts +18 -9
- package/dist/mdruntime/durability.d.ts +6 -0
- package/dist/mdruntime/identity.d.ts +0 -1
- package/dist/mdruntime/job.d.ts +32 -0
- package/dist/mdruntime/messages.d.ts +27 -3
- package/dist/mdruntime/model.d.ts +2 -9
- package/dist/mdruntime/observation.d.ts +2 -2
- package/dist/mdruntime/overlay.d.ts +1 -0
- package/dist/mdruntime/query.d.ts +13 -210
- package/dist/mdruntime/reach.d.ts +11 -11
- package/dist/mdruntime/readiness.d.ts +0 -2
- package/dist/mdruntime/replica.d.ts +8 -5
- package/dist/mdruntime/room-draft.d.ts +3 -2
- package/dist/mdruntime/search.d.ts +12 -63
- package/dist/mdruntime/source.d.ts +60 -0
- package/dist/mdruntime/status.d.ts +0 -2
- package/dist/mdruntime/store.d.ts +88 -41
- package/dist/mdruntime/stored.d.ts +58 -65
- package/dist/mdruntime/tables.d.ts +88 -51
- package/dist/mdruntime/wire.d.ts +8 -0
- package/dist/test-host.js +1 -1
- package/docs/families.md +17 -6
- package/package.json +1 -1
- package/dist/mdmodel/condition.d.ts +0 -180
- package/dist/mdruntime/fulltext.d.ts +0 -26
package/README.md
CHANGED
|
@@ -3,16 +3,16 @@
|
|
|
3
3
|
The types of the agents.house App bridge, an accessor and an in-page test host.
|
|
4
4
|
House builds the bridge object in every App it serves and hands it to the page
|
|
5
5
|
before the App's own scripts run; `houseBridge()` returns that object, so an App
|
|
6
|
-
carries no bridge code of its own. It carries
|
|
7
|
-
ceremonies, installation, notifications, status, Site image reads, App
|
|
8
|
-
code, external calls, App messages, App and Site screenshot reads and the
|
|
9
|
-
[docs/families.md](docs/families.md) describes each and the test host.
|
|
6
|
+
carries no bridge code of its own. It carries thirteen families: navigation,
|
|
7
|
+
ceremonies, installation, notifications, Telegram, status, Site image reads, App
|
|
8
|
+
release code, external calls, App messages, App and Site screenshot reads and the
|
|
9
|
+
Chat. [docs/families.md](docs/families.md) describes each and the test host.
|
|
10
10
|
|
|
11
11
|
The bridge carries no credential handling and no Runtime family. House builds
|
|
12
12
|
the MD Runtime client into the page beside the bridge and serves it the Chat, so
|
|
13
13
|
the App imports, constructs and bundles neither: `bridge.runtime` resolves to the client.
|
|
14
14
|
|
|
15
|
-
House's guide to building an App is its Guide's `apps/` pages, which `
|
|
15
|
+
House's guide to building an App is its Guide's `apps/` pages, which `guide/open` opens.
|
|
16
16
|
|
|
17
17
|
## Use
|
|
18
18
|
|
|
@@ -42,7 +42,7 @@ async function manageSecurity(securityPath) {
|
|
|
42
42
|
|
|
43
43
|
`bridge.runtime` resolves to the `MdRuntimeClient` of `@agentshouse/mdruntime/client`,
|
|
44
44
|
whose README describes its members. Its `call(method, params)` is a remote procedure call
|
|
45
|
-
to a House act by its name, such as `call('rooms/members', { room_ref })`: `HouseMethods`
|
|
45
|
+
to a House act by its name, such as `call('rooms/members/list', { room_ref })`: `HouseMethods`
|
|
46
46
|
names each with House's own input, `HouseParams<Name>`, and answer, `HouseResult<Name>`.
|
|
47
47
|
|
|
48
48
|
## Test without a House
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,21 @@
|
|
|
1
1
|
import type { MdRuntimeClient, Open } from './mdruntime/client.js';
|
|
2
2
|
export interface HouseMethods {
|
|
3
|
-
readonly "
|
|
3
|
+
readonly "agent-functions/requests/list": {
|
|
4
|
+
readonly params: {
|
|
5
|
+
readonly room_ref: string;
|
|
6
|
+
};
|
|
7
|
+
readonly result: {
|
|
8
|
+
readonly current: readonly {
|
|
9
|
+
readonly document: string;
|
|
10
|
+
readonly name: string;
|
|
11
|
+
}[];
|
|
12
|
+
readonly history: readonly {
|
|
13
|
+
readonly document: string;
|
|
14
|
+
readonly name: string;
|
|
15
|
+
}[];
|
|
16
|
+
};
|
|
17
|
+
};
|
|
18
|
+
readonly "apps/features/list": {
|
|
4
19
|
readonly params: {};
|
|
5
20
|
readonly result: {
|
|
6
21
|
readonly features: readonly {
|
|
@@ -9,11 +24,10 @@ export interface HouseMethods {
|
|
|
9
24
|
}[];
|
|
10
25
|
};
|
|
11
26
|
};
|
|
12
|
-
readonly "apps/holders": {
|
|
27
|
+
readonly "apps/holders/list": {
|
|
13
28
|
readonly params: {};
|
|
14
29
|
readonly result: {
|
|
15
30
|
readonly holders: readonly {
|
|
16
|
-
readonly email: string;
|
|
17
31
|
readonly name: string;
|
|
18
32
|
readonly user: string;
|
|
19
33
|
}[];
|
|
@@ -28,7 +42,7 @@ export interface HouseMethods {
|
|
|
28
42
|
readonly [key: string]: never;
|
|
29
43
|
};
|
|
30
44
|
};
|
|
31
|
-
readonly "apps/relay": {
|
|
45
|
+
readonly "apps/relay/read": {
|
|
32
46
|
readonly params: {
|
|
33
47
|
readonly [key: string]: never;
|
|
34
48
|
};
|
|
@@ -58,6 +72,7 @@ export interface HouseMethods {
|
|
|
58
72
|
} | {
|
|
59
73
|
readonly user: string;
|
|
60
74
|
};
|
|
75
|
+
readonly operation_id: string;
|
|
61
76
|
readonly path: string;
|
|
62
77
|
readonly room_ref: string;
|
|
63
78
|
};
|
|
@@ -81,6 +96,29 @@ export interface HouseMethods {
|
|
|
81
96
|
readonly url: string;
|
|
82
97
|
};
|
|
83
98
|
};
|
|
99
|
+
readonly "chats/reply": {
|
|
100
|
+
readonly params: {
|
|
101
|
+
readonly operation_id: string;
|
|
102
|
+
readonly path: string;
|
|
103
|
+
readonly room_ref: string;
|
|
104
|
+
readonly template?: {
|
|
105
|
+
readonly language: string;
|
|
106
|
+
readonly name: string;
|
|
107
|
+
};
|
|
108
|
+
readonly text?: string;
|
|
109
|
+
readonly values?: {
|
|
110
|
+
readonly [key: string]: string;
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
readonly result: {
|
|
114
|
+
readonly authority: string;
|
|
115
|
+
readonly log_epoch: string;
|
|
116
|
+
readonly path: string;
|
|
117
|
+
readonly position: string;
|
|
118
|
+
readonly room_ref: string;
|
|
119
|
+
readonly url: string;
|
|
120
|
+
};
|
|
121
|
+
};
|
|
84
122
|
readonly "chats/return": {
|
|
85
123
|
readonly params: {
|
|
86
124
|
readonly path: string;
|
|
@@ -108,6 +146,7 @@ export interface HouseMethods {
|
|
|
108
146
|
};
|
|
109
147
|
readonly "chats/take-control": {
|
|
110
148
|
readonly params: {
|
|
149
|
+
readonly operation_id: string;
|
|
111
150
|
readonly path: string;
|
|
112
151
|
readonly room_ref: string;
|
|
113
152
|
};
|
|
@@ -135,7 +174,6 @@ export interface HouseMethods {
|
|
|
135
174
|
readonly params: {
|
|
136
175
|
readonly agent_id: string;
|
|
137
176
|
readonly operation_id: string;
|
|
138
|
-
readonly replaces?: string;
|
|
139
177
|
};
|
|
140
178
|
readonly result: {
|
|
141
179
|
readonly agent_id: string;
|
|
@@ -159,22 +197,25 @@ export interface HouseMethods {
|
|
|
159
197
|
readonly position: string;
|
|
160
198
|
};
|
|
161
199
|
};
|
|
162
|
-
readonly "conversations/
|
|
200
|
+
readonly "conversations/end": {
|
|
163
201
|
readonly params: {
|
|
164
|
-
readonly conversation_id
|
|
202
|
+
readonly conversation_id: string;
|
|
165
203
|
readonly operation_id: string;
|
|
166
204
|
};
|
|
167
205
|
readonly result: {
|
|
168
206
|
readonly agent_id: string;
|
|
169
207
|
readonly authority: string;
|
|
170
208
|
readonly conversation_id: string;
|
|
171
|
-
readonly
|
|
209
|
+
readonly jobs: readonly {
|
|
210
|
+
readonly name: string;
|
|
211
|
+
readonly running_since: string;
|
|
212
|
+
}[];
|
|
172
213
|
readonly log_epoch: string;
|
|
173
214
|
readonly position: string;
|
|
174
215
|
readonly url: string;
|
|
175
216
|
};
|
|
176
217
|
};
|
|
177
|
-
readonly "conversations/history": {
|
|
218
|
+
readonly "conversations/history/list": {
|
|
178
219
|
readonly params: {
|
|
179
220
|
readonly conversations: readonly {
|
|
180
221
|
readonly after?: {
|
|
@@ -233,7 +274,7 @@ export interface HouseMethods {
|
|
|
233
274
|
readonly type: "text";
|
|
234
275
|
})[];
|
|
235
276
|
readonly role: "assistant" | "house" | "user";
|
|
236
|
-
readonly sender?: "conversation" | "customer" | "owner" | "report" | "requester" | "trigger";
|
|
277
|
+
readonly sender?: "conversation" | "customer" | "owner" | "replier" | "report" | "requester" | "trigger";
|
|
237
278
|
readonly source?: {
|
|
238
279
|
readonly agent: {
|
|
239
280
|
readonly id: string;
|
|
@@ -274,6 +315,11 @@ export interface HouseMethods {
|
|
|
274
315
|
};
|
|
275
316
|
readonly request: string;
|
|
276
317
|
} | {
|
|
318
|
+
readonly agent_function: null | {
|
|
319
|
+
readonly id: string;
|
|
320
|
+
readonly name: string;
|
|
321
|
+
readonly version: number;
|
|
322
|
+
};
|
|
277
323
|
readonly approved_at: null | string;
|
|
278
324
|
readonly kind: "request";
|
|
279
325
|
readonly request: string;
|
|
@@ -291,11 +337,9 @@ export interface HouseMethods {
|
|
|
291
337
|
readonly ref: string;
|
|
292
338
|
readonly url: string;
|
|
293
339
|
};
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
readonly version: number;
|
|
298
|
-
};
|
|
340
|
+
} | {
|
|
341
|
+
readonly kind: "reply";
|
|
342
|
+
readonly name: string;
|
|
299
343
|
} | {
|
|
300
344
|
readonly kind: "trigger";
|
|
301
345
|
readonly path: null | string;
|
|
@@ -312,6 +356,12 @@ export interface HouseMethods {
|
|
|
312
356
|
};
|
|
313
357
|
readonly telegram_undelivered?: true;
|
|
314
358
|
readonly text: string;
|
|
359
|
+
readonly tokens?: {
|
|
360
|
+
readonly cache_read: number;
|
|
361
|
+
readonly cache_write: number;
|
|
362
|
+
readonly input: number;
|
|
363
|
+
readonly output: number;
|
|
364
|
+
};
|
|
315
365
|
readonly transcripts?: readonly {
|
|
316
366
|
readonly path: string;
|
|
317
367
|
readonly text: string;
|
|
@@ -375,7 +425,7 @@ export interface HouseMethods {
|
|
|
375
425
|
readonly url: string;
|
|
376
426
|
};
|
|
377
427
|
};
|
|
378
|
-
readonly "conversations/option": {
|
|
428
|
+
readonly "conversations/option/set": {
|
|
379
429
|
readonly params: {
|
|
380
430
|
readonly conversation_id: string;
|
|
381
431
|
readonly operation_id: string;
|
|
@@ -439,7 +489,7 @@ export interface HouseMethods {
|
|
|
439
489
|
readonly url: string;
|
|
440
490
|
};
|
|
441
491
|
};
|
|
442
|
-
readonly "records/
|
|
492
|
+
readonly "records/list": {
|
|
443
493
|
readonly params: {
|
|
444
494
|
readonly order?: "asc" | "desc";
|
|
445
495
|
readonly room_ref: string;
|
|
@@ -454,10 +504,9 @@ export interface HouseMethods {
|
|
|
454
504
|
}[];
|
|
455
505
|
};
|
|
456
506
|
};
|
|
457
|
-
readonly "rooms/access/
|
|
507
|
+
readonly "rooms/access/list": {
|
|
458
508
|
readonly params: {
|
|
459
509
|
readonly room_ref: string;
|
|
460
|
-
readonly statistics?: boolean;
|
|
461
510
|
};
|
|
462
511
|
readonly result: {
|
|
463
512
|
readonly authority: "administrator" | "member" | "owner";
|
|
@@ -466,41 +515,33 @@ export interface HouseMethods {
|
|
|
466
515
|
readonly direct: readonly {
|
|
467
516
|
readonly level: null | "keep" | "open" | "search";
|
|
468
517
|
readonly namespace: string;
|
|
469
|
-
readonly operations: readonly ("
|
|
518
|
+
readonly operations: readonly ("erase" | "export" | "manageAccess" | "write")[];
|
|
470
519
|
}[];
|
|
471
|
-
readonly downloads_per_day?: number;
|
|
472
520
|
readonly entries: readonly {
|
|
473
521
|
readonly level: null | "keep" | "open" | "search";
|
|
474
522
|
readonly namespace: string;
|
|
475
|
-
readonly operations: readonly ("
|
|
523
|
+
readonly operations: readonly ("erase" | "export" | "manageAccess" | "write")[];
|
|
476
524
|
readonly sources: readonly {
|
|
477
525
|
readonly kind: "direct" | "inherited";
|
|
478
526
|
readonly level: null | "keep" | "open" | "search";
|
|
479
527
|
readonly namespace: string;
|
|
480
|
-
readonly operations: readonly ("
|
|
528
|
+
readonly operations: readonly ("erase" | "export" | "manageAccess" | "write")[];
|
|
481
529
|
}[];
|
|
482
530
|
}[];
|
|
483
531
|
readonly key: null | string;
|
|
484
|
-
readonly requests_per_day?: number;
|
|
485
532
|
readonly schema_roles: readonly string[];
|
|
533
|
+
readonly through_space?: true;
|
|
486
534
|
readonly user: string;
|
|
487
535
|
readonly user_name: string;
|
|
488
536
|
}[];
|
|
489
537
|
readonly namespaces: readonly string[];
|
|
490
538
|
readonly owner: string;
|
|
491
539
|
readonly room_ref: string;
|
|
492
|
-
readonly statistics?: readonly {
|
|
493
|
-
readonly day: string;
|
|
494
|
-
readonly downloads: number;
|
|
495
|
-
readonly requests: number;
|
|
496
|
-
readonly text_bytes: number;
|
|
497
|
-
readonly user: string;
|
|
498
|
-
}[];
|
|
499
540
|
readonly url: string;
|
|
500
541
|
readonly viewer: string;
|
|
501
542
|
};
|
|
502
543
|
};
|
|
503
|
-
readonly "rooms/members": {
|
|
544
|
+
readonly "rooms/members/list": {
|
|
504
545
|
readonly params: {
|
|
505
546
|
readonly history?: boolean;
|
|
506
547
|
readonly room_ref: string;
|
|
@@ -512,14 +553,15 @@ export interface HouseMethods {
|
|
|
512
553
|
readonly user: string;
|
|
513
554
|
}[];
|
|
514
555
|
readonly members: readonly {
|
|
515
|
-
readonly access?: "
|
|
556
|
+
readonly access?: "manage" | "owner" | "read" | "write";
|
|
557
|
+
readonly copies?: "online_only" | "search_only";
|
|
516
558
|
readonly display_name: string;
|
|
517
559
|
readonly email?: string;
|
|
518
560
|
readonly member_document: null | string;
|
|
519
|
-
readonly only_while_online?: true;
|
|
520
561
|
readonly owner: boolean;
|
|
521
562
|
readonly schema_roles?: readonly string[];
|
|
522
563
|
readonly since: null | string;
|
|
564
|
+
readonly through_space?: true;
|
|
523
565
|
readonly user: string;
|
|
524
566
|
}[];
|
|
525
567
|
};
|
|
@@ -557,22 +599,7 @@ export interface HouseMethods {
|
|
|
557
599
|
readonly writable: boolean;
|
|
558
600
|
};
|
|
559
601
|
};
|
|
560
|
-
readonly "
|
|
561
|
-
readonly params: {
|
|
562
|
-
readonly room_ref: string;
|
|
563
|
-
};
|
|
564
|
-
readonly result: {
|
|
565
|
-
readonly current: readonly {
|
|
566
|
-
readonly document: string;
|
|
567
|
-
readonly name: string;
|
|
568
|
-
}[];
|
|
569
|
-
readonly history: readonly {
|
|
570
|
-
readonly document: string;
|
|
571
|
-
readonly name: string;
|
|
572
|
-
}[];
|
|
573
|
-
};
|
|
574
|
-
};
|
|
575
|
-
readonly "site/submission": {
|
|
602
|
+
readonly "sites/submissions/create": {
|
|
576
603
|
readonly params: {
|
|
577
604
|
readonly content: string;
|
|
578
605
|
};
|
|
@@ -580,7 +607,7 @@ export interface HouseMethods {
|
|
|
580
607
|
readonly submitted: true;
|
|
581
608
|
};
|
|
582
609
|
};
|
|
583
|
-
readonly "storage/inventory": {
|
|
610
|
+
readonly "storage/inventory/read": {
|
|
584
611
|
readonly params: {
|
|
585
612
|
readonly room_ref?: string;
|
|
586
613
|
};
|
|
@@ -671,20 +698,20 @@ export interface HouseMethods {
|
|
|
671
698
|
};
|
|
672
699
|
};
|
|
673
700
|
};
|
|
674
|
-
readonly "triggers/fired": {
|
|
701
|
+
readonly "triggers/fired/list": {
|
|
675
702
|
readonly params: {
|
|
676
703
|
readonly room_ref: string;
|
|
677
704
|
};
|
|
678
705
|
readonly result: {
|
|
679
706
|
readonly events: readonly {
|
|
680
707
|
readonly actions: readonly ({
|
|
681
|
-
readonly cap: "address_submissions" | "app_sockets" | "environment_functions" | "export_starts" | "
|
|
708
|
+
readonly cap: "address_submissions" | "app_sockets" | "environment_functions" | "export_starts" | "kit_connections" | "live_shares" | "open_uploads" | "ownership_offers" | "push_addresses" | "push_deliveries" | "room_triggers" | "service_keys" | "share_creations" | "share_room_creations" | "site_published_bytes" | "site_rooms" | "slot_rooms" | "spaces" | "waiting_web_wizards" | "writes";
|
|
682
709
|
readonly code: "cap_reached";
|
|
683
710
|
readonly outcome: "refused";
|
|
684
711
|
readonly position: number;
|
|
685
712
|
readonly retry_at: string;
|
|
686
713
|
} | {
|
|
687
|
-
readonly cap: "address_submissions" | "app_sockets" | "environment_functions" | "export_starts" | "
|
|
714
|
+
readonly cap: "address_submissions" | "app_sockets" | "environment_functions" | "export_starts" | "kit_connections" | "live_shares" | "open_uploads" | "ownership_offers" | "push_addresses" | "push_deliveries" | "room_triggers" | "service_keys" | "share_creations" | "share_room_creations" | "site_published_bytes" | "site_rooms" | "slot_rooms" | "spaces" | "waiting_web_wizards" | "writes";
|
|
688
715
|
readonly code: "cap_reached";
|
|
689
716
|
readonly outcome: "refused";
|
|
690
717
|
readonly position: number;
|
|
@@ -739,21 +766,21 @@ export interface HouseMethods {
|
|
|
739
766
|
readonly value: string;
|
|
740
767
|
} | {
|
|
741
768
|
readonly code: "limit_reached";
|
|
742
|
-
readonly limit: "custom_domains" | "external_calls" | "
|
|
769
|
+
readonly limit: "custom_domains" | "external_calls" | "publish_data" | "sites";
|
|
743
770
|
readonly outcome: "refused";
|
|
744
771
|
readonly position: number;
|
|
745
772
|
readonly retry_at: string;
|
|
746
773
|
} | {
|
|
747
774
|
readonly code: "limit_reached";
|
|
748
|
-
readonly limit: "custom_domains" | "external_calls" | "
|
|
775
|
+
readonly limit: "custom_domains" | "external_calls" | "publish_data" | "sites";
|
|
749
776
|
readonly outcome: "refused";
|
|
750
777
|
readonly position: number;
|
|
751
778
|
} | {
|
|
752
|
-
readonly code: "
|
|
779
|
+
readonly code: "agent_function_not_found" | "agent_function_retired" | "app_function_not_found" | "app_not_found" | "environment_function_not_found" | "environment_offline" | "no_recipient" | "target_agent_unavailable";
|
|
753
780
|
readonly outcome: "no_target";
|
|
754
781
|
readonly position: number;
|
|
755
782
|
} | {
|
|
756
|
-
readonly code: "
|
|
783
|
+
readonly code: "agent_function_request_not_started" | "internal_error";
|
|
757
784
|
readonly outcome: "failed";
|
|
758
785
|
readonly position: number;
|
|
759
786
|
} | {
|
|
@@ -914,6 +941,11 @@ export interface HouseAppMessage {
|
|
|
914
941
|
}
|
|
915
942
|
export type HouseInstallation = Open<'accepted' | 'dismissed' | 'manual'>;
|
|
916
943
|
export type HouseNotifications = Open<'on' | 'off' | 'blocked' | 'unavailable'>;
|
|
944
|
+
export interface HouseTelegram {
|
|
945
|
+
readonly state: Open<'available' | 'linked' | 'unavailable'>;
|
|
946
|
+
readonly name: string | null;
|
|
947
|
+
readonly username: string | null;
|
|
948
|
+
}
|
|
917
949
|
export interface HouseCeremonyRefused extends Error {
|
|
918
950
|
readonly name: 'HouseCeremonyRefused';
|
|
919
951
|
readonly code: Open<'house_ceremony_refused'>;
|
|
@@ -963,7 +995,7 @@ export interface HouseBridge {
|
|
|
963
995
|
ceremony(path: string): Promise<never>;
|
|
964
996
|
install(): Promise<HouseInstallation>;
|
|
965
997
|
notifications(on?: boolean): Promise<HouseNotifications>;
|
|
966
|
-
|
|
998
|
+
telegram(link?: true): Promise<HouseTelegram>;
|
|
967
999
|
setTab(tab: HouseTab): void;
|
|
968
1000
|
sourceTop(app: string, release?: string): Promise<HouseSourceTop | HouseRefusal | null>;
|
|
969
1001
|
sourceDownload(app: string, release?: string): Promise<HouseSourceDownload | HouseRefusal | null>;
|
|
@@ -78,4 +78,4 @@ export type PointerFacts = {
|
|
|
78
78
|
export declare function crossedFacts(facts: ValueFacts): ValueFacts[];
|
|
79
79
|
export declare function fieldFacts(definition: Definition, key: string): ValueFacts | undefined;
|
|
80
80
|
export declare function pointerFacts(definition: Definition, pointer: string): PointerFacts | undefined;
|
|
81
|
-
export declare function readSchema(text: string, provided?: VerifiedModel): VerifiedModel | Failure;
|
|
81
|
+
export declare function readSchema(text: string, provided?: VerifiedModel, checked?: boolean): VerifiedModel | Failure;
|
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
import { type Definition } from './definition.js';
|
|
2
2
|
import { type LinkInventory } from './links.js';
|
|
3
|
-
import type { ApplyResult, BodyResult, FrontmatterResult, Change, Document, Link,
|
|
3
|
+
import type { ApplyResult, BodyResult, FrontmatterResult, Change, Document, Link, ParseResult } from './types.js';
|
|
4
4
|
import { type YamlMap } from './yaml.js';
|
|
5
5
|
export declare function inventoryOf(document: Document): LinkInventory;
|
|
6
6
|
export declare function parseFrontmatter(content: string, file?: string): FrontmatterResult;
|
|
7
|
-
export declare function outline(content: string, file: string): Outline;
|
|
8
7
|
export declare function parse(content: string, file?: string): ParseResult;
|
|
9
8
|
export declare function relativize(document: Document, file: string, handle: string, definition?: Definition, kept?: ReadonlySet<string>): ApplyResult;
|
|
10
9
|
export declare function relativizeBody(body: string, file: string, handle: string): BodyResult;
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { type Definition } from './definition.js';
|
|
2
|
+
import type { Candidate } from './query/match.js';
|
|
3
|
+
import type { Document, VerifiedModel } from './types.js';
|
|
4
|
+
export type FactKind = 'string' | 'number' | 'boolean' | 'date' | 'time' | 'enum' | 'reference';
|
|
5
|
+
type Scalar = string | number | boolean;
|
|
6
|
+
export type Fact = {
|
|
7
|
+
readonly kind: FactKind;
|
|
8
|
+
readonly value: Scalar;
|
|
9
|
+
readonly member?: string;
|
|
10
|
+
} | {
|
|
11
|
+
readonly kind: 'prose';
|
|
12
|
+
} | {
|
|
13
|
+
readonly kind: 'null';
|
|
14
|
+
} | {
|
|
15
|
+
readonly kind: 'unreadable';
|
|
16
|
+
} | {
|
|
17
|
+
readonly kind: 'list';
|
|
18
|
+
readonly items: readonly Fact[];
|
|
19
|
+
} | {
|
|
20
|
+
readonly kind: 'object';
|
|
21
|
+
readonly fields: Readonly<Record<string, Fact>>;
|
|
22
|
+
};
|
|
23
|
+
export type DocumentFacts = {
|
|
24
|
+
readonly id: string;
|
|
25
|
+
readonly path: string;
|
|
26
|
+
readonly type: string | null;
|
|
27
|
+
readonly fields: Readonly<Record<string, Fact>>;
|
|
28
|
+
readonly sections: readonly string[];
|
|
29
|
+
};
|
|
30
|
+
export declare const TEXT_FIELD = "/text";
|
|
31
|
+
export declare const WRITE_DOORS: readonly ['browser', 'agent', 'client', 'function'];
|
|
32
|
+
export type WriteDoor = (typeof WRITE_DOORS)[number];
|
|
33
|
+
export type Actor = {
|
|
34
|
+
readonly user?: string;
|
|
35
|
+
readonly site?: string;
|
|
36
|
+
readonly app?: string;
|
|
37
|
+
readonly door?: WriteDoor;
|
|
38
|
+
};
|
|
39
|
+
export type DocumentEvent = {
|
|
40
|
+
readonly before: DocumentFacts | null;
|
|
41
|
+
readonly after: DocumentFacts | null;
|
|
42
|
+
readonly changed: readonly string[];
|
|
43
|
+
readonly by: Actor;
|
|
44
|
+
readonly moved_between_rooms: boolean;
|
|
45
|
+
};
|
|
46
|
+
export type ItemFacts = {
|
|
47
|
+
readonly delivery: string;
|
|
48
|
+
readonly source: string | null;
|
|
49
|
+
readonly address: string | null;
|
|
50
|
+
readonly container: string | null;
|
|
51
|
+
readonly author: string | null;
|
|
52
|
+
readonly headers: Readonly<Record<string, string>>;
|
|
53
|
+
readonly json: {
|
|
54
|
+
readonly value: unknown;
|
|
55
|
+
} | null;
|
|
56
|
+
};
|
|
57
|
+
export type MessageFacts = {
|
|
58
|
+
readonly sender: string;
|
|
59
|
+
readonly agent_function: string | null;
|
|
60
|
+
readonly path: string | null;
|
|
61
|
+
};
|
|
62
|
+
export type Resolved = {
|
|
63
|
+
readonly id: string;
|
|
64
|
+
readonly member?: string;
|
|
65
|
+
};
|
|
66
|
+
export declare function facts(document: Pick<Document, 'type' | 'fields' | 'sections'>, at: {
|
|
67
|
+
readonly id: string;
|
|
68
|
+
readonly path: string;
|
|
69
|
+
}, model: VerifiedModel, resolve: (target: string) => Resolved | undefined): DocumentFacts;
|
|
70
|
+
export declare function prosePaths(facts: DocumentFacts): string[];
|
|
71
|
+
export declare function members(document: DocumentFacts, path: string): readonly string[];
|
|
72
|
+
export declare function pointed(value: unknown, pointer: string): unknown;
|
|
73
|
+
export declare function valuedChange(definition: Definition, pointer: string): boolean;
|
|
74
|
+
export declare function datePointers(definition: Definition): string[];
|
|
75
|
+
export declare function memberPointers(definition: Definition, memberType: string): string[];
|
|
76
|
+
export declare function candidateOf(document: DocumentFacts): Candidate;
|
|
77
|
+
export {};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import type { Document, ParseResult, VerifiedModel } from './types.js';
|
|
2
|
+
export type SavedFacts = {
|
|
3
|
+
readonly type: string;
|
|
4
|
+
readonly fields: Readonly<Record<string, unknown>>;
|
|
5
|
+
readonly links: readonly string[];
|
|
6
|
+
};
|
|
7
|
+
export type ReferenceTarget = {
|
|
8
|
+
readonly location: string;
|
|
9
|
+
readonly to: readonly string[];
|
|
10
|
+
readonly target: string;
|
|
11
|
+
};
|
|
12
|
+
export declare function referenceTarget(file: string, value: string): string | null;
|
|
13
|
+
export declare function referenceTargets(document: Document, file: string, model: VerifiedModel): readonly ReferenceTarget[];
|
|
14
|
+
export declare function documentFacts(file: string, parsed: ParseResult, model: VerifiedModel): SavedFacts | null;
|
package/dist/mdmodel/index.d.ts
CHANGED
|
@@ -1,20 +1,33 @@
|
|
|
1
|
-
export {
|
|
2
|
-
export type { Actor,
|
|
1
|
+
export { candidateOf, datePointers, facts, memberPointers, members, pointed, prosePaths, TEXT_FIELD, valuedChange, WRITE_DOORS, } from './event.js';
|
|
2
|
+
export type { Actor, DocumentEvent, DocumentFacts, Fact, FactKind, ItemFacts, MessageFacts, Resolved, WriteDoor, } from './event.js';
|
|
3
|
+
export { byCodePoint, compared, dated, fitsKind, instant, instantKey, KINDS, kindOf, kindWords, } from './kinds.js';
|
|
4
|
+
export type { Kind, Ordering } from './kinds.js';
|
|
5
|
+
export { bodied, cursorOf, decodedCursor, identityOf, invalid, known, placeText, planOf, QueryError, queryKey, } from './query/language.js';
|
|
6
|
+
export type { Clause, Continuation, Direction, DocumentQuery, DocumentShape, Filter, GroupKey, GroupOrder, GroupQuery, GroupSelect, GroupShape, HeldRooms, Key, KeyPlan, LocalQuery, OrderOptions, Place, Predicate, QueryErrorCode, QueryPlan, Related, RoomFacts, Scope, Select, Test, Value, Where, } from './query/language.js';
|
|
7
|
+
export { heldAt, matches } from './query/match.js';
|
|
8
|
+
export type { Candidate } from './query/match.js';
|
|
9
|
+
export { heldKind, indexed } from './query/rows.js';
|
|
10
|
+
export type { HeldKind, HeldLink, HeldValue, Indexed, Reach } from './query/rows.js';
|
|
11
|
+
export * as sql from './query/sql.js';
|
|
3
12
|
export { headingLines } from './blocks.js';
|
|
4
13
|
export type { HeadingLine } from './blocks.js';
|
|
5
14
|
export { divide } from './divide.js';
|
|
6
|
-
export { apply, bodyLinks, links,
|
|
15
|
+
export { apply, bodyLinks, links, parse, parseFrontmatter, relativize, relativizeBody, relinkBody, serialize, } from './document.js';
|
|
16
|
+
export { documentFacts, referenceTarget, referenceTargets } from './facts.js';
|
|
17
|
+
export type { ReferenceTarget, SavedFacts } from './facts.js';
|
|
7
18
|
export { HOUSE_FIELDS, MEMBER_FIELD, RECEIVED_FIELD, SITE_FIELD, TYPE_FIELD } from './fields.js';
|
|
8
19
|
export { relative, retarget, roomPath, roomTarget, target } from './paths.js';
|
|
20
|
+
export { openPatternBudget } from './pattern.js';
|
|
9
21
|
export type { RoomTarget } from './paths.js';
|
|
10
22
|
export { MARKDOWN_SYNTAX_PROFILE } from './profile.js';
|
|
11
23
|
export { project } from './project.js';
|
|
12
24
|
export { references } from './references.js';
|
|
25
|
+
export { isDocumentPath, isReservedName, RESERVED_NAMES, ROOM_DESCRIPTION } from './reserved.js';
|
|
13
26
|
export { ARRAY_INDEX, ATTACHMENT, crossedFacts, escapePointer, itemFacts, JSON_POINTER, memberFacts, pointerFacts, pointerSegments, } from './definition.js';
|
|
14
27
|
export type { Definition, FieldRules, JsonType, PatternFacts, PointerFacts, RuleValue, SectionSpec, Shape, Transition, ValueFacts, } from './definition.js';
|
|
15
|
-
export type { ApplyResult, BodyResult, Change, Division, DivisionContext, Document, DocumentCheck, Frontmatter, FrontmatterResult, Library, ModelVerification, Link,
|
|
16
|
-
export { assess, bodyRoomLinks, checkDocument, resolves, roomReferences,
|
|
28
|
+
export type { ApplyResult, BodyResult, Change, Division, DivisionContext, Document, DocumentCheck, Frontmatter, FrontmatterResult, Library, ModelVerification, Link, ParseResult, Projection, ProjectionContext, Reached, Reference, Refusal, RoomReference, Span, TypedPath, Validation, ValidationContext, ValidationStep, VerifiedModel, } from './types.js';
|
|
29
|
+
export { assess, assessReferences, bodyRoomLinks, checkDocument, readTypes, resolves, roomReferences, validate, validating, verdicts, verify, } from './validate.js';
|
|
17
30
|
export type { Assessment, Verdicts } from './validate.js';
|
|
18
31
|
export { VERSION } from './version.js';
|
|
19
|
-
export { bodyAfterFrontmatter, equalValue, frontmatterValue } from './yaml.js';
|
|
32
|
+
export { bodyAfterFrontmatter, equalValue, frontmatterValue, plain } from './yaml.js';
|
|
20
33
|
export type { FrontmatterValue } from './yaml.js';
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { ValueFacts } from './definition.js';
|
|
2
|
+
export declare const KINDS: readonly ['string', 'number', 'integer', 'boolean', 'date', 'date-time', 'time', 'enum', 'reference'];
|
|
3
|
+
export type Kind = (typeof KINDS)[number];
|
|
4
|
+
export type Ordering = {
|
|
5
|
+
readonly direction: 'asc' | 'desc';
|
|
6
|
+
readonly nulls: 'first' | 'last';
|
|
7
|
+
readonly stringSort: 'lexical' | 'locale';
|
|
8
|
+
readonly locale: string | undefined;
|
|
9
|
+
readonly localeOptions: Intl.CollatorOptions | undefined;
|
|
10
|
+
};
|
|
11
|
+
export declare function kindOf(facts: ValueFacts): Kind | null;
|
|
12
|
+
export declare function fitsKind(kind: Kind, facts: ValueFacts, value: unknown): boolean;
|
|
13
|
+
export declare function kindWords(facts: ValueFacts | undefined): readonly string[];
|
|
14
|
+
export declare function dated(value: unknown): value is string;
|
|
15
|
+
export declare function instant(value: unknown): bigint | undefined;
|
|
16
|
+
export declare function instantKey(value: unknown): string | null;
|
|
17
|
+
export declare function byCodePoint(left: string, right: string): number;
|
|
18
|
+
export declare function compared(left: unknown, right: unknown, ordering: Ordering): number;
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
export declare const PATTERN_STATES = 1000;
|
|
2
|
+
export declare class PatternTooCostly extends Error {
|
|
3
|
+
}
|
|
4
|
+
export type Pattern = {
|
|
5
|
+
readonly test: (text: string) => boolean;
|
|
6
|
+
};
|
|
7
|
+
export declare function linearPattern(source: string): Pattern | null;
|
|
8
|
+
export declare function withLinearRegExp<T>(run: () => T): T;
|
|
9
|
+
export declare function openPatternBudget(): () => void;
|