@hydradb/sdk 2.1.3 → 2.1.4

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 (124) hide show
  1. package/dist/api/client/requests/SearchQueryRequest.d.ts +12 -0
  2. package/dist/api/resources/connectors/client/Client.d.ts +22 -1
  3. package/dist/api/resources/connectors/client/Client.js +82 -1
  4. package/dist/api/resources/connectors/client/requests/HandlerConnectorCreateReq.d.ts +6 -0
  5. package/dist/api/resources/connectors/client/requests/HandlerConnectorUpdateReq.d.ts +6 -0
  6. package/dist/api/resources/connectors/client/requests/HandlerResourceCreateReq.d.ts +12 -0
  7. package/dist/api/resources/connectors/client/requests/UpdateResourceAclConnectorsRequest.d.ts +17 -0
  8. package/dist/api/resources/connectors/client/requests/UpdateResourceAclConnectorsRequest.js +3 -0
  9. package/dist/api/resources/connectors/client/requests/index.d.ts +1 -0
  10. package/dist/api/resources/context/client/Client.d.ts +19 -0
  11. package/dist/api/resources/context/client/Client.js +93 -2
  12. package/dist/api/resources/context/client/requests/HandlerContextMetadataUpdateRequest.d.ts +14 -0
  13. package/dist/api/resources/context/client/requests/IngestContextRequest.d.ts +1 -1
  14. package/dist/api/resources/context/client/requests/InspectContextRequest.d.ts +2 -0
  15. package/dist/api/resources/context/client/requests/ListV2ListContentRequest.d.ts +2 -0
  16. package/dist/api/resources/context/client/requests/RelationsContextRequest.d.ts +2 -0
  17. package/dist/api/resources/context/client/requests/SubgraphContextRequest.d.ts +31 -0
  18. package/dist/api/resources/context/client/requests/SubgraphContextRequest.js +3 -0
  19. package/dist/api/resources/context/client/requests/index.d.ts +1 -0
  20. package/dist/api/resources/context/types/SubgraphContextRequestType.d.ts +5 -0
  21. package/dist/api/resources/context/types/SubgraphContextRequestType.js +8 -0
  22. package/dist/api/resources/context/types/index.d.ts +1 -0
  23. package/dist/api/resources/context/types/index.js +1 -0
  24. package/dist/api/resources/webhooks/client/Client.d.ts +19 -0
  25. package/dist/api/resources/webhooks/client/Client.js +80 -0
  26. package/dist/api/resources/webhooks/client/requests/PostWebhooksSupabaseRequest.d.ts +14 -0
  27. package/dist/api/resources/webhooks/client/requests/PostWebhooksSupabaseRequest.js +3 -0
  28. package/dist/api/resources/webhooks/client/requests/index.d.ts +1 -0
  29. package/dist/api/types/ConnectorsResource.d.ts +43 -0
  30. package/dist/api/types/GithubComHydradbHydradbApplicationInternalServiceMetadataEditResult.d.ts +30 -0
  31. package/dist/api/types/GraphEntity.d.ts +12 -0
  32. package/dist/api/types/GraphGraphRelationsResponse.d.ts +23 -0
  33. package/dist/api/types/GraphRelationEvidence.d.ts +8 -0
  34. package/dist/api/types/GraphSourceSubgraphResponse.d.ts +40 -0
  35. package/dist/api/types/GraphSourceSubgraphResponse.js +3 -0
  36. package/dist/api/types/GraphSubgraphSource.d.ts +28 -0
  37. package/dist/api/types/GraphSubgraphSource.js +3 -0
  38. package/dist/api/types/GraphTripletWithEvidence.d.ts +7 -0
  39. package/dist/api/types/HandlerCatalogConnector.d.ts +15 -0
  40. package/dist/api/types/HandlerConnectorApiView.d.ts +15 -0
  41. package/dist/api/types/HandlerConnectorCreateResponse.d.ts +15 -0
  42. package/dist/api/types/HandlerConnectorResourceStatus.d.ts +16 -0
  43. package/dist/api/types/HandlerConnectorUpdateResponse.d.ts +5 -0
  44. package/dist/api/types/HandlerEnvelopeGraphSourceSubgraphResponse.d.ts +9 -0
  45. package/dist/api/types/HandlerEnvelopeGraphSourceSubgraphResponse.js +3 -0
  46. package/dist/api/types/HandlerEnvelopeHandlerSupabaseWebhookAck.d.ts +9 -0
  47. package/dist/api/types/HandlerEnvelopeHandlerSupabaseWebhookAck.js +3 -0
  48. package/dist/api/types/HandlerResourceMapping.d.ts +14 -0
  49. package/dist/api/types/HandlerSupabaseWebhookAck.d.ts +7 -0
  50. package/dist/api/types/HandlerSupabaseWebhookAck.js +3 -0
  51. package/dist/api/types/SearchSourceFact.d.ts +18 -0
  52. package/dist/api/types/SearchSourceFact.js +3 -0
  53. package/dist/api/types/SearchSourceFilterInfo.d.ts +15 -0
  54. package/dist/api/types/SearchSourceFilterInfo.js +3 -0
  55. package/dist/api/types/SearchV2RetrievalResult.d.ts +6 -0
  56. package/dist/api/types/index.d.ts +7 -0
  57. package/dist/api/types/index.js +7 -0
  58. package/dist/serialization/client/requests/SearchQueryRequest.d.ts +1 -0
  59. package/dist/serialization/client/requests/SearchQueryRequest.js +1 -0
  60. package/dist/serialization/resources/connectors/client/index.d.ts +1 -0
  61. package/dist/serialization/resources/connectors/client/index.js +2 -1
  62. package/dist/serialization/resources/connectors/client/requests/HandlerConnectorCreateReq.d.ts +1 -0
  63. package/dist/serialization/resources/connectors/client/requests/HandlerConnectorCreateReq.js +1 -0
  64. package/dist/serialization/resources/connectors/client/requests/HandlerConnectorUpdateReq.d.ts +1 -0
  65. package/dist/serialization/resources/connectors/client/requests/HandlerConnectorUpdateReq.js +1 -0
  66. package/dist/serialization/resources/connectors/client/requests/HandlerResourceCreateReq.d.ts +2 -0
  67. package/dist/serialization/resources/connectors/client/requests/HandlerResourceCreateReq.js +2 -0
  68. package/dist/serialization/resources/connectors/client/updateResourceAcl.d.ts +10 -0
  69. package/dist/serialization/resources/connectors/client/updateResourceAcl.js +40 -0
  70. package/dist/serialization/resources/context/client/requests/HandlerContextMetadataUpdateRequest.d.ts +1 -0
  71. package/dist/serialization/resources/context/client/requests/HandlerContextMetadataUpdateRequest.js +1 -0
  72. package/dist/serialization/resources/context/client/requests/ListV2ListContentRequest.d.ts +1 -0
  73. package/dist/serialization/resources/context/client/requests/ListV2ListContentRequest.js +1 -0
  74. package/dist/serialization/resources/context/types/SubgraphContextRequestType.d.ts +7 -0
  75. package/dist/serialization/resources/context/types/SubgraphContextRequestType.js +39 -0
  76. package/dist/serialization/resources/context/types/index.d.ts +1 -0
  77. package/dist/serialization/resources/context/types/index.js +1 -0
  78. package/dist/serialization/resources/webhooks/client/index.d.ts +1 -0
  79. package/dist/serialization/resources/webhooks/client/index.js +24 -0
  80. package/dist/serialization/resources/webhooks/client/supabaseRowChangeWebhook.d.ts +6 -0
  81. package/dist/serialization/resources/webhooks/client/supabaseRowChangeWebhook.js +39 -0
  82. package/dist/serialization/types/ConnectorsResource.d.ts +6 -0
  83. package/dist/serialization/types/ConnectorsResource.js +6 -0
  84. package/dist/serialization/types/GithubComHydradbHydradbApplicationInternalServiceMetadataEditResult.d.ts +5 -0
  85. package/dist/serialization/types/GithubComHydradbHydradbApplicationInternalServiceMetadataEditResult.js +5 -0
  86. package/dist/serialization/types/GraphEntity.d.ts +1 -0
  87. package/dist/serialization/types/GraphEntity.js +1 -0
  88. package/dist/serialization/types/GraphGraphRelationsResponse.d.ts +2 -0
  89. package/dist/serialization/types/GraphGraphRelationsResponse.js +2 -0
  90. package/dist/serialization/types/GraphRelationEvidence.d.ts +1 -0
  91. package/dist/serialization/types/GraphRelationEvidence.js +1 -0
  92. package/dist/serialization/types/GraphSourceSubgraphResponse.d.ts +19 -0
  93. package/dist/serialization/types/GraphSourceSubgraphResponse.js +51 -0
  94. package/dist/serialization/types/GraphSubgraphSource.d.ts +18 -0
  95. package/dist/serialization/types/GraphSubgraphSource.js +50 -0
  96. package/dist/serialization/types/GraphTripletWithEvidence.d.ts +1 -0
  97. package/dist/serialization/types/GraphTripletWithEvidence.js +1 -0
  98. package/dist/serialization/types/HandlerCatalogConnector.d.ts +3 -0
  99. package/dist/serialization/types/HandlerCatalogConnector.js +3 -0
  100. package/dist/serialization/types/HandlerConnectorApiView.d.ts +2 -0
  101. package/dist/serialization/types/HandlerConnectorApiView.js +2 -0
  102. package/dist/serialization/types/HandlerConnectorCreateResponse.d.ts +2 -0
  103. package/dist/serialization/types/HandlerConnectorCreateResponse.js +2 -0
  104. package/dist/serialization/types/HandlerConnectorResourceStatus.d.ts +4 -0
  105. package/dist/serialization/types/HandlerConnectorResourceStatus.js +4 -0
  106. package/dist/serialization/types/HandlerConnectorUpdateResponse.d.ts +1 -0
  107. package/dist/serialization/types/HandlerConnectorUpdateResponse.js +1 -0
  108. package/dist/serialization/types/HandlerEnvelopeGraphSourceSubgraphResponse.d.ts +15 -0
  109. package/dist/serialization/types/HandlerEnvelopeGraphSourceSubgraphResponse.js +47 -0
  110. package/dist/serialization/types/HandlerEnvelopeHandlerSupabaseWebhookAck.d.ts +15 -0
  111. package/dist/serialization/types/HandlerEnvelopeHandlerSupabaseWebhookAck.js +47 -0
  112. package/dist/serialization/types/HandlerResourceMapping.d.ts +2 -0
  113. package/dist/serialization/types/HandlerResourceMapping.js +2 -0
  114. package/dist/serialization/types/HandlerSupabaseWebhookAck.d.ts +11 -0
  115. package/dist/serialization/types/HandlerSupabaseWebhookAck.js +43 -0
  116. package/dist/serialization/types/SearchSourceFact.d.ts +20 -0
  117. package/dist/serialization/types/SearchSourceFact.js +52 -0
  118. package/dist/serialization/types/SearchSourceFilterInfo.d.ts +17 -0
  119. package/dist/serialization/types/SearchSourceFilterInfo.js +49 -0
  120. package/dist/serialization/types/SearchV2RetrievalResult.d.ts +4 -0
  121. package/dist/serialization/types/SearchV2RetrievalResult.js +4 -0
  122. package/dist/serialization/types/index.d.ts +7 -0
  123. package/dist/serialization/types/index.js +7 -0
  124. package/package.json +1 -1
