@agentshouse/app-bridge 0.1.0-cfb5ca35059bb → 0.1.0-cfbb2e428ff88

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.
Files changed (41) hide show
  1. package/README.md +4 -4
  2. package/dist/index.d.ts +56 -36
  3. package/dist/mdmodel/definition.d.ts +1 -1
  4. package/dist/mdmodel/event.d.ts +77 -0
  5. package/dist/mdmodel/facts.d.ts +14 -0
  6. package/dist/mdmodel/index.d.ts +17 -5
  7. package/dist/mdmodel/kinds.d.ts +18 -0
  8. package/dist/mdmodel/query/language.d.ts +222 -0
  9. package/dist/mdmodel/query/match.d.ts +13 -0
  10. package/dist/mdmodel/query/rows.d.ts +31 -0
  11. package/dist/mdmodel/query/sql.d.ts +38 -0
  12. package/dist/mdmodel/reserved.d.ts +4 -0
  13. package/dist/mdmodel/types.d.ts +7 -0
  14. package/dist/mdmodel/validate.d.ts +4 -3
  15. package/dist/mdruntime/adapter.d.ts +25 -9
  16. package/dist/mdruntime/chain.d.ts +2 -1
  17. package/dist/mdruntime/client.d.ts +8 -3
  18. package/dist/mdruntime/collection.d.ts +2 -1
  19. package/dist/mdruntime/compile.d.ts +1 -6
  20. package/dist/mdruntime/connection.d.ts +8 -6
  21. package/dist/mdruntime/conversation.d.ts +5 -4
  22. package/dist/mdruntime/durability.d.ts +6 -0
  23. package/dist/mdruntime/identity.d.ts +0 -1
  24. package/dist/mdruntime/messages.d.ts +2 -2
  25. package/dist/mdruntime/model.d.ts +2 -7
  26. package/dist/mdruntime/observation.d.ts +2 -2
  27. package/dist/mdruntime/query.d.ts +3 -208
  28. package/dist/mdruntime/reach.d.ts +6 -6
  29. package/dist/mdruntime/readiness.d.ts +0 -2
  30. package/dist/mdruntime/replica.d.ts +8 -5
  31. package/dist/mdruntime/room-draft.d.ts +4 -3
  32. package/dist/mdruntime/search.d.ts +12 -63
  33. package/dist/mdruntime/store.d.ts +4 -7
  34. package/dist/mdruntime/stored.d.ts +3 -4
  35. package/dist/mdruntime/tables.d.ts +8 -6
  36. package/dist/mdruntime/wire.d.ts +9 -0
  37. package/dist/test-host.js +1 -0
  38. package/docs/families.md +14 -1
  39. package/package.json +1 -1
  40. package/dist/mdmodel/condition.d.ts +0 -179
  41. package/dist/mdruntime/fulltext.d.ts +0 -26
package/README.md CHANGED
@@ -3,10 +3,10 @@
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 twelve families: navigation,
7
- ceremonies, installation, notifications, status, Site image reads, App release
8
- code, external calls, App messages, App and Site screenshot reads and the Chat.
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
package/dist/index.d.ts CHANGED
@@ -1,5 +1,20 @@
1
1
  import type { MdRuntimeClient, Open } from './mdruntime/client.js';
