@warmhub/sdk-ts 0.82.3 → 0.83.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -2337,6 +2337,8 @@ type ActionNotificationInfo = ActionNotification;
2337
2337
  /** @internal */
2338
2338
  type ActionLiveFeed = ActionLiveFeedResult;
2339
2339
  /** @internal */
2340
+ type ActionLiveFeedItem = ActionLiveFeed['items'][number];
2341
+ /** @internal */
2340
2342
  type ActionLeaseAcquire = {
2341
2343
  ok: true;
2342
2344
  reused: boolean;
@@ -2662,6 +2664,10 @@ type RepoListForCallerOptions = {
2662
2664
  * @internal
2663
2665
  */
2664
2666
  type RepoExploreOptions = RepoExploreInput;
2667
+ /** @internal */
2668
+ type RepoExploreBrowseOptions = Omit<RepoExploreOptions, 'slugs'> & {
2669
+ slugs?: never;
2670
+ };
2665
2671
  /**
2666
2672
  * A repository row in the public "Explore" directory
2667
2673
  * (`client.repo.explore`).
@@ -2819,6 +2825,17 @@ type ThingHeadOptions = Omit<ThingHeadRequest, 'orgName' | 'repoName'>;
2819
2825
  type HeadResult = {
2820
2826
  items: ThingItem[];
2821
2827
  nextCursor?: string;
2828
+ /** Completed incremental scan checkpoint; omitted on ordinary and nonterminal pages. */
2829
+ repoSeq?: number;
2830
+ };
2831
+ /** @internal */
2832
+ type ThingHeadChangesOptions = Omit<ThingHeadOptions, 'cursor' | 'includeRetracted' | 'sinceRepoSeq'> & {
2833
+ sinceRepoSeq: number;
2834
+ };
2835
+ /** @internal */
2836
+ type ThingChanges = {
2837
+ items: ThingItem[];
2838
+ repoSeq: number;
2822
2839
  };
2823
2840
  /** @internal */
2824
2841
  type ThingGet = ThingDetail;
@@ -2911,32 +2928,17 @@ type ThingGraphResult = ThingDetail & {
2911
2928
  /** @internal */
2912
2929
  type ThingHistory = HistoryResult;
2913
2930
  /** @internal */
2914
- type HistoryResult = ThingHistoryResult & {
2931
+ type HistoryVersion = ThingHistoryResult['versions'][number] & Record<string, unknown>;
2932
+ /** @internal */
2933
+ type HistoryResult = Omit<ThingHistoryResult, 'versions'> & {
2915
2934
  thing?: {
2916
2935
  wref: string;
2917
2936
  name?: string;
2918
2937
  kind: string;
2919
2938
  shapeName?: string;
2920
2939
  };
2921
- versions: Array<{
2922
- version: number;
2923
- wref: string;
2924
- operation: CommitOperation;
2925
- retractReason?: string;
2926
- active: boolean;
2927
- createdAt: number;
2928
- thingName?: string;
2929
- thingKind?: string;
2930
- shapeName?: string;
2931
- data?: unknown;
2932
- aboutWref?: string;
2933
- committerWref?: string;
2934
- /** #4848 Phase C: per-version author (renamed from createdByWref). */
2935
- revisedBy?: string;
2936
- metadata?: Pick<ThingMetadata, 'durableId' | 'createdOn'>;
2937
- [key: string]: unknown;
2938
- }>;
2939
- nextCursor?: string;
2940
+ /** History rows retain forward-compatible backend fields. */
2941
+ versions: HistoryVersion[];
2940
2942
  };
2941
2943
  /** @internal */
2942
2944
  type ThingHeadRequest = {
@@ -2953,6 +2955,8 @@ type ThingHeadRequest = {
2953
2955
  excludeComponents?: boolean;
2954
2956
  excludeInfraShapes?: boolean;
2955
2957
  where?: WherePredicate[];
2958
+ /** Strict lower repository sequence for an incremental scan; `-1` seeds a complete snapshot. */
2959
+ sinceRepoSeq?: number;
2956
2960
  };
2957
2961
  /** @internal */
2958
2962
  type ThingHead = HeadResult;
@@ -3127,7 +3131,7 @@ type AboutResult = {
3127
3131
  /** @internal */
3128
3132
  type FilterResult = HeadResult;
3129
3133
  /** @internal */
3130
- type SearchResult = HeadResult;
3134
+ type SearchResult = Omit<HeadResult, 'repoSeq'>;
3131
3135
  /** @internal */
3132
3136
  type RefsResult = RefsResult$1;
3133
3137
  /** @internal */
@@ -3153,6 +3157,8 @@ type ThingHeadVersionsResult = ThingHeadVersionsResult$1;
3153
3157
  /** @internal */
3154
3158
  type CountResult = {
3155
3159
  count: number;
3160
+ /** Completed incremental scan checkpoint; omitted from ordinary counts. */
3161
+ repoSeq?: number;
3156
3162
  };
3157
3163
  /** @internal */
3158
3164
  type AboutOptions = {
@@ -3242,6 +3248,12 @@ type FilterOptions = {
3242
3248
  * Up to 8 predicates per call.
3243
3249
  */
3244
3250
  where?: WherePredicate[];
3251
+ /** Strict lower repository sequence for an incremental scan; `-1` seeds a complete snapshot. */
3252
+ sinceRepoSeq?: number;
3253
+ };
3254
+ /** @internal */
3255
+ type ThingQueryChangesOptions = Omit<FilterOptions, 'cursor' | 'includeRetracted' | 'sinceRepoSeq'> & {
3256
+ sinceRepoSeq: number;
3245
3257
  };
3246
3258
  /**
3247
3259
  * Options for `client.thing.search`. Search does not support field-value
@@ -3252,7 +3264,7 @@ type FilterOptions = {
3252
3264
  *
3253
3265
  * @see https://docs.warmhub.ai/sdk/read-semantics/#search-modes
3254
3266
  */
3255
- type SearchOptions = Omit<FilterOptions, 'where' | 'role'> & {
3267
+ type SearchOptions = Omit<FilterOptions, 'where' | 'role' | 'sinceRepoSeq'> & {
3256
3268
  /** Restrict the search to assertions about this wref target. */
3257
3269
  about?: string;
3258
3270
  /** Search mode: `text` (BM25), `vector` (semantic), or `hybrid` (combined). Defaults to `text`. */
@@ -3649,13 +3661,44 @@ declare class WarmHubClient {
3649
3661
  * token.
3650
3662
  */
3651
3663
  list: (orgName: string, repoName: string, opts?: ComponentListOptions) => Promise<ComponentList>;
3664
+ /**
3665
+ * Iterate installed components. Cursors resume the same query and result
3666
+ * scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
3667
+ * `cursor`.
3668
+ */
3669
+ listIter: (orgName: string, repoName: string, opts?: ComponentListOptions) => AsyncIterableIterator<ComponentInfo>;
3670
+ /**
3671
+ * Materialize installed components. Cursors resume the same query and
3672
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
3673
+ * without `cursor`.
3674
+ */
3675
+ listAll: (orgName: string, repoName: string, opts?: ComponentListOptions & {
3676
+ max?: number;
3677
+ }) => Promise<ComponentInfo[]>;
3652
3678
  /**
3653
3679
  * Search registered components visible to the caller across all orgs
3654
3680
  * (GH-4383): public components plus private components the caller can
3655
3681
  * read. Distinct from listing components installed in a repo
3656
3682
  * (`component.list`).
3683
+ *
3684
+ * Cursor contract: cursors resume the same query and result scope; on
3685
+ * `VALIDATION_ERROR` / `Invalid cursor`, restart the query without `cursor`.
3657
3686
  */
3658
3687
  search: (query: string, opts?: GlobalSearchOptions) => Promise<GlobalSearchResult>;
3688
+ /**
3689
+ * Iterate global component search hits. Cursors resume the same query and
3690
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
3691
+ * without `cursor`.
3692
+ */
3693
+ searchIter: (query: string, opts?: GlobalSearchOptions) => AsyncIterableIterator<GlobalSearchResultItem>;
3694
+ /**
3695
+ * Materialize global component search hits. Cursors resume the same query
3696
+ * and result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the
3697
+ * query without `cursor`.
3698
+ */
3699
+ searchAll: (query: string, opts?: GlobalSearchOptions & {
3700
+ max?: number;
3701
+ }) => Promise<GlobalSearchResultItem[]>;
3659
3702
  /**
3660
3703
  * Fetch one installed component by its `Org/Name` ref.
3661
3704
  */
@@ -3937,12 +3980,43 @@ declare class WarmHubClient {
3937
3980
  * token.
3938
3981
  */
3939
3982
  list: (orgName: string, opts?: RepoListOptions) => Promise<RepoList>;
3983
+ /**
3984
+ * Iterate organization repositories. Cursors resume the same query and
3985
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
3986
+ * without `cursor`.
3987
+ */
3988
+ listIter: (orgName: string, opts?: RepoListOptions) => AsyncIterableIterator<RepoInfo>;
3989
+ /**
3990
+ * Materialize organization repositories. Cursors resume the same query and
3991
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
3992
+ * without `cursor`.
3993
+ */
3994
+ listAll: (orgName: string, opts?: RepoListOptions & {
3995
+ max?: number;
3996
+ }) => Promise<RepoInfo[]>;
3940
3997
  /**
3941
3998
  * Search repos visible to the caller across all orgs (GH-4383): public
3942
3999
  * repos plus private repos the caller can read. BM25 over
3943
4000
  * name/description/shape vocabulary/README.
4001
+ *
4002
+ * Cursor contract: cursors resume the same query and result scope; on
4003
+ * `VALIDATION_ERROR` / `Invalid cursor`, restart the query without `cursor`.
3944
4004
  */
3945
4005
  search: (query: string, opts?: GlobalSearchOptions) => Promise<GlobalSearchResult>;
4006
+ /**
4007
+ * Iterate global repository search hits. Cursors resume the same query and
4008
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
4009
+ * without `cursor`.
4010
+ */
4011
+ searchIter: (query: string, opts?: GlobalSearchOptions) => AsyncIterableIterator<GlobalSearchResultItem>;
4012
+ /**
4013
+ * Materialize global repository search hits. Cursors resume the same query
4014
+ * and result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the
4015
+ * query without `cursor`.
4016
+ */
4017
+ searchAll: (query: string, opts?: GlobalSearchOptions & {
4018
+ max?: number;
4019
+ }) => Promise<GlobalSearchResultItem[]>;
3946
4020
  /**
3947
4021
  * Create a repository inside an organization.
3948
4022
  *
@@ -4015,6 +4089,20 @@ declare class WarmHubClient {
4015
4089
  * token.
4016
4090
  */
4017
4091
  listPage: (orgName: string, opts?: RepoListPageOptions) => Promise<RepoListPageResult>;
4092
+ /**
4093
+ * Iterate repository rows with stats. Cursors resume the same query and
4094
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
4095
+ * without `cursor`.
4096
+ */
4097
+ listPageIter: (orgName: string, opts?: RepoListPageOptions) => AsyncIterableIterator<RepoWithStatsInfo>;
4098
+ /**
4099
+ * Materialize repository rows with stats. Cursors resume the same query and
4100
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
4101
+ * without `cursor`.
4102
+ */
4103
+ listPageAll: (orgName: string, opts?: RepoListPageOptions & {
4104
+ max?: number;
4105
+ }) => Promise<RepoWithStatsInfo[]>;
4018
4106
  /**
4019
4107
  * List the caller's repositories across every org they belong to, ordered
4020
4108
  * for recency by default (most recently written first), capped at `limit`.
@@ -4051,6 +4139,22 @@ declare class WarmHubClient {
4051
4139
  * token.
4052
4140
  */
4053
4141
  explore: (opts?: RepoExploreOptions) => Promise<RepoExploreResult>;
4142
+ /**
4143
+ * Iterate public Explore browse results. Cursors resume the same query and
4144
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
4145
+ * without `cursor`. Exact `slugs` lookup is not pageable.
4146
+ */
4147
+ exploreIter: (opts?: RepoExploreBrowseOptions) => AsyncIterableIterator<RepoExploreItem>;
4148
+ /**
4149
+ * Materialize public Explore browse results. Cursors resume the same query
4150
+ * and result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the
4151
+ * query without `cursor`. Exact `slugs` lookup is not pageable. `max`
4152
+ * remains optional as part of the uniform `*All` contract; callers should
4153
+ * provide a finite cap for this offset-paginated endpoint.
4154
+ */
4155
+ exploreAll: (opts?: RepoExploreBrowseOptions & {
4156
+ max?: number;
4157
+ }) => Promise<RepoExploreItem[]>;
4054
4158
  /**
4055
4159
  * Fetch a repository's `Content/Readme` markdown record.
4056
4160
  *
@@ -4174,6 +4278,20 @@ declare class WarmHubClient {
4174
4278
  * token.
4175
4279
  */
4176
4280
  history: (orgName: string, repoName: string, name: string, opts?: ShapeHistoryOptions) => Promise<ShapeHistory>;
4281
+ /**
4282
+ * Iterate shape versions. Cursors resume the same query and result scope;
4283
+ * on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
4284
+ * `cursor`.
4285
+ */
4286
+ historyIter: (orgName: string, repoName: string, name: string, opts?: ShapeHistoryOptions) => AsyncIterableIterator<HistoryVersion>;
4287
+ /**
4288
+ * Materialize shape versions. Cursors resume the same query and result
4289
+ * scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
4290
+ * `cursor`.
4291
+ */
4292
+ historyAll: (orgName: string, repoName: string, name: string, opts?: ShapeHistoryOptions & {
4293
+ max?: number;
4294
+ }) => Promise<HistoryVersion[]>;
4177
4295
  };
4178
4296
  /**
4179
4297
  * Webhook subscription management surface scoped to a repository.
@@ -4309,6 +4427,20 @@ declare class WarmHubClient {
4309
4427
  * token.
4310
4428
  */
4311
4429
  liveFeed: (orgName: string, repoName: string, subscriptionName: string, opts?: ActionLiveFeedOptions) => Promise<ActionLiveFeed>;
4430
+ /**
4431
+ * Iterate delivery-feed entries. Cursors resume the same query and result
4432
+ * scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
4433
+ * `cursor`.
4434
+ */
4435
+ liveFeedIter: (orgName: string, repoName: string, subscriptionName: string, opts?: ActionLiveFeedOptions) => AsyncIterableIterator<ActionLiveFeedItem>;
4436
+ /**
4437
+ * Materialize delivery-feed entries. Cursors resume the same query and
4438
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
4439
+ * without `cursor`.
4440
+ */
4441
+ liveFeedAll: (orgName: string, repoName: string, subscriptionName: string, opts?: ActionLiveFeedOptions & {
4442
+ max?: number;
4443
+ }) => Promise<ActionLiveFeedItem[]>;
4312
4444
  /**
4313
4445
  * List subscription action runs as a `Page<ActionRunInfo>` (`items` +
4314
4446
  * optional `nextCursor`), newest-first, capped at 200 runs per page.
@@ -4316,11 +4448,26 @@ declare class WarmHubClient {
4316
4448
  * `status` and `outcome` are mutually exclusive.
4317
4449
  * `since` and `cursor` are mutually exclusive; pass `cursor` alone on later
4318
4450
  * pages — the `since` window rides in the cursor.
4319
- * Cursors are opaque, short-lived resume tokens; on `VALIDATION_ERROR`
4320
- * restart the query without `cursor`.
4451
+ * Cursors are opaque, short-lived resume tokens for the same query and
4452
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
4453
+ * without `cursor`.
4321
4454
  * See docs/dev/warmhub-actions-api.md for the full contract.
4322
4455
  */
4323
4456
  listRuns: (orgName: string, repoName: string, opts?: ActionListRunsOptions) => Promise<Page<ActionRunInfo>>;
4457
+ /**
4458
+ * Iterate action runs. Cursors resume the same query and result scope; on
4459
+ * `VALIDATION_ERROR` / `Invalid cursor`, restart the query without `cursor`.
4460
+ * `since` is sent only on the initial request.
4461
+ */
4462
+ listRunsIter: (orgName: string, repoName: string, opts?: ActionListRunsOptions) => AsyncIterableIterator<ActionRunInfo>;
4463
+ /**
4464
+ * Materialize action runs. Cursors resume the same query and result scope;
4465
+ * on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
4466
+ * `cursor`. `since` is sent only on the initial request.
4467
+ */
4468
+ listRunsAll: (orgName: string, repoName: string, opts?: ActionListRunsOptions & {
4469
+ max?: number;
4470
+ }) => Promise<ActionRunInfo[]>;
4324
4471
  /**
4325
4472
  * Return the newest visible action run for each subscription in a repo.
4326
4473
  *
@@ -4351,8 +4498,23 @@ declare class WarmHubClient {
4351
4498
  };
4352
4499
  readonly collection: {
4353
4500
  create: (orgName: string, repoName: string, opts: CollectionCreateOptions) => Promise<CollectionMutationResult>;
4501
+ /**
4502
+ * Read one collection-membership page. Cursors resume the same query and
4503
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
4504
+ * without `cursor`.
4505
+ */
4354
4506
  members: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: CollectionMembersOptions) => Promise<CollectionMembersPage>;
4507
+ /**
4508
+ * Iterate collection members. Cursors resume the same query and result
4509
+ * scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
4510
+ * `cursor`.
4511
+ */
4355
4512
  membersIter: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: CollectionMembersOptions) => AsyncIterableIterator<CollectionMember>;
4513
+ /**
4514
+ * Materialize collection members. Cursors resume the same query and result
4515
+ * scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
4516
+ * `cursor`.
4517
+ */
4356
4518
  membersAll: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: CollectionMembersOptions & {
4357
4519
  max?: number;
4358
4520
  }) => Promise<CollectionMember[]>;
@@ -4391,7 +4553,7 @@ declare class WarmHubClient {
4391
4553
  * cursor`; restart the query without `cursor` instead of retrying the stale
4392
4554
  * token.
4393
4555
  */
4394
- headIter: (orgName: string, repoName: string, opts?: ThingHeadOptions) => AsyncIterableIterator<ThingItem>;
4556
+ headIter: (orgName: string, repoName: string, opts?: Omit<ThingHeadOptions, "sinceRepoSeq">) => AsyncIterableIterator<ThingItem>;
4395
4557
  /**
4396
4558
  * Materialize every current HEAD row matching the supplied filters.
4397
4559
  *
@@ -4403,9 +4565,20 @@ declare class WarmHubClient {
4403
4565
  * cursor`; restart the query without `cursor` instead of retrying the stale
4404
4566
  * token.
4405
4567
  */
4406
- headAll: (orgName: string, repoName: string, opts?: ThingHeadOptions & {
4568
+ headAll: (orgName: string, repoName: string, opts?: Omit<ThingHeadOptions, "sinceRepoSeq"> & {
4407
4569
  max?: number;
4408
4570
  }) => Promise<ThingItem[]>;
4571
+ /**
4572
+ * Materialize identity-owned changes after a repository sequence and return
4573
+ * the exact checkpoint reached by the completed scan.
4574
+ *
4575
+ * Key a local cache by `item.metadata.durableId`: an identity rename
4576
+ * carries its checkpoint wref, and a retraction carries `active: false`.
4577
+ * This helper forces retracted rows on and returns only after draining the
4578
+ * terminal page. It does not fan out changes caused by another identity
4579
+ * and therefore is not, by itself, a complete local-result-mirror protocol.
4580
+ */
4581
+ headChanges: (orgName: string, repoName: string, opts: ThingHeadChangesOptions) => Promise<ThingChanges>;
4409
4582
  /**
4410
4583
  * Get one thing, assertion, shape, or collection by wref.
4411
4584
  *
@@ -4497,6 +4670,20 @@ declare class WarmHubClient {
4497
4670
  * token.
4498
4671
  */
4499
4672
  history: (orgName: string | undefined, repoName: string | undefined, opts: ThingHistoryOptions) => Promise<ThingHistory>;
4673
+ /**
4674
+ * Iterate thing history versions. Cursors resume the same query and result
4675
+ * scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
4676
+ * `cursor`.
4677
+ */
4678
+ historyIter: (orgName: string | undefined, repoName: string | undefined, opts: ThingHistoryOptions) => AsyncIterableIterator<HistoryVersion>;
4679
+ /**
4680
+ * Materialize thing history versions. Cursors resume the same query and
4681
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
4682
+ * without `cursor`.
4683
+ */
4684
+ historyAll: (orgName: string | undefined, repoName: string | undefined, opts: ThingHistoryOptions & {
4685
+ max?: number;
4686
+ }) => Promise<HistoryVersion[]>;
4500
4687
  /**
4501
4688
  * Rename a thing within its shape namespace.
4502
4689
  *
@@ -4580,7 +4767,7 @@ declare class WarmHubClient {
4580
4767
  * cursor`; restart the query without `cursor` instead of retrying the stale
4581
4768
  * token.
4582
4769
  */
4583
- queryIter: (orgName: string, repoName: string, opts?: FilterOptions) => AsyncIterableIterator<ThingItem>;
4770
+ queryIter: (orgName: string, repoName: string, opts?: Omit<FilterOptions, "sinceRepoSeq">) => AsyncIterableIterator<ThingItem>;
4584
4771
  /**
4585
4772
  * Materialize every repository record matching the supplied filters.
4586
4773
  *
@@ -4592,9 +4779,20 @@ declare class WarmHubClient {
4592
4779
  * cursor`; restart the query without `cursor` instead of retrying the stale
4593
4780
  * token.
4594
4781
  */
4595
- queryAll: (orgName: string, repoName: string, opts?: FilterOptions & {
4782
+ queryAll: (orgName: string, repoName: string, opts?: Omit<FilterOptions, "sinceRepoSeq"> & {
4596
4783
  max?: number;
4597
4784
  }) => Promise<ThingItem[]>;
4785
+ /**
4786
+ * Materialize filtered identity-owned changes after a repository sequence
4787
+ * and return the exact checkpoint reached by the completed scan.
4788
+ *
4789
+ * Key a local cache by `item.metadata.durableId`: an identity rename
4790
+ * carries its checkpoint wref, and a retraction carries `active: false`.
4791
+ * This helper forces retracted rows on and returns only after draining the
4792
+ * terminal page. It does not fan out changes caused by another identity
4793
+ * and therefore is not, by itself, a complete local-result-mirror protocol.
4794
+ */
4795
+ queryChanges: (orgName: string, repoName: string, opts: ThingQueryChangesOptions) => Promise<ThingChanges>;
4598
4796
  /**
4599
4797
  * Search repository records with text, vector, or hybrid mode.
4600
4798
  *
@@ -4607,6 +4805,20 @@ declare class WarmHubClient {
4607
4805
  * token.
4608
4806
  */
4609
4807
  search: (orgName: string, repoName: string, query: string, opts?: SearchOptions) => Promise<SearchResult>;
4808
+ /**
4809
+ * Iterate ranked search hits. Cursors resume the same query and result
4810
+ * scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
4811
+ * `cursor`.
4812
+ */
4813
+ searchIter: (orgName: string, repoName: string, query: string, opts?: SearchOptions) => AsyncIterableIterator<ThingItem>;
4814
+ /**
4815
+ * Materialize ranked search hits. Cursors resume the same query and result
4816
+ * scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
4817
+ * `cursor`.
4818
+ */
4819
+ searchAll: (orgName: string, repoName: string, query: string, opts?: SearchOptions & {
4820
+ max?: number;
4821
+ }) => Promise<ThingItem[]>;
4610
4822
  /**
4611
4823
  * Count matching repository records without returning record data.
4612
4824
  */
@@ -4912,6 +5124,20 @@ declare class WarmHubClient {
4912
5124
  * token.
4913
5125
  */
4914
5126
  liveFeed: (orgName: string, repoName: string, subscriptionName: string, opts?: ActionLiveFeedOptions) => Promise<ActionLiveFeed>;
5127
+ /**
5128
+ * Iterate delivery-feed entries. Cursors resume the same query and result
5129
+ * scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
5130
+ * `cursor`.
5131
+ */
5132
+ liveFeedIter: (orgName: string, repoName: string, subscriptionName: string, opts?: ActionLiveFeedOptions) => AsyncIterableIterator<ActionLiveFeedItem>;
5133
+ /**
5134
+ * Materialize delivery-feed entries. Cursors resume the same query and
5135
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
5136
+ * without `cursor`.
5137
+ */
5138
+ liveFeedAll: (orgName: string, repoName: string, subscriptionName: string, opts?: ActionLiveFeedOptions & {
5139
+ max?: number;
5140
+ }) => Promise<ActionLiveFeedItem[]>;
4915
5141
  /**
4916
5142
  * List subscription action runs as a `Page<ActionRunInfo>` (`items` +
4917
5143
  * optional `nextCursor`), newest-first, capped at 200 runs per page.
@@ -4919,11 +5145,26 @@ declare class WarmHubClient {
4919
5145
  * `status` and `outcome` are mutually exclusive.
4920
5146
  * `since` and `cursor` are mutually exclusive; pass `cursor` alone on later
4921
5147
  * pages — the `since` window rides in the cursor.
4922
- * Cursors are opaque, short-lived resume tokens; on `VALIDATION_ERROR`
4923
- * restart the query without `cursor`.
5148
+ * Cursors are opaque, short-lived resume tokens for the same query and
5149
+ * result scope; on `VALIDATION_ERROR` / `Invalid cursor`, restart the query
5150
+ * without `cursor`.
4924
5151
  * See docs/dev/warmhub-actions-api.md for the full contract.
4925
5152
  */
4926
5153
  listRuns: (orgName: string, repoName: string, opts?: ActionListRunsOptions) => Promise<Page<ActionRunInfo>>;
5154
+ /**
5155
+ * Iterate action runs. Cursors resume the same query and result scope; on
5156
+ * `VALIDATION_ERROR` / `Invalid cursor`, restart the query without `cursor`.
5157
+ * `since` is sent only on the initial request.
5158
+ */
5159
+ listRunsIter: (orgName: string, repoName: string, opts?: ActionListRunsOptions) => AsyncIterableIterator<ActionRunInfo>;
5160
+ /**
5161
+ * Materialize action runs. Cursors resume the same query and result scope;
5162
+ * on `VALIDATION_ERROR` / `Invalid cursor`, restart the query without
5163
+ * `cursor`. `since` is sent only on the initial request.
5164
+ */
5165
+ listRunsAll: (orgName: string, repoName: string, opts?: ActionListRunsOptions & {
5166
+ max?: number;
5167
+ }) => Promise<ActionRunInfo[]>;
4927
5168
  /**
4928
5169
  * Return the newest visible action run for each subscription in a repo.
4929
5170
  *
@@ -4964,4 +5205,4 @@ declare class WarmHubClient {
4964
5205
  private watchRepoQuery;
4965
5206
  }
4966
5207
 
4967
- export { type AboutOptions, type AboutResult, type AccessResolveInput, type AccessResolveResult, type AccessTokenProvider, type ActionAttemptInfo, type ActionDeliveryTarget, type ActionLeaseAcquire, type ActionLeaseOp, type ActionListNotificationsOptions, type ActionListRunsOptions, type ActionLiveFeed, type ActionLiveFeedOptions, type ActionNotificationInfo, type ActionRunInfo, type ActionRunStatsInfo, type ActionRunStatsOptions, type AddOp, type AddOperation, AllStreamOperationsFailedError, type Assertion, CLI_INSTALL_REPO_HEADER, CLI_SIGNATURE_HEADER, CLI_TIMESTAMP_HEADER, CONTENT_FIELD_LIMIT_ERROR, type CliCallSecrets, CliCallVerificationError, type CliCallVerificationFailureReason, type CollectionAddOp, type CollectionAddType, type CollectionContainsOptions, type CollectionContainsResult, type CollectionCreateOptions, type CollectionDiffOptions, type CollectionDiffResult, type CollectionMember, type CollectionMembersOptions, type CollectionMembersPage, type CollectionMembershipRole, type CollectionMutationResult, type CollectionQuerySourceOptions, type CollectionReadDataMode, type CollectionReadSummary, type CollectionReviseOptions, type CollectionStatsOptions, type CollectionStatsResult, type CollectionTag, type CollectionType, type ComponentHistory, type ComponentHistoryOptions, type ComponentInfo, type ComponentInstallResult, type ComponentList, type ComponentListOptions, type ComponentUninstallResult, type ComponentView, type CoreErrorKind, type CountOptions, type CountResult, type CredentialAuditEntry, type CredentialDeleteResult, type CredentialGrantResult, type CredentialInfo, type CredentialKeyMutationResult, type CredentialRevokeResult, type CredentialUngrantResult, type CurrentUserInfo, DEFAULT_API_URL, DEFAULT_STREAM_CHUNK_SIZE, type ErrorKind, type FilterOptions, type FilterResult, type FunctionLogMode, type GlobalSearchOptions, type GlobalSearchResult, type GlobalSearchResultItem, type HeadResult, type HistoryResult, type HomepageFeaturedListsResult, type IndexedFieldEntry, type IndexedFieldsReport, type LiveHandle, type LiveRepoEvent, type LiveSubscriptionLogOptions, type LiveThingHeadOptions, type LiveThingHistoryOptions, type LiveWatchResult, MAX_CONTENT_FIELD_BYTES, MAX_STREAM_APPEND_OPERATION_COUNT, type Operation, OperationBuilder, type OperationBuilderAddInput, type OperationBuilderClient, type OperationBuilderOp, type OperationBuilderOptions, type OperationSubmitResult, type OrgAccessResult, type OrgInfo, type OrgList, type OrgListMembersOptions, type OrgListOptions, type OrgMemberInfo, type OrgMemberList, type OrgRef, type OrgRole, type Page, type PageRequest, PartialStreamSubmissionError, type PingResult, type RefLink, type RefsOptions, type RefsResult, type RenameOperation, type RenameResult, type RepoAccessResult, type RepoConfigureStatsView, type RepoDescribeResult, type RepoExploreItem, type RepoExploreOptions, type RepoExploreResult, type RepoInfo, type RepoLicense, type RepoList, type RepoListForCallerOptions, type RepoListOptions, type RepoListPageOptions, type RepoListPageResult, type RepoLocator, type RepoRecentInfo, type RepoRef, type RepoShapeInstanceCountsView, type RepoSort, type RepoStatsBatchResult, type RepoStatsView, type RepoWithStatsInfo, type RequestEvent, type ResolveWrefResult, type RetractOp, type RetractOperation, type RetryPolicyOptions, type ReviseOp, type ReviseOperation, SDK_VERSION, type SearchOptions, type SearchResult, type Shape, type ShapeChange, type ShapeCreateOptions, type ShapeFields, type ShapeGetOptions, type ShapeHistory, type ShapeHistoryOptions, type ShapeList, type ShapeListOptions, type ShapeRef, type ShapeRemove, type ShapeReviseOptions, type ShapeValidatorResult, type StreamAppendInput, type StreamAppendResult, type StreamContinuationState, type SubscriptionBindCredentialsResult, type SubscriptionCompatCreateInput, type SubscriptionCompatUpdateInput, type SubscriptionInfo, type SubscriptionList, type SubscriptionUnbindCredentialsResult, type SynthesizedRepoContent, type ThingDetail, type ThingGet, type ThingGetManyResult, type ThingGetOptions, type ThingGetWithLease, type ThingGraphOptions, type ThingGraphResult, type ThingGraphValue, type ThingHead, type ThingHeadOptions, type ThingHeadRequest, type ThingHeadVersionsResult, type ThingHistory, type ThingHistoryOptions, type ThingItem, type ThingMetadata, type TokenInfo, type TokenResult, type UndeclaredFieldsWarning, type ValidationDiagnostic, type ValidationResult, type VerifiedCliCall, WarmHubClient, type WarmHubClientOptions, WarmHubError, type WarmHubErrorDetails, type WherePredicate, type WhoamiInfo, type WhoamiScopeEntry, type WireScopeEntry, connectionErrorMessage, contentFieldLimitError, countStreamAppendResultStatuses, isConnectionError, isRetryable, isWarmHubError, normalizeWref, resolveFunctionLogMode, sanitizeErrorMessage, sdkVersionIsBelowMinimum, streamAppendResultStatus, submitOperationsViaStream, toWarmHubError, validateAgainstShape, verifyCliCall };
5208
+ export { type AboutOptions, type AboutResult, type AccessResolveInput, type AccessResolveResult, type AccessTokenProvider, type ActionAttemptInfo, type ActionDeliveryTarget, type ActionLeaseAcquire, type ActionLeaseOp, type ActionListNotificationsOptions, type ActionListRunsOptions, type ActionLiveFeed, type ActionLiveFeedItem, type ActionLiveFeedOptions, type ActionNotificationInfo, type ActionRunInfo, type ActionRunStatsInfo, type ActionRunStatsOptions, type AddOp, type AddOperation, AllStreamOperationsFailedError, type Assertion, CLI_INSTALL_REPO_HEADER, CLI_SIGNATURE_HEADER, CLI_TIMESTAMP_HEADER, CONTENT_FIELD_LIMIT_ERROR, type CliCallSecrets, CliCallVerificationError, type CliCallVerificationFailureReason, type CollectionAddOp, type CollectionAddType, type CollectionContainsOptions, type CollectionContainsResult, type CollectionCreateOptions, type CollectionDiffOptions, type CollectionDiffResult, type CollectionMember, type CollectionMembersOptions, type CollectionMembersPage, type CollectionMembershipRole, type CollectionMutationResult, type CollectionQuerySourceOptions, type CollectionReadDataMode, type CollectionReadSummary, type CollectionReviseOptions, type CollectionStatsOptions, type CollectionStatsResult, type CollectionTag, type CollectionType, type ComponentHistory, type ComponentHistoryOptions, type ComponentInfo, type ComponentInstallResult, type ComponentList, type ComponentListOptions, type ComponentUninstallResult, type ComponentView, type CoreErrorKind, type CountOptions, type CountResult, type CredentialAuditEntry, type CredentialDeleteResult, type CredentialGrantResult, type CredentialInfo, type CredentialKeyMutationResult, type CredentialRevokeResult, type CredentialUngrantResult, type CurrentUserInfo, DEFAULT_API_URL, DEFAULT_STREAM_CHUNK_SIZE, type ErrorKind, type FilterOptions, type FilterResult, type FunctionLogMode, type GlobalSearchOptions, type GlobalSearchResult, type GlobalSearchResultItem, type HeadResult, type HistoryResult, type HistoryVersion, type HomepageFeaturedListsResult, type IndexedFieldEntry, type IndexedFieldsReport, type LiveHandle, type LiveRepoEvent, type LiveSubscriptionLogOptions, type LiveThingHeadOptions, type LiveThingHistoryOptions, type LiveWatchResult, MAX_CONTENT_FIELD_BYTES, MAX_STREAM_APPEND_OPERATION_COUNT, type Operation, OperationBuilder, type OperationBuilderAddInput, type OperationBuilderClient, type OperationBuilderOp, type OperationBuilderOptions, type OperationSubmitResult, type OrgAccessResult, type OrgInfo, type OrgList, type OrgListMembersOptions, type OrgListOptions, type OrgMemberInfo, type OrgMemberList, type OrgRef, type OrgRole, type Page, type PageRequest, PartialStreamSubmissionError, type PingResult, type RefLink, type RefsOptions, type RefsResult, type RenameOperation, type RenameResult, type RepoAccessResult, type RepoConfigureStatsView, type RepoDescribeResult, type RepoExploreBrowseOptions, type RepoExploreItem, type RepoExploreOptions, type RepoExploreResult, type RepoInfo, type RepoLicense, type RepoList, type RepoListForCallerOptions, type RepoListOptions, type RepoListPageOptions, type RepoListPageResult, type RepoLocator, type RepoRecentInfo, type RepoRef, type RepoShapeInstanceCountsView, type RepoSort, type RepoStatsBatchResult, type RepoStatsView, type RepoWithStatsInfo, type RequestEvent, type ResolveWrefResult, type RetractOp, type RetractOperation, type RetryPolicyOptions, type ReviseOp, type ReviseOperation, SDK_VERSION, type SearchOptions, type SearchResult, type Shape, type ShapeChange, type ShapeCreateOptions, type ShapeFields, type ShapeGetOptions, type ShapeHistory, type ShapeHistoryOptions, type ShapeList, type ShapeListOptions, type ShapeRef, type ShapeRemove, type ShapeReviseOptions, type ShapeValidatorResult, type StreamAppendInput, type StreamAppendResult, type StreamContinuationState, type SubscriptionBindCredentialsResult, type SubscriptionCompatCreateInput, type SubscriptionCompatUpdateInput, type SubscriptionInfo, type SubscriptionList, type SubscriptionUnbindCredentialsResult, type SynthesizedRepoContent, type ThingChanges, type ThingDetail, type ThingGet, type ThingGetManyResult, type ThingGetOptions, type ThingGetWithLease, type ThingGraphOptions, type ThingGraphResult, type ThingGraphValue, type ThingHead, type ThingHeadChangesOptions, type ThingHeadOptions, type ThingHeadRequest, type ThingHeadVersionsResult, type ThingHistory, type ThingHistoryOptions, type ThingItem, type ThingMetadata, type ThingQueryChangesOptions, type TokenInfo, type TokenResult, type UndeclaredFieldsWarning, type ValidationDiagnostic, type ValidationResult, type VerifiedCliCall, WarmHubClient, type WarmHubClientOptions, WarmHubError, type WarmHubErrorDetails, type WherePredicate, type WhoamiInfo, type WhoamiScopeEntry, type WireScopeEntry, connectionErrorMessage, contentFieldLimitError, countStreamAppendResultStatuses, isConnectionError, isRetryable, isWarmHubError, normalizeWref, resolveFunctionLogMode, sanitizeErrorMessage, sdkVersionIsBelowMinimum, streamAppendResultStatus, submitOperationsViaStream, toWarmHubError, validateAgainstShape, verifyCliCall };
package/dist/index.js CHANGED
@@ -1,3 +1,3 @@
1
- export { AllStreamOperationsFailedError, CLI_INSTALL_REPO_HEADER, CLI_SIGNATURE_HEADER, CLI_TIMESTAMP_HEADER, CONTENT_FIELD_LIMIT_ERROR, CliCallVerificationError, DEFAULT_API_URL, DEFAULT_STREAM_CHUNK_SIZE, MAX_CONTENT_FIELD_BYTES, MAX_STREAM_APPEND_OPERATION_COUNT, OperationBuilder, PartialStreamSubmissionError, SDK_VERSION, WarmHubClient, WarmHubError, connectionErrorMessage, contentFieldLimitError, countStreamAppendResultStatuses, isConnectionError, isRetryable, isWarmHubError, normalizeWref, resolveFunctionLogMode, sanitizeErrorMessage, sdkVersionIsBelowMinimum, streamAppendResultStatus, submitOperationsViaStream, toWarmHubError, validateAgainstShape, verifyCliCall } from './chunk-PMLASUR6.js';
1
+ export { AllStreamOperationsFailedError, CLI_INSTALL_REPO_HEADER, CLI_SIGNATURE_HEADER, CLI_TIMESTAMP_HEADER, CONTENT_FIELD_LIMIT_ERROR, CliCallVerificationError, DEFAULT_API_URL, DEFAULT_STREAM_CHUNK_SIZE, MAX_CONTENT_FIELD_BYTES, MAX_STREAM_APPEND_OPERATION_COUNT, OperationBuilder, PartialStreamSubmissionError, SDK_VERSION, WarmHubClient, WarmHubError, connectionErrorMessage, contentFieldLimitError, countStreamAppendResultStatuses, isConnectionError, isRetryable, isWarmHubError, normalizeWref, resolveFunctionLogMode, sanitizeErrorMessage, sdkVersionIsBelowMinimum, streamAppendResultStatus, submitOperationsViaStream, toWarmHubError, validateAgainstShape, verifyCliCall } from './chunk-6AHGGJL6.js';
2
2
  //# sourceMappingURL=index.js.map
3
3
  //# sourceMappingURL=index.js.map
package/dist/react.js CHANGED
@@ -1,5 +1,5 @@
1
- import { WarmHubClient } from './chunk-PMLASUR6.js';
2
- export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-PMLASUR6.js';
1
+ import { WarmHubClient } from './chunk-6AHGGJL6.js';
2
+ export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-6AHGGJL6.js';
3
3
  import { createContext, useMemo, useState, useEffect, useContext } from 'react';
4
4
  import { jsx } from 'react/jsx-runtime';
5
5
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@warmhub/sdk-ts",
3
- "version": "0.82.3",
3
+ "version": "0.83.0",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "The TypeScript SDK for WarmHub — create repos, commit and query data, and compound knowledge with your AI agents.",