@@ -0,0 +1,14 @@
1
+ /**
2
+ * @example
3
+ * {
4
+ * hydraDbConnector: "X-HydraDB-Connector",
5
+ * body: {
6
+ * "key": "value"
7
+ * }
8
+ * }
9
+ */
10
+ export interface PostWebhooksSupabaseRequest {
11
+ /** Connector id */
12
+ hydraDbConnector: string;
13
+ body: Record<string, unknown>;
14
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,5 +1,6 @@
1
1
  export type { GetDeliveryWebhooksRequest } from "./GetDeliveryWebhooksRequest.js";
2
2
  export type { ListDeliveriesWebhooksRequest } from "./ListDeliveriesWebhooksRequest.js";
3
+ export type { PostWebhooksSupabaseRequest } from "./PostWebhooksSupabaseRequest.js";
3
4
  export type { RetryDeliveryWebhooksRequest } from "./RetryDeliveryWebhooksRequest.js";
4
5
  export type { WebhooksSigningSecretRequest } from "./WebhooksSigningSecretRequest.js";
5
6
  export type { WebhooksWebhookRegisterRequest } from "./WebhooksWebhookRegisterRequest.js";
@@ -1,4 +1,20 @@
1
1
  export interface ConnectorsResource {
2
+ /**
3
+ * ACL is the customer-declared access-control list stamped onto every
4
+ * object synced from this resource (PRO-1684; see internal/domain/acl).
5
+ * Stored in caller-supplied form and normalized at transform time. nil
6
+ * means no ACL, documents stay unrestricted. Provider-derived ACLs
7
+ * (Phase 2) take precedence over this when the provider supports them.
8
+ */
9
+ acl?: string[];
10
+ /**
11
+ * ACLFingerprint is the stable identity of the ACL last APPLIED to this
12
+ * resource's already-indexed documents (PRO-1684). The sync compares the
13
+ * freshly-resolved provider ACL against it: equal means nothing to do,
14
+ * different means fan the new ACL out to existing documents. Empty means
15
+ * nothing has been applied yet (first capture-enabled sync).
16
+ */
17
+ aclFingerprint?: string;
2
18
  /**
3
19
  * AdditionalMetadata is merged into the additional_metadata (document
4
20
  * metadata) layer of every object synced from this resource. User-supplied
@@ -34,6 +50,14 @@ export interface ConnectorsResource {
34
50
  collectionOverride?: string;
35
51
  /** Connector this resource belongs to. */
36
52
  connectorId?: string;
53
+ /**
54
+ * CustomInstructions is optional free-text ingestion guidance scoped to
55
+ * this resource. When set it replaces the connector-level
56
+ * custom_instructions for documents synced from this resource; empty means
57
+ * the resource inherits the connector's value. Max 4000 characters;
58
+ * changes apply from the next sync cycle.
59
+ */
60
+ customInstructions?: string;
37
61
  /**
38
62
  * DatabaseOverride/CollectionOverride are the canonical v2 names for the
39
63
  * deprecated tenant_id_override/sub_tenant_id_override wire fields. Empty
@@ -66,6 +90,25 @@ export interface ConnectorsResource {
66
90
  status?: string;
67
91
  /** Overrides the connector-level collection for objects synced from this resource. */
68
92
  subTenantIdOverride?: string;
93
+ /**
94
+ * SyncBlocked marks a resource the provider will go on refusing — a table
95
+ * that was dropped, a channel this credential was never invited to.
96
+ *
97
+ * Deliberately not a Status value. Status gates ListConnectorResources,
98
+ * which is what GET /connectors/{id}/status reads, so expressing this as a
99
+ * status would hide the resource from the one endpoint that explains why it
100
+ * stopped. The resource stays active and visible; this only takes it out of
101
+ * what gets synced.
102
+ */
103
+ syncBlocked?: boolean;
104
+ /** SyncBlockedAt is when the resource was stopped (RFC3339). */
105
+ syncBlockedAt?: string;
106
+ /**
107
+ * SyncBlockedReason is the provider's own explanation, carried forward from
108
+ * the health that triggered the block so it survives the next sync
109
+ * overwriting that health.
110
+ */
111
+ syncBlockedReason?: string;
69
112
  /** Overrides the connector-level database for objects synced from this resource. Deprecated. */
70
113
  tenantIdOverride?: string;
71
114
  }
@@ -1,4 +1,13 @@
1
1
  export interface GithubComHydradbHydradbApplicationInternalServiceMetadataEditResult {
2
+ /**
3
+ * ACLDriftRecorded reports that a failed ACL mirror was durably recorded
4
+ * for reconciliation. Always true when vector_acl_synced is true. False
5
+ * beside acl_updated=true and vector_acl_synced=false is the one state
6
+ * the operator must act on (the error log names the document).
7
+ */
8
+ aclDriftRecorded?: boolean;
9
+ /** ACLUpdated reports that this edit replaced the source's ACL (PRO-1684). */
10
+ aclUpdated?: boolean;
2
11
  /** Additional metadata keys included in the update request. */
3
12
  additionalMetadataKeys?: string[];
4
13
  /** Number of MongoDB chunk rows matched by the source update. */
@@ -22,6 +31,12 @@ export interface GithubComHydradbHydradbApplicationInternalServiceMetadataEditRe
22
31
  milvusSyncRequired?: boolean;
23
32
  /** deprecated: use vector_synced */
24
33
  milvusSynced?: boolean;
34
+ /**
35
+ * PartialCommit reports that the edit committed in at least one database
36
+ * of a shared deployment but a later write in another failed; the
37
+ * idempotent retry converges the database that fell behind.
38
+ */
39
+ partialCommit?: string;
25
40
  /** deprecated: use collection */
26
41
  subTenantId?: string;
27
42
  /** deprecated: use database */
@@ -30,8 +45,23 @@ export interface GithubComHydradbHydradbApplicationInternalServiceMetadataEditRe
30
45
  tenantMetadataKeys?: string[];
31
46
  /** Whether the source metadata was updated. */
32
47
  updated?: boolean;
48
+ /**
49
+ * VectorACLSynced reports that the ACL edit also reached the vector rows'
50
+ * pushdown columns (PRO-1740). False with ACLUpdated true means the
51
+ * document's own-ACL projection is stale until its next re-index: still
52
+ * enforced correctly from Mongo, but invisible to the pushdown lane for
53
+ * any principal the edit ADDED. Always false for collections created
54
+ * before PRO-1740, which carry no pushdown columns.
55
+ */
56
+ vectorAclSynced?: boolean;
33
57
  /** Number of chunk rows synced to the vector store when sync was required. */
34
58
  vectorRowsSynced?: number;
59
+ /**
60
+ * VectorSyncError explains a vector_synced=false when a sync was
61
+ * required: the authority (Mongo) committed, the vector metadata did
62
+ * not follow; the idempotent retry converges it.
63
+ */
64
+ vectorSyncError?: string;
35
65
  /**
36
66
  * Vendor-neutral vector-sync signal (PRO-1185): the canonical field must not
37
67
  * name the vector store. The milvus_* fields below are deprecated aliases kept
@@ -1,6 +1,18 @@
1
1
  export interface GraphEntity {
2
2
  /** Unique identifier for this entity in the graph. */
3
3
  entityId?: string;
4
+ /**
5
+ * Hydration is set on Source nodes in AuxiliaryRelations only, and omitted
6
+ * everywhere else. RELATES_TO MERGEs its target by source_id, so a target
7
+ * that has not been ingested yet still exists as a node — callers must be
8
+ * able to tell a real document from a forward reference to one.
9
+ *
10
+ * resolved — ingested; source_id and app_provider both present
11
+ * stub — MERGE-created target; source_id present, no app_provider
12
+ * placeholder — source_id IS NULL, keyed by app_external_id, awaiting
13
+ * builder.py's reconciliation pass
14
+ */
15
+ hydration?: string;
4
16
  /** NO omitempty — serialize as null */
5
17
  identifier?: string;
6
18
  /** Human-readable label for this resource. */
@@ -1,5 +1,28 @@
1
1
  import type * as HydraDB from "../index.js";
2
2
  export interface GraphGraphRelationsResponse {
3
+ /**
4
+ * AuxiliaryRelations carries the structural graph around the entity
5
+ * relations: Entity->Source presence, Source->Comment/Attachment,
6
+ * Actor->Source/Comment, and Source->Source links. Same item shape as
7
+ * Relations, so a caller wanting one graph concatenates the two.
8
+ *
9
+ * Deliberately a SEPARATE array rather than merged into Relations:
10
+ * capPreservingTies counts triplets against the caller's limit, and
11
+ * computeNextCursor keys on relation timestamps. Auxiliary edges carry
12
+ * created_at — a different clock — so merging them would both shrink the
13
+ * entity relations returned for a given limit and corrupt the cursor.
14
+ */
15
+ auxiliaryRelations?: HydraDB.GraphTripletWithEvidence[];
16
+ /**
17
+ * AuxiliaryTruncated reports that an aggregate row ceiling clipped the
18
+ * auxiliary graph. Distinct from the per-triplet Truncated flag, which only
19
+ * covers a single node exceeding its fan-out cap: a wide page can blow the
20
+ * aggregate ceiling with every individual node still under its own cap, and
21
+ * without this the caller would receive a subset presented as complete.
22
+ *
23
+ * Independent of IsTruncated, which describes Relations pagination only.
24
+ */
25
+ auxiliaryTruncated?: boolean;
3
26
  /** Whether the response was truncated due to the result limit. */
4
27
  isTruncated?: boolean;
5
28
  /** Human-readable result message. */
@@ -13,6 +13,14 @@ export interface GraphRelationEvidence {
13
13
  relationshipId?: string;
14
14
  /** NO omitempty */
15
15
  sourceEntityId?: string;
16
+ /**
17
+ * Synthesized marks a triplet with no stored edge behind it. Only
18
+ * `present_in` sets it: that edge is derived by collapsing
19
+ * Entity-PRESENT_IN->Chunk-HAS_CHUNK->Source, so its RelationshipID is a
20
+ * deterministic synthetic id rather than a graph relationship id. Omitted
21
+ * (false) on every stored edge.
22
+ */
23
+ synthesized?: boolean;
16
24
  /** NO omitempty */
17
25
  targetEntityId?: string;
18
26
  /** NO omitempty */
@@ -0,0 +1,40 @@
1
+ import type * as HydraDB from "../index.js";
2
+ export interface GraphSourceSubgraphResponse {
3
+ /**
4
+ * AuxiliaryRelations carries the structural graph around the member
5
+ * sources: Entity->Source presence, Source->Comment/Attachment and
6
+ * Actor->Source/Comment links. Same item shape as Relations, matching
7
+ * GraphRelationsResponse so the dashboard renderer works unchanged.
8
+ */
9
+ auxiliaryRelations?: HydraDB.GraphTripletWithEvidence[];
10
+ /**
11
+ * AuxiliaryTruncated reports that a fetch ceiling clipped the auxiliary
12
+ * graph, same contract as GraphRelationsResponse.AuxiliaryTruncated.
13
+ */
14
+ auxiliaryTruncated?: boolean;
15
+ /**
16
+ * IsTruncated reports that the traversal stopped before exhausting the
17
+ * connected component: the source budget or an edge/expansion fetch cap
18
+ * was hit, or the depth limit left an unexpanded frontier.
19
+ */
20
+ isTruncated?: boolean;
21
+ /** MaxDepthReached is the deepest BFS level that admitted a member. */
22
+ maxDepthReached?: number;
23
+ /** Human-readable result message. */
24
+ message?: string;
25
+ /**
26
+ * Relations holds the Source->Source triplets: every RELATES_TO edge whose
27
+ * endpoints are both members, plus synthesized same_thread / child_of
28
+ * provenance edges for members reached through a node property rather than
29
+ * a stored edge (those carry Synthesized on their evidence).
30
+ */
31
+ relations?: HydraDB.GraphTripletWithEvidence[];
32
+ seedSourceId?: string;
33
+ /**
34
+ * Sources is every member of the subgraph in BFS discovery order, seed
35
+ * first.
36
+ */
37
+ sources?: HydraDB.GraphSubgraphSource[];
38
+ /** Whether the request succeeded. */
39
+ success?: boolean;
40
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,28 @@
1
+ export interface GraphSubgraphSource {
2
+ /** Provider-assigned identifier for this source (e.g. Slack channel ID). */
3
+ appExternalId?: string;
4
+ /** App integration category, populated for connector-synced sources. */
5
+ appKind?: string;
6
+ /** Provider name for app-sourced items (e.g. `slack`, `github`). */
7
+ appProvider?: string;
8
+ /** Depth is the BFS distance from the seed (0 for the seed itself). */
9
+ depth?: number;
10
+ discoveredRelation?: string;
11
+ /**
12
+ * DiscoveredVia and DiscoveredRelation record the traversal provenance:
13
+ * which already-admitted source this member was first reached from, and
14
+ * through which mechanism — a RELATES_TO relation_type (reply_to,
15
+ * child_of, ...), same_thread, parent or child. Empty on the seed.
16
+ */
17
+ discoveredVia?: string;
18
+ /**
19
+ * Hydration carries the same resolved/stub/placeholder classification
20
+ * Entity.Hydration documents: a RELATES_TO target may be a MERGE-created
21
+ * forward reference to a document that has not been ingested yet.
22
+ */
23
+ hydration?: string;
24
+ sourceId?: string;
25
+ threadId?: string;
26
+ /** Title or name of the source. */
27
+ title?: string;
28
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -6,4 +6,11 @@ export interface GraphTripletWithEvidence {
6
6
  relations?: HydraDB.GraphRelationEvidence[];
7
7
  source?: HydraDB.GraphEntity;
8
8
  target?: HydraDB.GraphEntity;
9
+ /**
10
+ * Truncated is set on auxiliary triplets whose fan-out hit a per-node cap,
11
+ * so a caller can tell "this source has no more comments" from "we stopped
12
+ * counting". Omitted (false) on entity relations, which are bounded by the
13
+ * request's own limit/cursor instead.
14
+ */
15
+ truncated?: boolean;
9
16
  }
@@ -7,5 +7,20 @@ export interface HandlerCatalogConnector {
7
7
  provider?: string;
8
8
  /** Rank is the dashboard display order (lower first); null means unranked. */
9
9
  rank?: number;
10
+ rbacDescription?: string;
11
+ /**
12
+ * RBACSupport reports whether document-level ACL capture (PRO-1684) is
13
+ * enabled for this provider (the acl_supported control-plane flag), and
14
+ * RBACDescription says in one sentence WHAT is captured, so the dashboard
15
+ * can explain the capability instead of showing a bare boolean.
16
+ */
17
+ rbacSupport?: boolean;
10
18
  supported?: boolean;
19
+ /**
20
+ * WebhookSupport marks a provider fed by an inbound webhook. The dashboard
21
+ * needs it to pick the credential form: it otherwise reads moveit_support=false
22
+ * as "classic", and renders the single-token form instead of the provider's
23
+ * declared credential schema.
24
+ */
25
+ webhookSupport?: boolean;
11
26
  }
@@ -1,4 +1,13 @@
1
1
  export interface HandlerConnectorApiView {
2
+ /**
3
+ * ACLChangesCursor is the provider permission-change feed's persisted
4
+ * cursor (PRO-1684; e.g. the Drive changes.list page token). Empty means
5
+ * uninitialized: the next cycle fetches a baseline and starts from now.
6
+ * Advanced ONLY after every reported change was applied, so a failed
7
+ * apply replays the same changes next cycle (at-least-once; the writes
8
+ * are idempotent full replacements).
9
+ */
10
+ aclChangesCursor?: string;
2
11
  /**
3
12
  * ActiveResourceCount mirrors the number of non-disabled resource rows so
4
13
  * list responses can distinguish "no resources configured yet"
@@ -11,6 +20,12 @@ export interface HandlerConnectorApiView {
11
20
  collection?: string;
12
21
  /** Connector this resource belongs to. */
13
22
  connectorId?: string;
23
+ /**
24
+ * CustomInstructions is optional free-text guidance applied when this
25
+ * connector's documents are ingested: it steers how content is interpreted
26
+ * and indexed. Max 4000 characters; changes apply from the next sync cycle.
27
+ */
28
+ customInstructions?: string;
14
29
  /**
15
30
  * Database/Collection are the canonical v2 names for the deprecated
16
31
  * tenant_id/sub_tenant_id wire fields. They mirror the same values so a v2
@@ -1,4 +1,13 @@
1
1
  export interface HandlerConnectorCreateResponse {
2
+ /**
3
+ * ACLChangesCursor is the provider permission-change feed's persisted
4
+ * cursor (PRO-1684; e.g. the Drive changes.list page token). Empty means
5
+ * uninitialized: the next cycle fetches a baseline and starts from now.
6
+ * Advanced ONLY after every reported change was applied, so a failed
7
+ * apply replays the same changes next cycle (at-least-once; the writes
8
+ * are idempotent full replacements).
9
+ */
10
+ aclChangesCursor?: string;
2
11
  /**
3
12
  * ActiveResourceCount mirrors the number of non-disabled resource rows so
4
13
  * list responses can distinguish "no resources configured yet"
@@ -11,6 +20,12 @@ export interface HandlerConnectorCreateResponse {
11
20
  collection?: string;
12
21
  /** Connector this resource belongs to. */
13
22
  connectorId?: string;
23
+ /**
24
+ * CustomInstructions is optional free-text guidance applied when this
25
+ * connector's documents are ingested: it steers how content is interpreted
26
+ * and indexed. Max 4000 characters; changes apply from the next sync cycle.
27
+ */
28
+ customInstructions?: string;
14
29
  /**
15
30
  * Database/Collection are the canonical v2 names for the deprecated
16
31
  * tenant_id/sub_tenant_id wire fields. They mirror the same values so a v2
@@ -1,4 +1,6 @@
1
1
  export interface HandlerConnectorResourceStatus {
2
+ /** Action is what the user must do, when there is something they can do. */
3
+ action?: string;
2
4
  checkedAt?: string;
3
5
  /** Human-readable name for this resource. */
4
6
  displayName?: string;
@@ -18,4 +20,18 @@ export interface HandlerConnectorResourceStatus {
18
20
  retryable?: boolean;
19
21
  /** Status is one of ok | empty | failed | checking | unknown. */
20
22
  status?: string;
23
+ /**
24
+ * SyncBlocked reports that this resource has stopped syncing. Distinct from
25
+ * a failed status: a resource can fail a cycle and be retried, and the
26
+ * difference between "failing" and "given up on" is the one a user needs to
27
+ * act on.
28
+ */
29
+ syncBlocked?: boolean;
30
+ /** SyncBlockedAt is when it stopped (RFC3339). */
31
+ syncBlockedAt?: string;
32
+ /**
33
+ * SyncBlockedReason is why it stopped, preserved from the failure that
34
+ * stopped it so it survives later syncs overwriting the health block.
35
+ */
36
+ syncBlockedReason?: string;
21
37
  }
@@ -6,6 +6,11 @@ export interface HandlerConnectorUpdateResponse {
6
6
  * re-written (and any needs-reauth flag cleared) by this request.
7
7
  */
8
8
  credentialsUpdated?: boolean;
9
+ /**
10
+ * CustomInstructionsUpdated reports that the steering text was rewritten
11
+ * (or cleared) by this request; it takes effect from the next sync cycle.
12
+ */
13
+ customInstructionsUpdated?: boolean;
9
14
  /** Largest sync_interval_seconds this connector's provider allows. */
10
15
  maxSyncIntervalSeconds?: number;
11
16
  /** Smallest sync_interval_seconds this connector's provider allows. Values below it are rejected, never clamped. */
@@ -0,0 +1,9 @@
1
+ import type * as HydraDB from "../index.js";
2
+ export interface HandlerEnvelopeGraphSourceSubgraphResponse {
3
+ data?: HydraDB.GraphSourceSubgraphResponse;
4
+ /** Error message, empty string on success. */
5
+ error?: HydraDB.HandlerApiError;
6
+ meta?: HydraDB.HandlerResponseMeta;
7
+ /** Whether the request succeeded. */
8
+ success?: boolean;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ import type * as HydraDB from "../index.js";
2
+ export interface HandlerEnvelopeHandlerSupabaseWebhookAck {
3
+ data?: HydraDB.HandlerSupabaseWebhookAck;
4
+ /** Error message, empty string on success. */
5
+ error?: HydraDB.HandlerApiError;
6
+ meta?: HydraDB.HandlerResponseMeta;
7
+ /** Whether the request succeeded. */
8
+ success?: boolean;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,5 +1,12 @@
1
1
  import type * as HydraDB from "../index.js";
2
2
  export interface HandlerResourceMapping {
3
+ /**
4
+ * ACL restricts every object synced from this resource to the listed
5
+ * principals (emails, or prefixed principals, see the query-side
6
+ * user_email parameter). Omitted means unrestricted. An explicitly empty
7
+ * list means private (visible only to unfiltered queries).
8
+ */
9
+ acl?: string[];
3
10
  /**
4
11
  * AdditionalMetadata is merged into the additional_metadata layer of every
5
12
  * object synced from this resource. Provider-generated fields take precedence.
@@ -13,6 +20,13 @@ export interface HandlerResourceMapping {
13
20
  * Configure before toResource runs.
14
21
  */
15
22
  collection?: string;
23
+ /**
24
+ * CustomInstructions optionally steers how documents synced from this
25
+ * resource are ingested and indexed. When set it replaces the
26
+ * connector-level custom_instructions for this resource; empty inherits
27
+ * the connector's value. Max 4000 characters.
28
+ */
29
+ customInstructions?: string;
16
30
  /**
17
31
  * Database is the canonical v2 name for the per-resource tenant override:
18
32
  * routes synced objects from this resource into a specific database.
@@ -0,0 +1,7 @@
1
+ export interface HandlerSupabaseWebhookAck {
2
+ /** Unique identifier for this resource. */
3
+ id?: string;
4
+ /** Current lifecycle or processing state. */
5
+ status?: string;
6
+ table?: string;
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,18 @@
1
+ export interface SearchSourceFact {
2
+ actor?: string;
3
+ actorRole?: string;
4
+ /** App integration category, populated for connector-synced sources. */
5
+ appKind?: string;
6
+ /** Chunk that provides evidence for this relation. */
7
+ chunkId?: string;
8
+ connector?: string;
9
+ container?: string;
10
+ /** External provider being synced (e.g. `slack`, `github`, `linear`, `notion`, `gmail`). */
11
+ provider?: string;
12
+ relation?: string;
13
+ /** Unique identifier for this relationship instance. */
14
+ relationshipId?: string;
15
+ sourceId?: string;
16
+ syncedAt?: number;
17
+ threadId?: string;
18
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,15 @@
1
+ /**
2
+ * SourceFilter reports what the source layer did for this request.
3
+ */
4
+ export interface SearchSourceFilterInfo {
5
+ actorScope?: string;
6
+ applied?: boolean;
7
+ containerScope?: string;
8
+ degraded?: boolean;
9
+ matchedFacts?: number;
10
+ mode?: string;
11
+ /** External provider being synced (e.g. `slack`, `github`, `linear`, `notion`, `gmail`). */
12
+ provider?: string;
13
+ threadScope?: boolean;
14
+ truncated?: boolean;
15
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -5,6 +5,12 @@ export interface SearchV2RetrievalResult {
5
5
  /** Retrieved and ranked chunks from the knowledge store or memories. */
6
6
  chunks?: HydraDB.SearchV2Chunk[];
7
7
  graphContext?: HydraDB.SearchGraphContext;
8
+ /**
9
+ * SourceFacts surface the matched app-native (edge_source) facts when
10
+ * source_reasoning was active; omitted otherwise (PRO-1602).
11
+ */
12
+ sourceFacts?: HydraDB.SearchSourceFact[];
13
+ sourceFilter?: HydraDB.SearchSourceFilterInfo;
8
14
  /** Deduplicated source-level metadata for all returned chunks. */
9
15
  sources?: HydraDB.SearchSourceInfo[];
10
16
  temporalDuration?: HydraDB.SearchTemporalDuration;
@@ -15,6 +15,8 @@ export * from "./GithubComHydradbHydradbApplicationInternalServiceMetadataEditRe
15
15
  export * from "./GraphEntity.js";
16
16
  export * from "./GraphGraphRelationsResponse.js";
17
17
  export * from "./GraphRelationEvidence.js";
18
+ export * from "./GraphSourceSubgraphResponse.js";
19
+ export * from "./GraphSubgraphSource.js";
18
20
  export * from "./GraphTripletWithEvidence.js";
19
21
  export * from "./HandlerApiError.js";
20
22
  export * from "./HandlerCatalogConnector.js";
@@ -39,6 +41,8 @@ export * from "./HandlerEnvelopeFeedbackSubmitResponse.js";
39
41
  export * from "./HandlerEnvelopeFetchV2SourceFetchResponse.js";
40
42
  export * from "./HandlerEnvelopeGithubComHydradbHydradbApplicationInternalServiceMetadataEditResult.js";
41
43
  export * from "./HandlerEnvelopeGraphGraphRelationsResponse.js";
44
+ export * from "./HandlerEnvelopeGraphSourceSubgraphResponse.js";
45
+ export * from "./HandlerEnvelopeHandlerSupabaseWebhookAck.js";
42
46
  export * from "./HandlerEnvelopeIngestionV2BatchProcessingStatus.js";
43
47
  export * from "./HandlerEnvelopeIngestionV2IngestResponse.js";
44
48
  export * from "./HandlerEnvelopeListV2ListResponse.js";
@@ -69,6 +73,7 @@ export * from "./HandlerResourceDeleteResponse.js";
69
73
  export * from "./HandlerResourceMapping.js";
70
74
  export * from "./HandlerResourceMappingSyncMode.js";
71
75
  export * from "./HandlerResponseMeta.js";
76
+ export * from "./HandlerSupabaseWebhookAck.js";
72
77
  export * from "./HandlerTableConfigEntry.js";
73
78
  export * from "./IngestionSourceStatus.js";
74
79
  export * from "./IngestionV2BatchProcessingStatus.js";
@@ -88,6 +93,8 @@ export * from "./SearchQueryRequestCollections.js";
88
93
  export * from "./SearchQueryRequestSubTenantIds.js";
89
94
  export * from "./SearchRecallMode.js";
90
95
  export * from "./SearchScoredPathResponse.js";
96
+ export * from "./SearchSourceFact.js";
97
+ export * from "./SearchSourceFilterInfo.js";
91
98
  export * from "./SearchSourceInfo.js";
92
99
  export * from "./SearchSourceType.js";
93
100
  export * from "./SearchTemporalDuration.js";
@@ -31,6 +31,8 @@ __exportStar(require("./GithubComHydradbHydradbApplicationInternalServiceMetadat
31
31
  __exportStar(require("./GraphEntity.js"), exports);
32
32
  __exportStar(require("./GraphGraphRelationsResponse.js"), exports);
33
33
  __exportStar(require("./GraphRelationEvidence.js"), exports);
34
+ __exportStar(require("./GraphSourceSubgraphResponse.js"), exports);
35
+ __exportStar(require("./GraphSubgraphSource.js"), exports);
34
36
  __exportStar(require("./GraphTripletWithEvidence.js"), exports);
35
37
  __exportStar(require("./HandlerApiError.js"), exports);
36
38
  __exportStar(require("./HandlerCatalogConnector.js"), exports);
@@ -55,6 +57,8 @@ __exportStar(require("./HandlerEnvelopeFeedbackSubmitResponse.js"), exports);
55
57
  __exportStar(require("./HandlerEnvelopeFetchV2SourceFetchResponse.js"), exports);
56
58
  __exportStar(require("./HandlerEnvelopeGithubComHydradbHydradbApplicationInternalServiceMetadataEditResult.js"), exports);
57
59
  __exportStar(require("./HandlerEnvelopeGraphGraphRelationsResponse.js"), exports);
60
+ __exportStar(require("./HandlerEnvelopeGraphSourceSubgraphResponse.js"), exports);
61
+ __exportStar(require("./HandlerEnvelopeHandlerSupabaseWebhookAck.js"), exports);
58
62
  __exportStar(require("./HandlerEnvelopeIngestionV2BatchProcessingStatus.js"), exports);
59
63
  __exportStar(require("./HandlerEnvelopeIngestionV2IngestResponse.js"), exports);
60
64
  __exportStar(require("./HandlerEnvelopeListV2ListResponse.js"), exports);
@@ -85,6 +89,7 @@ __exportStar(require("./HandlerResourceDeleteResponse.js"), exports);
85
89
  __exportStar(require("./HandlerResourceMapping.js"), exports);
86
90
  __exportStar(require("./HandlerResourceMappingSyncMode.js"), exports);
87
91
  __exportStar(require("./HandlerResponseMeta.js"), exports);
92
+ __exportStar(require("./HandlerSupabaseWebhookAck.js"), exports);
88
93
  __exportStar(require("./HandlerTableConfigEntry.js"), exports);
89
94
  __exportStar(require("./IngestionSourceStatus.js"), exports);
90
95
  __exportStar(require("./IngestionV2BatchProcessingStatus.js"), exports);
@@ -104,6 +109,8 @@ __exportStar(require("./SearchQueryRequestCollections.js"), exports);
104
109
  __exportStar(require("./SearchQueryRequestSubTenantIds.js"), exports);
105
110
  __exportStar(require("./SearchRecallMode.js"), exports);
106
111
  __exportStar(require("./SearchScoredPathResponse.js"), exports);
112
+ __exportStar(require("./SearchSourceFact.js"), exports);
113
+ __exportStar(require("./SearchSourceFilterInfo.js"), exports);
107
114
  __exportStar(require("./SearchSourceInfo.js"), exports);
108
115
  __exportStar(require("./SearchSourceType.js"), exports);
109
116
  __exportStar(require("./SearchTemporalDuration.js"), exports);
@@ -12,6 +12,7 @@ import { SearchTemporalIntentOverride } from "../../types/SearchTemporalIntentOv
12
12
  export declare const SearchQueryRequest: core.serialization.Schema<serializers.SearchQueryRequest.Raw, HydraDB.SearchQueryRequest>;
13
13
  export declare namespace SearchQueryRequest {
14
14
  interface Raw {
15
+ acl?: string[] | null;
15
16
  additional_context?: string | null;
16
17
  alpha?: unknown | null;
17
18
  collection?: string | null;
@@ -45,6 +45,7 @@ const SearchRecallMode_js_1 = require("../../types/SearchRecallMode.js");
45
45
  const SearchSourceType_js_1 = require("../../types/SearchSourceType.js");
46
46
  const SearchTemporalIntentOverride_js_1 = require("../../types/SearchTemporalIntentOverride.js");
47
47
  exports.SearchQueryRequest = core.serialization.object({
48
+ acl: core.serialization.list(core.serialization.string()).optional(),
48
49
  additionalContext: core.serialization.property("additional_context", core.serialization.string().optional()),
49
50
  alpha: core.serialization.unknown().optional(),
50
51
  collection: core.serialization.string().optional(),
@@ -1,2 +1,3 @@
1
1
  export * from "./requests/index.js";
2
2
  export * as rotateAConnectorsStoredOAuthRefreshTokenInternalUseOnly from "./rotateAConnectorsStoredOAuthRefreshTokenInternalUseOnly.js";
3
+ export * as updateResourceAcl from "./updateResourceAcl.js";