2
2
  export interface HouseMethods {
3
+ readonly "agent-functions/requests": {
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
+ };
3
18
  readonly "apps/features/read": {
4
19
  readonly params: {};
5
20
  readonly result: {
@@ -135,7 +150,6 @@ export interface HouseMethods {
135
150
  readonly params: {
136
151
  readonly agent_id: string;
137
152
  readonly operation_id: string;
138
- readonly replaces?: string;
139
153
  };
140
154
  readonly result: {
141
155
  readonly agent_id: string;
@@ -159,17 +173,19 @@ export interface HouseMethods {
159
173
  readonly position: string;
160
174
  };
161
175
  };
162
- readonly "conversations/done": {
176
+ readonly "conversations/end": {
163
177
  readonly params: {
164
- readonly conversation_id?: string;
178
+ readonly conversation_id: string;
165
179
  readonly operation_id: string;
166
- readonly result?: string;
167
180
  };
168
181
  readonly result: {
169
182
  readonly agent_id: string;
170
183
  readonly authority: string;
171
184
  readonly conversation_id: string;
172
- readonly done: null | string;
185
+ readonly jobs: readonly {
186
+ readonly name: string;
187
+ readonly running_since: string;
188
+ }[];
173
189
  readonly log_epoch: string;
174
190
  readonly position: string;
175
191
  readonly url: string;
@@ -234,7 +250,7 @@ export interface HouseMethods {
234
250
  readonly type: "text";
235
251
  })[];
236
252
  readonly role: "assistant" | "house" | "user";
237
- readonly sender?: "conversation" | "customer" | "owner" | "report" | "requester" | "trigger";
253
+ readonly sender?: "conversation" | "customer" | "owner" | "replier" | "report" | "requester" | "trigger";
238
254
  readonly source?: {
239
255
  readonly agent: {
240
256
  readonly id: string;
@@ -250,6 +266,18 @@ export interface HouseMethods {
250
266
  };
251
267
  readonly request: string;
252
268
  readonly room: string;
269
+ } | {
270
+ readonly agent: {
271
+ readonly id: string;
272
+ readonly name: string;
273
+ readonly url: string;
274
+ };
275
+ readonly conversation: {
276
+ readonly id: string;
277
+ readonly name: string;
278
+ readonly url: string;
279
+ };
280
+ readonly kind: "conversation";
253
281
  } | {
254
282
  readonly agent: {
255
283
  readonly id: string;
@@ -263,6 +291,11 @@ export interface HouseMethods {
263
291
  };
264
292
  readonly request: string;
265
293
  } | {
294
+ readonly agent_function: null | {
295
+ readonly id: string;
296
+ readonly name: string;
297
+ readonly version: number;
298
+ };
266
299
  readonly approved_at: null | string;
267
300
  readonly kind: "request";
268
301
  readonly request: string;
@@ -280,11 +313,9 @@ export interface HouseMethods {
280
313
  readonly ref: string;
281
314
  readonly url: string;
282
315
  };
283
- readonly routine: null | {
284
- readonly id: string;
285
- readonly name: string;
286
- readonly version: number;
287
- };
316
+ } | {
317
+ readonly kind: "reply";
318
+ readonly name: string;
288
319
  } | {
289
320
  readonly kind: "trigger";
290
321
  readonly path: null | string;
@@ -430,13 +461,10 @@ export interface HouseMethods {
430
461
  };
431
462
  readonly "records/read": {
432
463
  readonly params: {
433
- readonly cursor?: string;
434
- readonly limit?: number;
435
464
  readonly order?: "asc" | "desc";
436
465
  readonly room_ref: string;
437
466
  };
438
467
  readonly result: {
439
- readonly next_cursor?: string;
440
468
  readonly records: readonly {
441
469
  readonly body: null | string;
442
470
  readonly claimed: unknown;
@@ -494,9 +522,7 @@ export interface HouseMethods {
494
522
  };
495
523
  readonly "rooms/members": {
496
524
  readonly params: {
497
- readonly cursor?: string;
498
525
  readonly history?: boolean;
499
- readonly limit?: number;
500
526
  readonly room_ref: string;
501
527
  };
502
528
  readonly result: {
@@ -516,7 +542,6 @@ export interface HouseMethods {
516
542
  readonly since: null | string;
517
543
  readonly user: string;
518
544
  }[];
519
- readonly next_cursor?: string;
520
545
  };
521
546
  };
522
547
  readonly "rooms/settings/processing/read": {
@@ -552,21 +577,6 @@ export interface HouseMethods {
552
577
  readonly writable: boolean;
553
578
  };
554
579
  };
555
- readonly "routines/requests": {
556
- readonly params: {
557
- readonly room_ref: string;
558
- };
559
- readonly result: {
560
- readonly current: readonly {
561
- readonly document: string;
562
- readonly name: string;
563
- }[];
564
- readonly history: readonly {
565
- readonly document: string;
566
- readonly name: string;
567
- }[];
568
- };
569
- };
570
580
  readonly "site/submission": {
571
581
  readonly params: {
572
582
  readonly content: string;
@@ -673,13 +683,13 @@ export interface HouseMethods {
673
683
  readonly result: {
674
684
  readonly events: readonly {
675
685
  readonly actions: readonly ({
676
- readonly cap: "address_submissions" | "app_sockets" | "environment_functions" | "export_starts" | "folder_subscriptions" | "kit_connections" | "live_shares" | "open_uploads" | "ownership_offers" | "push_addresses" | "push_deliveries" | "room_triggers" | "service_keys" | "share_creations" | "share_room_creations" | "shared_schemas" | "site_rooms" | "slot_rooms" | "waiting_web_wizards" | "writes";
686
+ 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_rooms" | "slot_rooms" | "spaces" | "waiting_web_wizards" | "writes";
677
687
  readonly code: "cap_reached";
678
688
  readonly outcome: "refused";
679
689
  readonly position: number;
680
690
  readonly retry_at: string;
681
691
  } | {
682
- readonly cap: "address_submissions" | "app_sockets" | "environment_functions" | "export_starts" | "folder_subscriptions" | "kit_connections" | "live_shares" | "open_uploads" | "ownership_offers" | "push_addresses" | "push_deliveries" | "room_triggers" | "service_keys" | "share_creations" | "share_room_creations" | "shared_schemas" | "site_rooms" | "slot_rooms" | "waiting_web_wizards" | "writes";
692
+ 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_rooms" | "slot_rooms" | "spaces" | "waiting_web_wizards" | "writes";
683
693
  readonly code: "cap_reached";
684
694
  readonly outcome: "refused";
685
695
  readonly position: number;
@@ -744,17 +754,21 @@ export interface HouseMethods {
744
754
  readonly outcome: "refused";
745
755
  readonly position: number;
746
756
  } | {
747
- readonly code: "app_function_not_found" | "app_not_found" | "environment_function_not_found" | "environment_offline" | "no_recipient" | "routine_not_found" | "routine_retired" | "target_agent_unavailable";
757
+ 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";
748
758
  readonly outcome: "no_target";
749
759
  readonly position: number;
750
760
  } | {
751
- readonly code: "internal_error" | "routine_request_not_started";
761
+ readonly code: "agent_function_request_not_started" | "internal_error";
752
762
  readonly outcome: "failed";
753
763
  readonly position: number;
754
764
  } | {
755
765
  readonly code: string;
756
766
  readonly outcome: "refused";
757
767
  readonly position: number;
768
+ } | {
769
+ readonly conversations: number;
770
+ readonly outcome: "marked";
771
+ readonly position: number;
758
772
  } | {
759
773
  readonly cut?: boolean;
760
774
  readonly exit_code?: number;
@@ -905,6 +919,11 @@ export interface HouseAppMessage {
905
919
  }
906
920
  export type HouseInstallation = Open<'accepted' | 'dismissed' | 'manual'>;
907
921
  export type HouseNotifications = Open<'on' | 'off' | 'blocked' | 'unavailable'>;
922
+ export interface HouseTelegram {
923
+ readonly state: Open<'available' | 'linked' | 'unavailable'>;
924
+ readonly name: string | null;
925
+ readonly username: string | null;
926
+ }
908
927
  export interface HouseCeremonyRefused extends Error {
909
928
  readonly name: 'HouseCeremonyRefused';
910
929
  readonly code: Open<'house_ceremony_refused'>;
@@ -954,6 +973,7 @@ export interface HouseBridge {
954
973
  ceremony(path: string): Promise<never>;
955
974
  install(): Promise<HouseInstallation>;
956
975
  notifications(on?: boolean): Promise<HouseNotifications>;
976
+ telegram(link?: true): Promise<HouseTelegram>;
957
977
  setBadge(unread: readonly string[]): Promise<void>;
958
978
  setTab(tab: HouseTab): void;
959
979
  sourceTop(app: string, release?: string): Promise<HouseSourceTop | 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;
@@ -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, 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, content: string, model: VerifiedModel): SavedFacts | null;
@@ -1,20 +1,32 @@
1
- export { ACTOR_PATHS, actorOperators, changeFields, CONDITION_OPERATORS, dated, datePointers, DOCUMENT_PATHS, factKind, facts, fires, holds, instant, ITEM_PATHS, itemFires, itemKind, itemOperators, memberPointers, members, MESSAGE_PATHS, messageFires, messageOperators, notificationFires, pointed, prosePaths, testOperators, TEXT_FIELD, valuedChange, WRITE_DOORS, } from './condition.js';
2
- export type { Actor, Condition, ConditionOperator, ConditionScope, ConditionTest, ConditionValue, CronCondition, DateCondition, DocumentCondition, DocumentEvent, DocumentFacts, Fact, FactKind, ItemCondition, ItemFacts, MessageCondition, MessageFacts, NotificationCondition, Resolved, WriteDoor, } from './condition.js';
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, GroupQuery, 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
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';
9
20
  export type { RoomTarget } from './paths.js';
10
21
  export { MARKDOWN_SYNTAX_PROFILE } from './profile.js';
11
22
  export { project } from './project.js';
12
23
  export { references } from './references.js';
24
+ export { isDocumentPath, isReservedName, RESERVED_NAMES, ROOM_DESCRIPTION } from './reserved.js';
13
25
  export { ARRAY_INDEX, ATTACHMENT, crossedFacts, escapePointer, itemFacts, JSON_POINTER, memberFacts, pointerFacts, pointerSegments, } from './definition.js';
14
26
  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, ParseResult, Projection, ProjectionContext, Reached, Reference, Refusal, RoomReference, Span, Validation, ValidationContext, ValidationStep, VerifiedModel, } from './types.js';
16
- export { assess, bodyRoomLinks, checkDocument, resolves, roomReferences, sectionReferences, validate, validating, verdicts, verify, } from './validate.js';
27
+ 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';
28
+ export { assess, bodyRoomLinks, checkDocument, readTypes, resolves, roomReferences, validate, validating, verdicts, verify, } from './validate.js';
17
29
  export type { Assessment, Verdicts } from './validate.js';
18
30
  export { VERSION } from './version.js';
19
- export { bodyAfterFrontmatter, equalValue, frontmatterValue } from './yaml.js';
31
+ export { bodyAfterFrontmatter, equalValue, frontmatterValue, plain } from './yaml.js';
20
32
  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,222 @@
1
+ import { type Definition } from '../definition.js';
2
+ export type Value = string | number | boolean | null;
3
+ export type Predicate = Value | {
4
+ $eq: Value;
5
+ } | {
6
+ $ne: Value;
7
+ } | {
8
+ $in: readonly Value[];
9
+ } | {
10
+ $nin: readonly Value[];
11
+ } | {
12
+ $gt?: Value;
13
+ $gte?: Value;
14
+ $lt?: Value;
15
+ $lte?: Value;
16
+ } | {
17
+ $all: readonly Value[];
18
+ } | {
19
+ $size: number;
20
+ } | {
21
+ $exists: boolean;
22
+ } | {
23
+ $prefix: string;
24
+ };
25
+ export type Where = {
26
+ $and?: readonly Where[];
27
+ $or?: readonly Where[];
28
+ [field: string]: Predicate | readonly Where[] | undefined;
29
+ };
30
+ export type Related = {
31
+ types?: readonly string[];
32
+ where?: Where;
33
+ pathPrefix?: string;
34
+ };
35
+ export type Filter = {
36
+ rooms?: readonly string[];
37
+ types?: readonly string[];
38
+ where?: Where;
39
+ pathPrefix?: string;
40
+ folder?: string;
41
+ paths?: readonly string[];
42
+ fileIds?: readonly string[];
43
+ hop?: Related & {
44
+ field: string;
45
+ };
46
+ backlinks?: Related & {
47
+ field?: string;
48
+ };
49
+ text?: string;
50
+ };
51
+ export type Key = 'room' | 'path' | 'type' | 'folder' | {
52
+ field: string;
53
+ };
54
+ export type Select = 'all' | {
55
+ fields?: 'all' | readonly string[];
56
+ sections?: 'all' | readonly string[];
57
+ preamble?: true;
58
+ markdown?: true;
59
+ backlinks?: true;
60
+ change?: true;
61
+ fileId?: true;
62
+ revision?: true;
63
+ };
64
+ export type OrderOptions = {
65
+ nulls?: 'first' | 'last';
66
+ stringSort?: 'lexical' | 'locale';
67
+ locale?: string;
68
+ localeOptions?: Readonly<Record<string, unknown>>;
69
+ };
70
+ export type Direction = 'asc' | 'desc';
71
+ export type DocumentQuery = Filter & {
72
+ select: Select;
73
+ orderBy?: readonly ({
74
+ by: Key;
75
+ direction?: Direction;
76
+ } & OrderOptions)[];
77
+ limit?: number;
78
+ after?: string;
79
+ total?: true;
80
+ };
81
+ export type GroupQuery = Filter & {
82
+ groupBy: readonly Exclude<Key, 'path'>[];
83
+ orderBy?: readonly {
84
+ by: 'count' | Exclude<Key, 'path'>;
85
+ direction?: Direction;
86
+ }[];
87
+ limit?: number;
88
+ after?: string;
89
+ total?: true;
90
+ };
91
+ export type LocalQuery = DocumentQuery | GroupQuery;
92
+ export type QueryErrorCode = 'invalid-query' | 'unknown-type' | 'unknown-field' | 'wrong-kind';
93
+ export type RoomFacts = {
94
+ locator: string;
95
+ available: boolean;
96
+ types: readonly Definition[];
97
+ };
98
+ export type HeldRooms = {
99
+ listed: boolean;
100
+ rooms: readonly RoomFacts[];
101
+ };
102
+ export type Test = {
103
+ op: 'eq';
104
+ value: Value;
105
+ } | {
106
+ op: 'ne';
107
+ value: Value;
108
+ } | {
109
+ op: 'in';
110
+ values: readonly Value[];
111
+ } | {
112
+ op: 'nin';
113
+ values: readonly Value[];
114
+ } | {
115
+ op: 'range';
116
+ bounds: readonly (readonly ['gt' | 'gte' | 'lt' | 'lte', Value])[];
117
+ } | {
118
+ op: 'all';
119
+ values: readonly Value[];
120
+ } | {
121
+ op: 'size';
122
+ size: number;
123
+ } | {
124
+ op: 'exists';
125
+ exists: boolean;
126
+ } | {
127
+ op: 'prefix';
128
+ prefix: string;
129
+ };
130
+ export type Clause = {
131
+ every: readonly Clause[];
132
+ } | {
133
+ some: readonly Clause[];
134
+ } | {
135
+ field: string;
136
+ test: Test;
137
+ };
138
+ export type Scope = {
139
+ types: readonly string[] | null;
140
+ where: Clause | null;
141
+ pathPrefix: string | null;
142
+ };
143
+ export type KeyPlan = {
144
+ of: 'room';
145
+ } | {
146
+ of: 'path';
147
+ } | {
148
+ of: 'type';
149
+ } | {
150
+ of: 'folder';
151
+ } | {
152
+ of: 'field';
153
+ field: string;
154
+ };
155
+ export type DocumentShape = {
156
+ kind: 'documents';
157
+ fields: 'all' | readonly string[] | null;
158
+ sections: 'all' | readonly string[] | null;
159
+ preamble: boolean;
160
+ markdown: boolean;
161
+ backlinks: boolean;
162
+ change: boolean;
163
+ fileId: boolean;
164
+ revision: boolean;
165
+ orderBy: readonly {
166
+ key: KeyPlan;
167
+ options: OrderOptions & {
168
+ direction: Direction;
169
+ };
170
+ }[];
171
+ };
172
+ export type GroupShape = {
173
+ kind: 'groups';
174
+ groupBy: readonly KeyPlan[];
175
+ orderBy: readonly {
176
+ by: 'count' | number;
177
+ direction: Direction;
178
+ }[];
179
+ };
180
+ export type Continuation = {
181
+ text: string;
182
+ values: readonly unknown[] | null;
183
+ };
184
+ export type QueryPlan = {
185
+ key: string;
186
+ rooms: readonly string[] | null;
187
+ root: Scope;
188
+ folder: string | null;
189
+ paths: readonly string[] | null;
190
+ fileIds: readonly string[] | null;
191
+ hop: (Scope & {
192
+ field: string;
193
+ }) | null;
194
+ backlinks: (Scope & {
195
+ field: string | null;
196
+ }) | null;
197
+ text: string | null;
198
+ shape: DocumentShape | GroupShape;
199
+ limit: number | null;
200
+ after: Continuation | null;
201
+ total: boolean;
202
+ };
203
+ export type Place = readonly (string | number)[];
204
+ type At = Place | string;
205
+ export declare class QueryError extends Error {
206
+ readonly code: QueryErrorCode;
207
+ readonly place: Place;
208
+ readonly accepts: readonly string[];
209
+ readonly retryable = false;
210
+ constructor(code: QueryErrorCode, at: At, problem: string, accepts?: readonly string[]);
211
+ }
212
+ type Entries = Readonly<Record<string, unknown>>;
213
+ export declare function bodied(shape: DocumentShape): boolean;
214
+ export declare function invalid(at: At, problem: string, accepts?: readonly string[]): never;
215
+ export declare function placeText(at: Place): string;
216
+ export declare function known(value: Entries, allowed: readonly string[], at: At): void;
217
+ export declare function planOf(input: unknown, facts: HeldRooms): QueryPlan;
218
+ export declare function cursorOf(values: readonly unknown[]): string;
219
+ export declare function decodedCursor(text: string): readonly unknown[] | null;
220
+ export declare function queryKey(query: unknown): string;
221
+ export declare function identityOf(plan: QueryPlan): string;
222
+ export {};
@@ -0,0 +1,13 @@
1
+ import type { Definition } from '../definition.js';
2
+ import { type QueryPlan } from './language.js';
3
+ import { type HeldValue } from './rows.js';
4
+ export type Candidate = {
5
+ readonly path: string;
6
+ readonly type: string | null;
7
+ readonly fileId: string | null;
8
+ readonly fields: Readonly<Record<string, unknown>>;
9
+ readonly definition?: Pick<Definition, 'frontmatter'>;
10
+ readonly text: string | null;
11
+ };
12
+ export declare function heldAt(candidate: Candidate, field: string): readonly HeldValue[];
13
+ export declare function matches(plan: QueryPlan, candidate: Candidate): boolean;
@@ -0,0 +1,31 @@
1
+ import { type Definition } from '../definition.js';
2
+ export type HeldKind = 'string' | 'number' | 'boolean' | 'null' | 'array' | 'object' | 'undefined';
3
+ export type HeldValue = {
4
+ readonly keys: string;
5
+ readonly places: string;
6
+ readonly item: number;
7
+ readonly kind: HeldKind;
8
+ readonly value: string | number | null;
9
+ readonly size: number | null;
10
+ readonly instant: string | null;
11
+ };
12
+ export type HeldLink = {
13
+ readonly kind: 'field';
14
+ readonly keys: string;
15
+ readonly places: string;
16
+ readonly target: string;
17
+ readonly field: string;
18
+ };
19
+ export type Indexed = {
20
+ readonly values: readonly HeldValue[];
21
+ readonly links: readonly HeldLink[];
22
+ };
23
+ export type Reach = 'exact' | 'value' | 'link';
24
+ export type Placed = {
25
+ readonly keys: string;
26
+ readonly places: string;
27
+ readonly glob: boolean;
28
+ };
29
+ export declare function placedOf(pointer: string, reach: Reach): Placed;
30
+ export declare function heldKind(value: unknown): HeldKind;
31
+ export declare function indexed(path: string, fields: Readonly<Record<string, unknown>>, definition: Pick<Definition, 'frontmatter'> | undefined): Indexed;