@littlebigbrain/client 0.4.1 → 0.4.2

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 (2) hide show
  1. package/dist/schema.d.ts +468 -0
  2. package/package.json +1 -1
package/dist/schema.d.ts CHANGED
@@ -429,6 +429,41 @@ export interface paths {
429
429
  patch?: never;
430
430
  trace?: never;
431
431
  };
432
+ "/v1/graph/export": {
433
+ parameters: {
434
+ query?: never;
435
+ header?: never;
436
+ path?: never;
437
+ cookie?: never;
438
+ };
439
+ /** Stream a full-fidelity NDJSON export (inverse of /v1/graph/import): a kind-tagged meta header (with the source ontology), then entity and edge lines that reconstruct an equivalent graph on re-import. Paginated via meta.next_cursor echoed as ?cursor= */
440
+ get: operations["get_v1_graph_export"];
441
+ put?: never;
442
+ post?: never;
443
+ delete?: never;
444
+ options?: never;
445
+ head?: never;
446
+ patch?: never;
447
+ trace?: never;
448
+ };
449
+ "/v1/graph/export/job": {
450
+ parameters: {
451
+ query?: never;
452
+ header?: never;
453
+ path?: never;
454
+ cookie?: never;
455
+ };
456
+ /** Poll an enqueued background export job by ?job_id= (scoped to the requesting tenant) */
457
+ get: operations["get_v1_graph_export_job"];
458
+ put?: never;
459
+ /** Enqueue a background full-fidelity export for a large tenant; writes zstd NDJSON parts + a manifest under tenants/<tenant>/exports/<id>/. Returns the job id; poll with GET /v1/graph/export/job?job_id= */
460
+ post: operations["post_v1_graph_export_job"];
461
+ delete?: never;
462
+ options?: never;
463
+ head?: never;
464
+ patch?: never;
465
+ trace?: never;
466
+ };
432
467
  "/v1/graph/export/rdf": {
433
468
  parameters: {
434
469
  query?: never;
@@ -6876,6 +6911,19 @@ export interface components {
6876
6911
  * `GET /v1/graph/metadata` and on the entity read's metadata.
6877
6912
  */
6878
6913
  compacted_seq: components["schemas"]["CommitSeq"];
6914
+ /**
6915
+ * @description F2 (roadmap 18.3): true when this snapshot was served from the in-memory
6916
+ * cache while storage was degraded and the latest head could not be
6917
+ * verified — so `commit_seq` may not be the current head. Absent (false) on
6918
+ * every normal read; writes never serve stale. Omitted from the wire form
6919
+ * when false so healthy responses are byte-identical to before.
6920
+ */
6921
+ stale?: boolean;
6922
+ /**
6923
+ * @description The reason a read is `stale` (F2). `"storage_degraded"` today; omitted
6924
+ * when not stale.
6925
+ */
6926
+ stale_reason?: string | null;
6879
6927
  };
6880
6928
  /**
6881
6929
  * @description One aggregate projection: `func(operand) AS as_var`. `operand` is absent for
@@ -11453,6 +11501,426 @@ export interface operations {
11453
11501
  };
11454
11502
  };
11455
11503
  };
11504
+ get_v1_graph_export: {
11505
+ parameters: {
11506
+ query?: {
11507
+ /** @description Graph name (default `main`) */
11508
+ graph?: string;
11509
+ /** @description Branch name (default `main`) */
11510
+ branch?: string;
11511
+ /** @description Records (entity+edge lines) per page (default 1000, clamped 1-50000) */
11512
+ limit?: string;
11513
+ /** @description Opaque page cursor from a prior page's meta.next_cursor; pins the snapshot across pages */
11514
+ cursor?: string;
11515
+ /** @description Pin the export to a past snapshot commit_seq (first page only) */
11516
+ as_of_commit_seq?: string;
11517
+ };
11518
+ header?: {
11519
+ /** @description API contract version to pin. Use `2026-06-22` for this beta-breaking shape. */
11520
+ "Lbb-Version"?: string;
11521
+ };
11522
+ path?: never;
11523
+ cookie?: never;
11524
+ };
11525
+ requestBody?: never;
11526
+ responses: {
11527
+ /** @description OK */
11528
+ 200: {
11529
+ headers: {
11530
+ /** @description API contract version used for the response */
11531
+ "Lbb-Version"?: string;
11532
+ /** @description Request correlation id */
11533
+ "X-Request-Id"?: string;
11534
+ [name: string]: unknown;
11535
+ };
11536
+ content: {
11537
+ "application/json": Record<string, never>;
11538
+ };
11539
+ };
11540
+ /** @description Bad request */
11541
+ 400: {
11542
+ headers: {
11543
+ /** @description API contract version used for the response */
11544
+ "Lbb-Version"?: string;
11545
+ /** @description Request correlation id */
11546
+ "X-Request-Id"?: string;
11547
+ [name: string]: unknown;
11548
+ };
11549
+ content: {
11550
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11551
+ };
11552
+ };
11553
+ /** @description Unauthorized */
11554
+ 401: {
11555
+ headers: {
11556
+ /** @description API contract version used for the response */
11557
+ "Lbb-Version"?: string;
11558
+ /** @description Request correlation id */
11559
+ "X-Request-Id"?: string;
11560
+ [name: string]: unknown;
11561
+ };
11562
+ content: {
11563
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11564
+ };
11565
+ };
11566
+ /** @description Forbidden */
11567
+ 403: {
11568
+ headers: {
11569
+ /** @description API contract version used for the response */
11570
+ "Lbb-Version"?: string;
11571
+ /** @description Request correlation id */
11572
+ "X-Request-Id"?: string;
11573
+ [name: string]: unknown;
11574
+ };
11575
+ content: {
11576
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11577
+ };
11578
+ };
11579
+ /** @description Not found */
11580
+ 404: {
11581
+ headers: {
11582
+ /** @description API contract version used for the response */
11583
+ "Lbb-Version"?: string;
11584
+ /** @description Request correlation id */
11585
+ "X-Request-Id"?: string;
11586
+ [name: string]: unknown;
11587
+ };
11588
+ content: {
11589
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11590
+ };
11591
+ };
11592
+ /** @description Conflict */
11593
+ 409: {
11594
+ headers: {
11595
+ /** @description API contract version used for the response */
11596
+ "Lbb-Version"?: string;
11597
+ /** @description Request correlation id */
11598
+ "X-Request-Id"?: string;
11599
+ [name: string]: unknown;
11600
+ };
11601
+ content: {
11602
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11603
+ };
11604
+ };
11605
+ /** @description Rate limit exceeded */
11606
+ 429: {
11607
+ headers: {
11608
+ /** @description API contract version used for the response */
11609
+ "Lbb-Version"?: string;
11610
+ /** @description Request correlation id */
11611
+ "X-Request-Id"?: string;
11612
+ [name: string]: unknown;
11613
+ };
11614
+ content: {
11615
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11616
+ };
11617
+ };
11618
+ /** @description Internal server error */
11619
+ 500: {
11620
+ headers: {
11621
+ /** @description API contract version used for the response */
11622
+ "Lbb-Version"?: string;
11623
+ /** @description Request correlation id */
11624
+ "X-Request-Id"?: string;
11625
+ [name: string]: unknown;
11626
+ };
11627
+ content: {
11628
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11629
+ };
11630
+ };
11631
+ /** @description Service unavailable */
11632
+ 503: {
11633
+ headers: {
11634
+ /** @description API contract version used for the response */
11635
+ "Lbb-Version"?: string;
11636
+ /** @description Request correlation id */
11637
+ "X-Request-Id"?: string;
11638
+ [name: string]: unknown;
11639
+ };
11640
+ content: {
11641
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11642
+ };
11643
+ };
11644
+ };
11645
+ };
11646
+ get_v1_graph_export_job: {
11647
+ parameters: {
11648
+ query?: {
11649
+ /** @description Graph name (default `main`) */
11650
+ graph?: string;
11651
+ /** @description Branch name (default `main`) */
11652
+ branch?: string;
11653
+ /** @description The export job id returned by the enqueue call */
11654
+ job_id?: string;
11655
+ };
11656
+ header?: {
11657
+ /** @description API contract version to pin. Use `2026-06-22` for this beta-breaking shape. */
11658
+ "Lbb-Version"?: string;
11659
+ };
11660
+ path?: never;
11661
+ cookie?: never;
11662
+ };
11663
+ requestBody?: never;
11664
+ responses: {
11665
+ /** @description OK */
11666
+ 200: {
11667
+ headers: {
11668
+ /** @description API contract version used for the response */
11669
+ "Lbb-Version"?: string;
11670
+ /** @description Request correlation id */
11671
+ "X-Request-Id"?: string;
11672
+ [name: string]: unknown;
11673
+ };
11674
+ content: {
11675
+ "application/json": Record<string, never>;
11676
+ };
11677
+ };
11678
+ /** @description Bad request */
11679
+ 400: {
11680
+ headers: {
11681
+ /** @description API contract version used for the response */
11682
+ "Lbb-Version"?: string;
11683
+ /** @description Request correlation id */
11684
+ "X-Request-Id"?: string;
11685
+ [name: string]: unknown;
11686
+ };
11687
+ content: {
11688
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11689
+ };
11690
+ };
11691
+ /** @description Unauthorized */
11692
+ 401: {
11693
+ headers: {
11694
+ /** @description API contract version used for the response */
11695
+ "Lbb-Version"?: string;
11696
+ /** @description Request correlation id */
11697
+ "X-Request-Id"?: string;
11698
+ [name: string]: unknown;
11699
+ };
11700
+ content: {
11701
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11702
+ };
11703
+ };
11704
+ /** @description Forbidden */
11705
+ 403: {
11706
+ headers: {
11707
+ /** @description API contract version used for the response */
11708
+ "Lbb-Version"?: string;
11709
+ /** @description Request correlation id */
11710
+ "X-Request-Id"?: string;
11711
+ [name: string]: unknown;
11712
+ };
11713
+ content: {
11714
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11715
+ };
11716
+ };
11717
+ /** @description Not found */
11718
+ 404: {
11719
+ headers: {
11720
+ /** @description API contract version used for the response */
11721
+ "Lbb-Version"?: string;
11722
+ /** @description Request correlation id */
11723
+ "X-Request-Id"?: string;
11724
+ [name: string]: unknown;
11725
+ };
11726
+ content: {
11727
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11728
+ };
11729
+ };
11730
+ /** @description Conflict */
11731
+ 409: {
11732
+ headers: {
11733
+ /** @description API contract version used for the response */
11734
+ "Lbb-Version"?: string;
11735
+ /** @description Request correlation id */
11736
+ "X-Request-Id"?: string;
11737
+ [name: string]: unknown;
11738
+ };
11739
+ content: {
11740
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11741
+ };
11742
+ };
11743
+ /** @description Rate limit exceeded */
11744
+ 429: {
11745
+ headers: {
11746
+ /** @description API contract version used for the response */
11747
+ "Lbb-Version"?: string;
11748
+ /** @description Request correlation id */
11749
+ "X-Request-Id"?: string;
11750
+ [name: string]: unknown;
11751
+ };
11752
+ content: {
11753
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11754
+ };
11755
+ };
11756
+ /** @description Internal server error */
11757
+ 500: {
11758
+ headers: {
11759
+ /** @description API contract version used for the response */
11760
+ "Lbb-Version"?: string;
11761
+ /** @description Request correlation id */
11762
+ "X-Request-Id"?: string;
11763
+ [name: string]: unknown;
11764
+ };
11765
+ content: {
11766
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11767
+ };
11768
+ };
11769
+ /** @description Service unavailable */
11770
+ 503: {
11771
+ headers: {
11772
+ /** @description API contract version used for the response */
11773
+ "Lbb-Version"?: string;
11774
+ /** @description Request correlation id */
11775
+ "X-Request-Id"?: string;
11776
+ [name: string]: unknown;
11777
+ };
11778
+ content: {
11779
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11780
+ };
11781
+ };
11782
+ };
11783
+ };
11784
+ post_v1_graph_export_job: {
11785
+ parameters: {
11786
+ query?: {
11787
+ /** @description Graph name (default `main`) */
11788
+ graph?: string;
11789
+ /** @description Branch name (default `main`) */
11790
+ branch?: string;
11791
+ /** @description Pin the export to a past snapshot commit_seq */
11792
+ as_of_commit_seq?: string;
11793
+ };
11794
+ header?: {
11795
+ /** @description API contract version to pin. Use `2026-06-22` for this beta-breaking shape. */
11796
+ "Lbb-Version"?: string;
11797
+ /** @description Stable client-generated key for safely retrying mutations. Required for fact commits. */
11798
+ "Idempotency-Key"?: string;
11799
+ };
11800
+ path?: never;
11801
+ cookie?: never;
11802
+ };
11803
+ requestBody?: never;
11804
+ responses: {
11805
+ /** @description OK */
11806
+ 200: {
11807
+ headers: {
11808
+ /** @description API contract version used for the response */
11809
+ "Lbb-Version"?: string;
11810
+ /** @description Request correlation id */
11811
+ "X-Request-Id"?: string;
11812
+ [name: string]: unknown;
11813
+ };
11814
+ content: {
11815
+ "application/json": Record<string, never>;
11816
+ };
11817
+ };
11818
+ /** @description Bad request */
11819
+ 400: {
11820
+ headers: {
11821
+ /** @description API contract version used for the response */
11822
+ "Lbb-Version"?: string;
11823
+ /** @description Request correlation id */
11824
+ "X-Request-Id"?: string;
11825
+ [name: string]: unknown;
11826
+ };
11827
+ content: {
11828
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11829
+ };
11830
+ };
11831
+ /** @description Unauthorized */
11832
+ 401: {
11833
+ headers: {
11834
+ /** @description API contract version used for the response */
11835
+ "Lbb-Version"?: string;
11836
+ /** @description Request correlation id */
11837
+ "X-Request-Id"?: string;
11838
+ [name: string]: unknown;
11839
+ };
11840
+ content: {
11841
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11842
+ };
11843
+ };
11844
+ /** @description Forbidden */
11845
+ 403: {
11846
+ headers: {
11847
+ /** @description API contract version used for the response */
11848
+ "Lbb-Version"?: string;
11849
+ /** @description Request correlation id */
11850
+ "X-Request-Id"?: string;
11851
+ [name: string]: unknown;
11852
+ };
11853
+ content: {
11854
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11855
+ };
11856
+ };
11857
+ /** @description Not found */
11858
+ 404: {
11859
+ headers: {
11860
+ /** @description API contract version used for the response */
11861
+ "Lbb-Version"?: string;
11862
+ /** @description Request correlation id */
11863
+ "X-Request-Id"?: string;
11864
+ [name: string]: unknown;
11865
+ };
11866
+ content: {
11867
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11868
+ };
11869
+ };
11870
+ /** @description Conflict */
11871
+ 409: {
11872
+ headers: {
11873
+ /** @description API contract version used for the response */
11874
+ "Lbb-Version"?: string;
11875
+ /** @description Request correlation id */
11876
+ "X-Request-Id"?: string;
11877
+ [name: string]: unknown;
11878
+ };
11879
+ content: {
11880
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11881
+ };
11882
+ };
11883
+ /** @description Rate limit exceeded */
11884
+ 429: {
11885
+ headers: {
11886
+ /** @description API contract version used for the response */
11887
+ "Lbb-Version"?: string;
11888
+ /** @description Request correlation id */
11889
+ "X-Request-Id"?: string;
11890
+ [name: string]: unknown;
11891
+ };
11892
+ content: {
11893
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11894
+ };
11895
+ };
11896
+ /** @description Internal server error */
11897
+ 500: {
11898
+ headers: {
11899
+ /** @description API contract version used for the response */
11900
+ "Lbb-Version"?: string;
11901
+ /** @description Request correlation id */
11902
+ "X-Request-Id"?: string;
11903
+ [name: string]: unknown;
11904
+ };
11905
+ content: {
11906
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11907
+ };
11908
+ };
11909
+ /** @description Service unavailable */
11910
+ 503: {
11911
+ headers: {
11912
+ /** @description API contract version used for the response */
11913
+ "Lbb-Version"?: string;
11914
+ /** @description Request correlation id */
11915
+ "X-Request-Id"?: string;
11916
+ [name: string]: unknown;
11917
+ };
11918
+ content: {
11919
+ "application/json": components["schemas"]["LbbErrorEnvelope"];
11920
+ };
11921
+ };
11922
+ };
11923
+ };
11456
11924
  get_v1_graph_export_rdf: {
11457
11925
  parameters: {
11458
11926
  query?: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@littlebigbrain/client",
3
- "version": "0.4.1",
3
+ "version": "0.4.2",
4
4
  "description": "TypeScript client for the little big brain graph + hybrid search HTTP API",
5
5
  "license": "Apache-2.0",
6
6
  "repository": {