@warmhub/sdk-ts 0.53.0 → 0.55.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
|
@@ -193,6 +193,15 @@ type ComponentDetail = {
|
|
|
193
193
|
};
|
|
194
194
|
}>;
|
|
195
195
|
};
|
|
196
|
+
type ComponentInstallResult$1 = {
|
|
197
|
+
componentRef: string;
|
|
198
|
+
componentName: string;
|
|
199
|
+
version: string;
|
|
200
|
+
state: 'ready' | 'degraded';
|
|
201
|
+
setupCreates: Array<string>;
|
|
202
|
+
errors: Array<string>;
|
|
203
|
+
hasSetup: boolean;
|
|
204
|
+
};
|
|
196
205
|
type ComponentListResult = {
|
|
197
206
|
items: Array<{
|
|
198
207
|
ref?: string;
|
|
@@ -224,6 +233,15 @@ type ComponentSummary = {
|
|
|
224
233
|
active: boolean;
|
|
225
234
|
wref: string;
|
|
226
235
|
};
|
|
236
|
+
type ComponentUninstallResult$1 = {
|
|
237
|
+
componentRef: string;
|
|
238
|
+
componentName: string;
|
|
239
|
+
state: 'uninstalled';
|
|
240
|
+
pausedSubscriptions: Array<string>;
|
|
241
|
+
tokensRevoked: number;
|
|
242
|
+
uninstallDispatched: boolean;
|
|
243
|
+
warnings: Array<string>;
|
|
244
|
+
};
|
|
227
245
|
type CredentialDeleteResult$1 = {
|
|
228
246
|
ok: true;
|
|
229
247
|
name: string;
|
|
@@ -1905,6 +1923,10 @@ type ComponentView = ComponentDetail;
|
|
|
1905
1923
|
/** @internal */
|
|
1906
1924
|
type ComponentList = ComponentListResult;
|
|
1907
1925
|
/** @internal */
|
|
1926
|
+
type ComponentInstallResult = ComponentInstallResult$1;
|
|
1927
|
+
/** @internal */
|
|
1928
|
+
type ComponentUninstallResult = ComponentUninstallResult$1;
|
|
1929
|
+
/** @internal */
|
|
1908
1930
|
type ComponentListOptions = {
|
|
1909
1931
|
limit?: number;
|
|
1910
1932
|
cursor?: string;
|
|
@@ -1951,7 +1973,6 @@ type ComponentRegistryResolveResult = {
|
|
|
1951
1973
|
/** Stored content hash of the resolved manifest; echo it back on setupCall. */
|
|
1952
1974
|
manifestHash: string;
|
|
1953
1975
|
hasSetup: boolean;
|
|
1954
|
-
installId: string;
|
|
1955
1976
|
};
|
|
1956
1977
|
type ComponentRegistrySetupCallInput = {
|
|
1957
1978
|
installId: string;
|
|
@@ -2049,6 +2070,28 @@ type RepoInfo = {
|
|
|
2049
2070
|
};
|
|
2050
2071
|
/** @internal */
|
|
2051
2072
|
type RepoList = RepoListResult;
|
|
2073
|
+
/**
|
|
2074
|
+
* A cross-org search hit (repo or component). GH-4383.
|
|
2075
|
+
* @see https://docs.warmhub.ai/sdk-reference/type-aliases/globalsearchresultitem/
|
|
2076
|
+
*/
|
|
2077
|
+
type GlobalSearchResultItem = {
|
|
2078
|
+
kind: 'repo' | 'component';
|
|
2079
|
+
orgName: string;
|
|
2080
|
+
name: string;
|
|
2081
|
+
description: string | null;
|
|
2082
|
+
};
|
|
2083
|
+
/** @internal */
|
|
2084
|
+
type GlobalSearchResult = {
|
|
2085
|
+
items: GlobalSearchResultItem[];
|
|
2086
|
+
nextCursor?: string;
|
|
2087
|
+
};
|
|
2088
|
+
/**
|
|
2089
|
+
* @see https://docs.warmhub.ai/sdk-reference/type-aliases/globalsearchoptions/
|
|
2090
|
+
*/
|
|
2091
|
+
type GlobalSearchOptions = {
|
|
2092
|
+
limit?: number;
|
|
2093
|
+
cursor?: string;
|
|
2094
|
+
};
|
|
2052
2095
|
/** @internal */
|
|
2053
2096
|
type OrgListOptions = {
|
|
2054
2097
|
includeArchived?: boolean;
|
|
@@ -2941,12 +2984,55 @@ declare class WarmHubClient {
|
|
|
2941
2984
|
* List components installed in a repository.
|
|
2942
2985
|
*
|
|
2943
2986
|
* Pass pagination options when a repository may have many installed components.
|
|
2987
|
+
*
|
|
2988
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
2989
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
2990
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
2991
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
2992
|
+
* token.
|
|
2944
2993
|
*/
|
|
2945
2994
|
list: (orgName: string, repoName: string, opts?: ComponentListOptions) => Promise<ComponentList>;
|
|
2995
|
+
/**
|
|
2996
|
+
* Search public registered components across all orgs (GH-4383).
|
|
2997
|
+
* Public-only at launch. Distinct from listing components installed in a
|
|
2998
|
+
* repo (`component.list`).
|
|
2999
|
+
*/
|
|
3000
|
+
search: (query: string, opts?: GlobalSearchOptions) => Promise<GlobalSearchResult>;
|
|
2946
3001
|
/**
|
|
2947
3002
|
* Fetch one installed component by its `Org/Name` ref.
|
|
2948
3003
|
*/
|
|
2949
3004
|
get: (orgName: string, repoName: string, componentRef: string) => Promise<ComponentView>;
|
|
3005
|
+
/**
|
|
3006
|
+
* Install a registered component into a repository (GH-4610).
|
|
3007
|
+
*
|
|
3008
|
+
* Backend-driven: the server resolves the registration and its latest
|
|
3009
|
+
* published manifest, reconciles the shapes/subscriptions/credentials/seeds
|
|
3010
|
+
* into the target repo, and runs the component's optional setup callback —
|
|
3011
|
+
* the same pipeline `wh component install <org/name>` drives. `orgName` /
|
|
3012
|
+
* `repoName` identify the INSTALL repo; `componentRef` is the
|
|
3013
|
+
* `<org>/<name>` of the component to install. Requires `things:write` on the
|
|
3014
|
+
* install repo; private registrations require owner-org membership.
|
|
3015
|
+
*
|
|
3016
|
+
* Reinstall is idempotent: the install identity (`installId`) is reused so
|
|
3017
|
+
* runtime tokens keyed on it survive teardown/reinstall.
|
|
3018
|
+
*/
|
|
3019
|
+
install: (orgName: string, repoName: string, componentRef: string) => Promise<ComponentInstallResult>;
|
|
3020
|
+
/**
|
|
3021
|
+
* Uninstall a registered component from a repository (GH-4677).
|
|
3022
|
+
*
|
|
3023
|
+
* Backend-driven terminal teardown — the sibling of {@link install}: the
|
|
3024
|
+
* server pauses the install's subscriptions per the manifest teardown
|
|
3025
|
+
* policy, revokes its tokens in place, dispatches the component's optional
|
|
3026
|
+
* uninstall callback, and marks the repo-local `ComponentInstall` record
|
|
3027
|
+
* `uninstalled`. The same pipeline `wh component teardown <org/name>` drives.
|
|
3028
|
+
* `orgName` / `repoName` identify the INSTALL repo; `componentRef` is the
|
|
3029
|
+
* `<org>/<name>` of the component. Requires `things:write` on the install
|
|
3030
|
+
* repo; private registrations require owner-org membership.
|
|
3031
|
+
*
|
|
3032
|
+
* Non-destructive: manifest shapes and seeded data are left intact (only
|
|
3033
|
+
* repo deletion removes those) and reinstall revives the install.
|
|
3034
|
+
*/
|
|
3035
|
+
uninstall: (orgName: string, repoName: string, componentRef: string) => Promise<ComponentUninstallResult>;
|
|
2950
3036
|
/**
|
|
2951
3037
|
* Registered-component identity and install-pipeline operations.
|
|
2952
3038
|
*
|
|
@@ -3166,8 +3252,19 @@ declare class WarmHubClient {
|
|
|
3166
3252
|
* List repositories in an organization.
|
|
3167
3253
|
*
|
|
3168
3254
|
* Archived repositories are hidden by default. Search and sort options are applied before pagination.
|
|
3255
|
+
*
|
|
3256
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3257
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3258
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3259
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3260
|
+
* token.
|
|
3169
3261
|
*/
|
|
3170
3262
|
list: (orgName: string, opts?: RepoListOptions) => Promise<RepoList>;
|
|
3263
|
+
/**
|
|
3264
|
+
* Search public repos across all orgs (GH-4383). Public-only at launch;
|
|
3265
|
+
* BM25 over name/description/shape vocabulary/README.
|
|
3266
|
+
*/
|
|
3267
|
+
search: (query: string, opts?: GlobalSearchOptions) => Promise<GlobalSearchResult>;
|
|
3171
3268
|
/**
|
|
3172
3269
|
* Create a repository inside an organization.
|
|
3173
3270
|
*
|
|
@@ -3238,6 +3335,12 @@ declare class WarmHubClient {
|
|
|
3238
3335
|
* Each item includes exact active counts, an activity-oriented `lastWriteAt`, and a `hasErrors` flag for terminal action failures.
|
|
3239
3336
|
*
|
|
3240
3337
|
* Search and sort are applied before pagination, so cursors remain stable across the filtered and ordered list.
|
|
3338
|
+
*
|
|
3339
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3340
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3341
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3342
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3343
|
+
* token.
|
|
3241
3344
|
*/
|
|
3242
3345
|
listPage: (orgName: string, opts?: RepoListPageOptions) => Promise<RepoListPageResult>;
|
|
3243
3346
|
/**
|
|
@@ -3354,6 +3457,12 @@ declare class WarmHubClient {
|
|
|
3354
3457
|
* Return add, revise, retract, and rename history for a shape.
|
|
3355
3458
|
*
|
|
3356
3459
|
* Use pagination options for long-lived shapes with many revisions.
|
|
3460
|
+
*
|
|
3461
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3462
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3463
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3464
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3465
|
+
* token.
|
|
3357
3466
|
*/
|
|
3358
3467
|
history: (orgName: string, repoName: string, name: string, opts?: ShapeHistoryOptions) => Promise<ShapeHistory>;
|
|
3359
3468
|
};
|
|
@@ -3460,6 +3569,12 @@ declare class WarmHubClient {
|
|
|
3460
3569
|
* Query the live delivery feed for a subscription.
|
|
3461
3570
|
*
|
|
3462
3571
|
* Use this for polling or live-log views that need recent delivery status entries.
|
|
3572
|
+
*
|
|
3573
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3574
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3575
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3576
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3577
|
+
* token.
|
|
3463
3578
|
*/
|
|
3464
3579
|
liveFeed: (orgName: string, repoName: string, subscriptionName: string, opts?: ActionLiveFeedOptions) => Promise<ActionLiveFeed>;
|
|
3465
3580
|
/**
|
|
@@ -3497,18 +3612,36 @@ declare class WarmHubClient {
|
|
|
3497
3612
|
* Filter by shape, kind, assertion target, or glob `match` pattern, and choose the data mode appropriate for the payload size. Component filters can narrow results to component-owned records or hide component infrastructure records.
|
|
3498
3613
|
*
|
|
3499
3614
|
* Tokenless reads of public repositories have stricter page-size and page-count limits than authenticated reads.
|
|
3615
|
+
*
|
|
3616
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3617
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3618
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3619
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3620
|
+
* token.
|
|
3500
3621
|
*/
|
|
3501
3622
|
head: (orgName: string, repoName: string, opts?: ThingHeadOptions) => Promise<ThingHead>;
|
|
3502
3623
|
/**
|
|
3503
3624
|
* Iterate every current HEAD row matching the supplied filters.
|
|
3504
3625
|
*
|
|
3505
3626
|
* Prefer this over hand-written cursor loops when scanning all matching records. Pass `opts.cursor` to resume from a saved cursor; the iterator advances the cursor automatically after the first request. Pass `limit` to control page size.
|
|
3627
|
+
*
|
|
3628
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3629
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3630
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3631
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3632
|
+
* token.
|
|
3506
3633
|
*/
|
|
3507
3634
|
headIter: (orgName: string, repoName: string, opts?: ThingHeadOptions) => AsyncIterableIterator<ThingItem>;
|
|
3508
3635
|
/**
|
|
3509
3636
|
* Materialize every current HEAD row matching the supplied filters.
|
|
3510
3637
|
*
|
|
3511
3638
|
* Use `max` to guard memory usage; throws a `WarmHubError` with kind `VALIDATION_ERROR` once more than `max` items have actually been observed across pages.
|
|
3639
|
+
*
|
|
3640
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3641
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3642
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3643
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3644
|
+
* token.
|
|
3512
3645
|
*/
|
|
3513
3646
|
headAll: (orgName: string, repoName: string, opts?: ThingHeadOptions & {
|
|
3514
3647
|
max?: number;
|
|
@@ -3594,6 +3727,12 @@ declare class WarmHubClient {
|
|
|
3594
3727
|
* Return version history and timeline metadata for repository records.
|
|
3595
3728
|
*
|
|
3596
3729
|
* Provide at least one selector: a concrete wref, a shape filter, or an assertion target. Shape- and target-filtered histories support pagination and optional collection resolution.
|
|
3730
|
+
*
|
|
3731
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3732
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3733
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3734
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3735
|
+
* token.
|
|
3597
3736
|
*/
|
|
3598
3737
|
history: (orgName: string | undefined, repoName: string | undefined, opts: ThingHistoryOptions) => Promise<ThingHistory>;
|
|
3599
3738
|
/**
|
|
@@ -3611,6 +3750,12 @@ declare class WarmHubClient {
|
|
|
3611
3750
|
*
|
|
3612
3751
|
* Filter by assertion shape or glob `match` pattern, optionally resolve collection targets, and page through large assertion sets with `limit` and `cursor`.
|
|
3613
3752
|
*
|
|
3753
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3754
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3755
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3756
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3757
|
+
* token.
|
|
3758
|
+
*
|
|
3614
3759
|
* Returns `{ target?, assertions, nextCursor? }`.
|
|
3615
3760
|
* The array is named `assertions`, **not** `items`. This breaks the repo-wide
|
|
3616
3761
|
* `items` convention used by `HeadResult`, `FilterResult`, `SearchResult`,
|
|
@@ -3628,12 +3773,24 @@ declare class WarmHubClient {
|
|
|
3628
3773
|
* Iterate every assertion about a thing or collection target.
|
|
3629
3774
|
*
|
|
3630
3775
|
* Prefer this over hand-written cursor loops when scanning all matching assertions. The iterator reads the `assertions` envelope field and advances the cursor automatically; pass `opts.cursor` to resume from a saved cursor and `limit` to control page size.
|
|
3776
|
+
*
|
|
3777
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3778
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3779
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3780
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3781
|
+
* token.
|
|
3631
3782
|
*/
|
|
3632
3783
|
aboutIter: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: AboutOptions) => AsyncIterableIterator<Assertion>;
|
|
3633
3784
|
/**
|
|
3634
3785
|
* Materialize every assertion about a thing or collection target.
|
|
3635
3786
|
*
|
|
3636
3787
|
* Use `max` to guard memory usage; throws a `WarmHubError` with kind `VALIDATION_ERROR` once more than `max` assertions have actually been observed across pages.
|
|
3788
|
+
*
|
|
3789
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3790
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3791
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3792
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3793
|
+
* token.
|
|
3637
3794
|
*/
|
|
3638
3795
|
aboutAll: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: AboutOptions & {
|
|
3639
3796
|
max?: number;
|
|
@@ -3642,18 +3799,36 @@ declare class WarmHubClient {
|
|
|
3642
3799
|
* Query repository records by shape, kind, assertion target, text filters, or glob `match` pattern.
|
|
3643
3800
|
*
|
|
3644
3801
|
* Use this for structured reads where the caller controls filters. For ranked text or vector search, use `thing.search`. For count-only reads, use `thing.count`.
|
|
3802
|
+
*
|
|
3803
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3804
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3805
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3806
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3807
|
+
* token.
|
|
3645
3808
|
*/
|
|
3646
3809
|
query: (orgName: string, repoName: string, opts?: FilterOptions) => Promise<FilterResult>;
|
|
3647
3810
|
/**
|
|
3648
3811
|
* Iterate every repository record matching the supplied filters.
|
|
3649
3812
|
*
|
|
3650
3813
|
* Prefer this over hand-written cursor loops when scanning all matching records. Pass `opts.cursor` to resume from a saved cursor; the iterator advances the cursor automatically after the first request. Pass `limit` to control page size.
|
|
3814
|
+
*
|
|
3815
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3816
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3817
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3818
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3819
|
+
* token.
|
|
3651
3820
|
*/
|
|
3652
3821
|
queryIter: (orgName: string, repoName: string, opts?: FilterOptions) => AsyncIterableIterator<ThingItem>;
|
|
3653
3822
|
/**
|
|
3654
3823
|
* Materialize every repository record matching the supplied filters.
|
|
3655
3824
|
*
|
|
3656
3825
|
* Use `max` to guard memory usage; throws a `WarmHubError` with kind `VALIDATION_ERROR` once more than `max` items have actually been observed across pages.
|
|
3826
|
+
*
|
|
3827
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3828
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3829
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3830
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3831
|
+
* token.
|
|
3657
3832
|
*/
|
|
3658
3833
|
queryAll: (orgName: string, repoName: string, opts?: FilterOptions & {
|
|
3659
3834
|
max?: number;
|
|
@@ -3662,6 +3837,12 @@ declare class WarmHubClient {
|
|
|
3662
3837
|
* Search repository records with text, vector, or hybrid mode.
|
|
3663
3838
|
*
|
|
3664
3839
|
* When searching with an assertion target or collection resolution, pages may be sparse; keep paginating until `nextCursor` is absent.
|
|
3840
|
+
*
|
|
3841
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3842
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3843
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3844
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3845
|
+
* token.
|
|
3665
3846
|
*/
|
|
3666
3847
|
search: (orgName: string, repoName: string, query: string, opts?: SearchOptions) => Promise<SearchResult>;
|
|
3667
3848
|
/**
|
|
@@ -3672,18 +3853,36 @@ declare class WarmHubClient {
|
|
|
3672
3853
|
* Query wref-typed field references for a record.
|
|
3673
3854
|
*
|
|
3674
3855
|
* Inbound mode finds records whose wref fields point at the supplied wref. Outbound mode finds records that the supplied record points to. Inbound queries can be narrowed to a field path.
|
|
3856
|
+
*
|
|
3857
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3858
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3859
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3860
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3861
|
+
* token.
|
|
3675
3862
|
*/
|
|
3676
3863
|
refs: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: RefsOptions) => Promise<RefsResult>;
|
|
3677
3864
|
/**
|
|
3678
3865
|
* Iterate every wref-typed field reference for a record.
|
|
3679
3866
|
*
|
|
3680
3867
|
* Prefer this over hand-written cursor loops when scanning all matching references. Pass `opts.cursor` to resume from a saved cursor; the iterator advances the cursor automatically after the first request. Pass `limit` to control page size.
|
|
3868
|
+
*
|
|
3869
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3870
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3871
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3872
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3873
|
+
* token.
|
|
3681
3874
|
*/
|
|
3682
3875
|
refsIter: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: RefsOptions) => AsyncIterableIterator<RefLink>;
|
|
3683
3876
|
/**
|
|
3684
3877
|
* Materialize every wref-typed field reference for a record.
|
|
3685
3878
|
*
|
|
3686
3879
|
* Use `max` to guard memory usage; throws a `WarmHubError` with kind `VALIDATION_ERROR` once more than `max` refs have actually been observed across pages.
|
|
3880
|
+
*
|
|
3881
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3882
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3883
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3884
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3885
|
+
* token.
|
|
3687
3886
|
*/
|
|
3688
3887
|
refsAll: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: RefsOptions & {
|
|
3689
3888
|
max?: number;
|
|
@@ -3698,14 +3897,32 @@ declare class WarmHubClient {
|
|
|
3698
3897
|
* Stream refreshed `thing.head` results whenever the repository changes.
|
|
3699
3898
|
*
|
|
3700
3899
|
* The SDK re-runs the underlying `thing.head` query after each invalidation and passes the latest snapshot to `onUpdate`.
|
|
3900
|
+
*
|
|
3901
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3902
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3903
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3904
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3905
|
+
* token.
|
|
3701
3906
|
*/
|
|
3702
3907
|
thingHead: (orgName: string, repoName: string, opts: LiveThingHeadOptions | undefined, onUpdate: (result: ThingHead) => void | Promise<void>) => Promise<LiveHandle>;
|
|
3703
3908
|
/**
|
|
3704
3909
|
* Stream refreshed history results for a single wref whenever the repository changes.
|
|
3910
|
+
*
|
|
3911
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3912
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3913
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3914
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3915
|
+
* token.
|
|
3705
3916
|
*/
|
|
3706
3917
|
thingHistory: (orgName: string, repoName: string, opts: LiveThingHistoryOptions, onUpdate: (result: ThingHistory) => void | Promise<void>) => Promise<LiveHandle>;
|
|
3707
3918
|
/**
|
|
3708
3919
|
* Stream refreshed action live-feed entries for a subscription.
|
|
3920
|
+
*
|
|
3921
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
3922
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
3923
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
3924
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
3925
|
+
* token.
|
|
3709
3926
|
*/
|
|
3710
3927
|
subscriptionLog: (orgName: string, repoName: string, subscriptionName: string, opts: LiveSubscriptionLogOptions | undefined, onUpdate: (result: ActionLiveFeed) => void | Promise<void>) => Promise<LiveHandle>;
|
|
3711
3928
|
/**
|
|
@@ -3925,6 +4142,12 @@ declare class WarmHubClient {
|
|
|
3925
4142
|
* Query the live delivery feed for a subscription.
|
|
3926
4143
|
*
|
|
3927
4144
|
* Use this for polling or live-log views that need recent delivery status entries.
|
|
4145
|
+
*
|
|
4146
|
+
* Cursor contract: cursors are short-lived resume tokens for the same query
|
|
4147
|
+
* and result scope. If filters, visibility, or backing streams change, the
|
|
4148
|
+
* backend may reject a saved cursor with `VALIDATION_ERROR` / `Invalid
|
|
4149
|
+
* cursor`; restart the query without `cursor` instead of retrying the stale
|
|
4150
|
+
* token.
|
|
3928
4151
|
*/
|
|
3929
4152
|
liveFeed: (orgName: string, repoName: string, subscriptionName: string, opts?: ActionLiveFeedOptions) => Promise<ActionLiveFeed>;
|
|
3930
4153
|
/**
|
|
@@ -3958,4 +4181,4 @@ declare class WarmHubClient {
|
|
|
3958
4181
|
private watchRepoQuery;
|
|
3959
4182
|
}
|
|
3960
4183
|
|
|
3961
|
-
export { type AboutOptions, type AboutResult, type AccessResolveInput, type AccessResolveResult, type AccessTokenProvider, type ActionAttemptInfo, 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 CollectionAbout, type CollectionTag, type ComponentInfo, type ComponentList, type ComponentListOptions, 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 HeadResult, type HistoryResult, 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 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 RenameResult, type RepoAccessResult, type RepoConfigureStatsView, type RepoDescribeResult, type RepoInfo, 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 };
|
|
4184
|
+
export { type AboutOptions, type AboutResult, type AccessResolveInput, type AccessResolveResult, type AccessTokenProvider, type ActionAttemptInfo, 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 CollectionAbout, type CollectionTag, 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 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 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 RenameResult, type RepoAccessResult, type RepoConfigureStatsView, type RepoDescribeResult, type RepoInfo, 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 };
|
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-
|
|
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-EXE36J6Z.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-
|
|
2
|
-
export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-
|
|
1
|
+
import { WarmHubClient } from './chunk-EXE36J6Z.js';
|
|
2
|
+
export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-EXE36J6Z.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