@warmhub/sdk-ts 0.48.0 → 0.49.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/{chunk-FPHSF4T7.js → chunk-CVMYSRPS.js} +88 -12
- package/dist/chunk-CVMYSRPS.js.map +1 -0
- package/dist/index.d.ts +186 -18
- package/dist/index.js +1 -1
- package/dist/react.js +2 -2
- package/package.json +1 -1
- package/dist/chunk-FPHSF4T7.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -121,6 +121,11 @@ type ComponentDetail = {
|
|
|
121
121
|
aboutWref?: string;
|
|
122
122
|
committerWref?: string;
|
|
123
123
|
createdByWref?: string;
|
|
124
|
+
metadata?: {
|
|
125
|
+
durableId: string;
|
|
126
|
+
thingCreatedAt: number;
|
|
127
|
+
versionCreatedAt: number;
|
|
128
|
+
};
|
|
124
129
|
};
|
|
125
130
|
ownedShapes: Array<{
|
|
126
131
|
name: string;
|
|
@@ -145,6 +150,11 @@ type ComponentDetail = {
|
|
|
145
150
|
data?: unknown;
|
|
146
151
|
active: boolean;
|
|
147
152
|
aboutWref?: string;
|
|
153
|
+
metadata?: {
|
|
154
|
+
durableId: string;
|
|
155
|
+
thingCreatedAt: number;
|
|
156
|
+
versionCreatedAt: number;
|
|
157
|
+
};
|
|
148
158
|
}>;
|
|
149
159
|
};
|
|
150
160
|
type ComponentListResult = {
|
|
@@ -259,24 +269,31 @@ type StreamAppendInput$1 = {
|
|
|
259
269
|
kind: 'shape';
|
|
260
270
|
name: string;
|
|
261
271
|
data: unknown;
|
|
272
|
+
expectedVersion?: number;
|
|
262
273
|
active?: never;
|
|
274
|
+
leaseId?: string;
|
|
263
275
|
} | {
|
|
264
276
|
operation: 'revise';
|
|
265
277
|
kind: 'thing';
|
|
266
278
|
name: string;
|
|
267
279
|
data: unknown;
|
|
280
|
+
expectedVersion?: number;
|
|
268
281
|
active?: never;
|
|
282
|
+
leaseId?: string;
|
|
269
283
|
} | {
|
|
270
284
|
operation: 'revise';
|
|
271
285
|
kind: 'assertion';
|
|
272
286
|
name: string;
|
|
273
287
|
data: unknown;
|
|
288
|
+
expectedVersion?: number;
|
|
274
289
|
active?: never;
|
|
290
|
+
leaseId?: string;
|
|
275
291
|
} | {
|
|
276
292
|
operation: 'retract';
|
|
277
293
|
name: string;
|
|
278
294
|
kind?: 'thing' | 'assertion' | 'shape' | 'collection';
|
|
279
295
|
reason?: string;
|
|
296
|
+
leaseId?: string;
|
|
280
297
|
}>;
|
|
281
298
|
};
|
|
282
299
|
type StreamAppendResult$1 = {
|
|
@@ -293,6 +310,14 @@ type StreamAppendResult$1 = {
|
|
|
293
310
|
error?: {
|
|
294
311
|
code: string;
|
|
295
312
|
message: string;
|
|
313
|
+
details?: {
|
|
314
|
+
reason: 'expected_version_mismatch';
|
|
315
|
+
expectedVersion: number;
|
|
316
|
+
currentVersion: number;
|
|
317
|
+
} | {
|
|
318
|
+
reason: 'lease_held';
|
|
319
|
+
leaseExpiresAt: string;
|
|
320
|
+
};
|
|
296
321
|
};
|
|
297
322
|
resolvedName?: string;
|
|
298
323
|
retryable?: boolean;
|
|
@@ -412,6 +437,11 @@ type ThingGetManyResult$1 = {
|
|
|
412
437
|
aboutWref?: string;
|
|
413
438
|
committerWref?: string;
|
|
414
439
|
createdByWref?: string;
|
|
440
|
+
metadata?: {
|
|
441
|
+
durableId: string;
|
|
442
|
+
thingCreatedAt: number;
|
|
443
|
+
versionCreatedAt: number;
|
|
444
|
+
};
|
|
415
445
|
}>;
|
|
416
446
|
missing: Array<string>;
|
|
417
447
|
};
|
|
@@ -635,7 +665,9 @@ interface AddOperation {
|
|
|
635
665
|
*/
|
|
636
666
|
interface ReviseOperation {
|
|
637
667
|
/**
|
|
638
|
-
* Operation discriminator.
|
|
668
|
+
* Operation discriminator. Set `revise` explicitly — an omitted discriminator
|
|
669
|
+
* normalizes as `add`, not `revise`. (Supplying `expectedVersion` without
|
|
670
|
+
* `operation: 'revise'` throws rather than silently dropping the precondition.)
|
|
639
671
|
*/
|
|
640
672
|
operation?: 'revise';
|
|
641
673
|
/**
|
|
@@ -654,12 +686,25 @@ interface ReviseOperation {
|
|
|
654
686
|
* New shape-validated data payload.
|
|
655
687
|
*/
|
|
656
688
|
data?: unknown;
|
|
689
|
+
/**
|
|
690
|
+
* Optional optimistic-concurrency precondition. When supplied, the revise is
|
|
691
|
+
* applied only if the target is still at this version number. A stale value
|
|
692
|
+
* produces a `CONFLICT` error with `details.reason = 'expected_version_mismatch'`.
|
|
693
|
+
* Absent field preserves today's behavior exactly (opt-in).
|
|
694
|
+
*/
|
|
695
|
+
expectedVersion?: number;
|
|
657
696
|
/**
|
|
658
697
|
* Type-level guard: revise cannot toggle activity. The field is declared
|
|
659
698
|
* `never` so passing `active: true` or `active: false` is a TypeScript error.
|
|
660
699
|
* To mark an entity inactive, use a {@link RetractOperation} instead.
|
|
661
700
|
*/
|
|
662
701
|
active?: never;
|
|
702
|
+
/**
|
|
703
|
+
* Optional read-lease token (#3625) returned by `thing.getWithLease`. A
|
|
704
|
+
* matching token auto-releases the lease on commit; a mismatch (or absence
|
|
705
|
+
* against a live lease) is rejected with `LEASE_UNAVAILABLE`.
|
|
706
|
+
*/
|
|
707
|
+
leaseId?: string;
|
|
663
708
|
}
|
|
664
709
|
/**
|
|
665
710
|
* Retract operation accepted by `client.commit.apply`. Marks the target as
|
|
@@ -684,6 +729,12 @@ interface RetractOperation {
|
|
|
684
729
|
* Optional human-readable retraction reason.
|
|
685
730
|
*/
|
|
686
731
|
reason?: string;
|
|
732
|
+
/**
|
|
733
|
+
* Optional read-lease token (#3625) returned by `thing.getWithLease`. A
|
|
734
|
+
* matching token auto-releases the lease on commit; a mismatch (or absence
|
|
735
|
+
* against a live lease) is rejected with `LEASE_UNAVAILABLE`.
|
|
736
|
+
*/
|
|
737
|
+
leaseId?: string;
|
|
687
738
|
}
|
|
688
739
|
/**
|
|
689
740
|
* Commit operation accepted by `client.commit.apply`. Discriminated union over
|
|
@@ -756,6 +807,7 @@ type SubmittedStreamResult = {
|
|
|
756
807
|
error?: {
|
|
757
808
|
code: string;
|
|
758
809
|
message: string;
|
|
810
|
+
details?: NonNullable<StreamAppendResult$1['results'][number]['error']>['details'];
|
|
759
811
|
};
|
|
760
812
|
submittedName?: string;
|
|
761
813
|
resolvedName?: string;
|
|
@@ -1264,6 +1316,20 @@ interface ReviseOp {
|
|
|
1264
1316
|
* New shape-validated data payload.
|
|
1265
1317
|
*/
|
|
1266
1318
|
readonly data?: unknown;
|
|
1319
|
+
/**
|
|
1320
|
+
* Optional optimistic-concurrency precondition. When supplied, the revise is
|
|
1321
|
+
* applied only if the target is still at this version number. A stale value
|
|
1322
|
+
* produces a `CONFLICT` error with `details.reason = 'expected_version_mismatch'`.
|
|
1323
|
+
* Absent field preserves today's behavior exactly (opt-in).
|
|
1324
|
+
*/
|
|
1325
|
+
readonly expectedVersion?: number;
|
|
1326
|
+
/**
|
|
1327
|
+
* Optional read-lease token (#3625) returned by `thing.getWithLease`. When
|
|
1328
|
+
* it matches the target's active lease the lease auto-releases on commit;
|
|
1329
|
+
* a mismatch (or absence against a live lease) is rejected with
|
|
1330
|
+
* `LEASE_UNAVAILABLE`.
|
|
1331
|
+
*/
|
|
1332
|
+
readonly leaseId?: string;
|
|
1267
1333
|
}
|
|
1268
1334
|
/**
|
|
1269
1335
|
* Builder retract operation.
|
|
@@ -1286,6 +1352,13 @@ interface RetractOp {
|
|
|
1286
1352
|
* Optional human-readable retraction reason.
|
|
1287
1353
|
*/
|
|
1288
1354
|
readonly reason?: string;
|
|
1355
|
+
/**
|
|
1356
|
+
* Optional read-lease token (#3625) returned by `thing.getWithLease`. When
|
|
1357
|
+
* it matches the target's active lease the lease auto-releases on commit;
|
|
1358
|
+
* a mismatch (or absence against a live lease) is rejected with
|
|
1359
|
+
* `LEASE_UNAVAILABLE`.
|
|
1360
|
+
*/
|
|
1361
|
+
readonly leaseId?: string;
|
|
1289
1362
|
}
|
|
1290
1363
|
/**
|
|
1291
1364
|
* Operation queued by `OperationBuilder`.
|
|
@@ -1406,6 +1479,7 @@ declare class OperationBuilder {
|
|
|
1406
1479
|
name: string;
|
|
1407
1480
|
kind?: 'thing' | 'assertion' | 'shape' | 'collection';
|
|
1408
1481
|
reason?: string;
|
|
1482
|
+
leaseId?: string;
|
|
1409
1483
|
}): this;
|
|
1410
1484
|
/**
|
|
1411
1485
|
* Return the queued operations.
|
|
@@ -2038,6 +2112,25 @@ type RepoLocator = {
|
|
|
2038
2112
|
orgName: string;
|
|
2039
2113
|
repoName: string;
|
|
2040
2114
|
};
|
|
2115
|
+
/**
|
|
2116
|
+
* Stable identity and creation timestamps embedded on every thing-like read
|
|
2117
|
+
* result. `durableId` is a self-routing, self-verifying token (Crockford base32
|
|
2118
|
+
* over `repo_id + things.id + CRC-32C`) that remains identical before and after
|
|
2119
|
+
* rename and across revise/retract. `thingCreatedAt` records the thing's birth
|
|
2120
|
+
* date (stable across all mutations); `versionCreatedAt` is the timestamp of
|
|
2121
|
+
* the current version (advances on each revise). History rows carry only
|
|
2122
|
+
* `durableId` and `thingCreatedAt` — omit `versionCreatedAt`.
|
|
2123
|
+
*
|
|
2124
|
+
* Pass a bare `durableId` (optionally with `@vN`) wherever a wref is accepted
|
|
2125
|
+
* on read surfaces; `orgName`/`repoName` may be omitted for self-routing reads.
|
|
2126
|
+
*
|
|
2127
|
+
* @see https://docs.warmhub.ai/data-modeling/wrefs/#durable-ids
|
|
2128
|
+
*/
|
|
2129
|
+
type ThingMetadata = {
|
|
2130
|
+
durableId: string;
|
|
2131
|
+
thingCreatedAt: number;
|
|
2132
|
+
versionCreatedAt: number;
|
|
2133
|
+
};
|
|
2041
2134
|
/** @internal */
|
|
2042
2135
|
type ThingItem = {
|
|
2043
2136
|
wref: string;
|
|
@@ -2049,6 +2142,7 @@ type ThingItem = {
|
|
|
2049
2142
|
active?: boolean;
|
|
2050
2143
|
data?: unknown;
|
|
2051
2144
|
aboutWref?: string;
|
|
2145
|
+
metadata?: ThingMetadata;
|
|
2052
2146
|
[key: string]: unknown;
|
|
2053
2147
|
};
|
|
2054
2148
|
/** @internal */
|
|
@@ -2060,6 +2154,22 @@ type HeadResult = {
|
|
|
2060
2154
|
};
|
|
2061
2155
|
/** @internal */
|
|
2062
2156
|
type ThingGet = ThingDetail;
|
|
2157
|
+
/**
|
|
2158
|
+
* Returned by `client.thing.getWithLease`. Everything `client.thing.get`
|
|
2159
|
+
* returns, plus a `lease` block ({@link ThingGetWithLease.lease}) the holder
|
|
2160
|
+
* echoes back on the subsequent `revise`/`retract` (`leaseId`) and on
|
|
2161
|
+
* `client.thing.releaseLease`. The `version` and the `lease` come from a
|
|
2162
|
+
* single backend snapshot, so the holder knows exactly which version it
|
|
2163
|
+
* leased.
|
|
2164
|
+
*
|
|
2165
|
+
* @see https://docs.warmhub.ai/data-modeling/things/
|
|
2166
|
+
*/
|
|
2167
|
+
type ThingGetWithLease = ThingDetail & {
|
|
2168
|
+
lease: {
|
|
2169
|
+
id: string;
|
|
2170
|
+
expiresAt: string;
|
|
2171
|
+
};
|
|
2172
|
+
};
|
|
2063
2173
|
/**
|
|
2064
2174
|
* Full record shape for a single Thing returned by single-record SDK
|
|
2065
2175
|
* reads. Returned by `client.thing.get` and `client.thing.resolve`, the
|
|
@@ -2090,6 +2200,7 @@ type ThingDetail = {
|
|
|
2090
2200
|
aboutWref?: string;
|
|
2091
2201
|
committerWref?: string;
|
|
2092
2202
|
createdByWref?: string;
|
|
2203
|
+
metadata?: ThingMetadata;
|
|
2093
2204
|
[key: string]: unknown;
|
|
2094
2205
|
};
|
|
2095
2206
|
/** @internal */
|
|
@@ -2134,6 +2245,7 @@ type HistoryResult = {
|
|
|
2134
2245
|
data?: unknown;
|
|
2135
2246
|
committerWref?: string;
|
|
2136
2247
|
createdByWref?: string;
|
|
2248
|
+
metadata?: Pick<ThingMetadata, 'durableId' | 'thingCreatedAt'>;
|
|
2137
2249
|
[key: string]: unknown;
|
|
2138
2250
|
}>;
|
|
2139
2251
|
nextCursor?: string;
|
|
@@ -2351,6 +2463,13 @@ type WherePredicateBase = {
|
|
|
2351
2463
|
/** Dotted field path (e.g. `"state"`, `"address.county"`). */
|
|
2352
2464
|
fieldPath: string;
|
|
2353
2465
|
};
|
|
2466
|
+
/**
|
|
2467
|
+
* Routeable scalar RHS for typed field-value predicates. Mirrors
|
|
2468
|
+
* `wherePredicateSchema` in @warmhub/backend — keep in sync. Numeric-looking
|
|
2469
|
+
* strings (`"42"`) and strict-ISO date strings stay as strings; the
|
|
2470
|
+
* field-values router classifies them.
|
|
2471
|
+
*/
|
|
2472
|
+
type WhereScalarRhs = string | number | boolean;
|
|
2354
2473
|
/**
|
|
2355
2474
|
* A typed field-value WHERE predicate for `thing.query`, `thing.head`, and `thing.count`.
|
|
2356
2475
|
* @see https://docs.warmhub.ai/sdk-reference/type-aliases/wherepredicate/
|
|
@@ -2358,13 +2477,13 @@ type WherePredicateBase = {
|
|
|
2358
2477
|
type WherePredicate = (WherePredicateBase & {
|
|
2359
2478
|
/** Comparison operator. */
|
|
2360
2479
|
op: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'prefix';
|
|
2361
|
-
/** Scalar value for the predicate. */
|
|
2362
|
-
rhs:
|
|
2480
|
+
/** Scalar value for the predicate (string, number, or boolean). */
|
|
2481
|
+
rhs: WhereScalarRhs;
|
|
2363
2482
|
}) | (WherePredicateBase & {
|
|
2364
2483
|
/** Set-membership operator. */
|
|
2365
2484
|
op: 'in';
|
|
2366
|
-
/** Non-empty
|
|
2367
|
-
rhs:
|
|
2485
|
+
/** Non-empty array of scalar values (string, number, or boolean). */
|
|
2486
|
+
rhs: WhereScalarRhs[];
|
|
2368
2487
|
}) | (WherePredicateBase & {
|
|
2369
2488
|
/** Field existence operator. */
|
|
2370
2489
|
op: 'exists';
|
|
@@ -2454,6 +2573,16 @@ type PingResult = {
|
|
|
2454
2573
|
type AccessTokenProvider = string | (() => string | undefined | Promise<string | undefined>);
|
|
2455
2574
|
/** @internal */
|
|
2456
2575
|
declare function resolveFunctionLogMode(mode?: FunctionLogMode): FunctionLogMode;
|
|
2576
|
+
/**
|
|
2577
|
+
* Structured backend error details surfaced on `data.warmhub.details`. Derived
|
|
2578
|
+
* from the generated wire type so it stays in lockstep with the backend's
|
|
2579
|
+
* `WarmHubError.details` union. Branch on `details.reason` to recover the
|
|
2580
|
+
* structured payload type-safely — e.g. read `currentVersion` after an
|
|
2581
|
+
* `expected_version_mismatch` to retry against HEAD (#3624), or `leaseExpiresAt`
|
|
2582
|
+
* after a `lease_held` to back off until the lease expires (#3625).
|
|
2583
|
+
* @see https://docs.warmhub.ai/sdk-reference/type-aliases/warmhuberrordetails/
|
|
2584
|
+
*/
|
|
2585
|
+
type WarmHubErrorDetails = NonNullable<NonNullable<StreamAppendResult$1['results'][number]['error']>['details']>;
|
|
2457
2586
|
/** @internal */
|
|
2458
2587
|
declare function sanitizeErrorMessage(message: string): string;
|
|
2459
2588
|
/**
|
|
@@ -2511,7 +2640,16 @@ declare class WarmHubError extends Error {
|
|
|
2511
2640
|
* generic `BACKEND` fallback), branch on {@link code} or {@link kind}.
|
|
2512
2641
|
*/
|
|
2513
2642
|
readonly backendCode?: string;
|
|
2514
|
-
|
|
2643
|
+
/**
|
|
2644
|
+
* Structured backend error details, when the response carried them. Branch on
|
|
2645
|
+
* `details.reason`: an `expected_version_mismatch` carries
|
|
2646
|
+
* `expectedVersion`/`currentVersion` so an optimistic-concurrency caller can
|
|
2647
|
+
* re-read HEAD and retry (#3624); a `lease_held` carries `leaseExpiresAt` so a
|
|
2648
|
+
* caller can back off until the lease expires (#3625). Present only when the
|
|
2649
|
+
* backend wire carried `data.warmhub.details`. See {@link WarmHubErrorDetails}.
|
|
2650
|
+
*/
|
|
2651
|
+
readonly details?: WarmHubErrorDetails;
|
|
2652
|
+
constructor(code: string, message: string, status?: number, hint?: string, retryAfter?: number, backendCode?: string, details?: WarmHubErrorDetails);
|
|
2515
2653
|
get kind(): ErrorKind;
|
|
2516
2654
|
}
|
|
2517
2655
|
/**
|
|
@@ -3258,13 +3396,43 @@ declare class WarmHubClient {
|
|
|
3258
3396
|
* @param version Optional exact version to pin when the wref is not already version-qualified.
|
|
3259
3397
|
* @param opts.includeRetracted Include retracted records instead of treating them as missing.
|
|
3260
3398
|
*/
|
|
3261
|
-
get: (orgName: string, repoName: string, wref: string, version?: number, opts?: ThingGetOptions) => Promise<ThingGet>;
|
|
3399
|
+
get: (orgName: string | undefined, repoName: string | undefined, wref: string, version?: number, opts?: ThingGetOptions) => Promise<ThingGet>;
|
|
3400
|
+
/**
|
|
3401
|
+
* Acquire a short, bounded, exclusive lease on a thing AND read it in one
|
|
3402
|
+
* atomic round trip (#3625).
|
|
3403
|
+
*
|
|
3404
|
+
* Returns everything {@link WarmHub.thing.get} returns plus a `lease`
|
|
3405
|
+
* block; the holder echoes `lease.id` back as `leaseId` on the subsequent
|
|
3406
|
+
* `revise`/`retract` (auto-releasing the lease) or calls
|
|
3407
|
+
* {@link WarmHub.thing.releaseLease} to return it early. Requires
|
|
3408
|
+
* `things:write` — never anonymous.
|
|
3409
|
+
*
|
|
3410
|
+
* Fail-fast: if another holder already holds an active lease, throws a
|
|
3411
|
+
* `WarmHubError` with `kind === 'LEASE_UNAVAILABLE'` and
|
|
3412
|
+
* `error.details?.reason === 'lease_held'` (read `leaseExpiresAt` to back
|
|
3413
|
+
* off until expiry). `ttlMs` out of the backend's bounds (default 5s /
|
|
3414
|
+
* min 1s / max 30s) is rejected, never clamped.
|
|
3415
|
+
*/
|
|
3416
|
+
getWithLease: (orgName: string, repoName: string, wref: string, opts?: {
|
|
3417
|
+
ttlMs?: number;
|
|
3418
|
+
}) => Promise<ThingGetWithLease>;
|
|
3419
|
+
/**
|
|
3420
|
+
* Release a lease early (#3625), closing the acquire↔release loop without
|
|
3421
|
+
* waiting out the TTL.
|
|
3422
|
+
*
|
|
3423
|
+
* Idempotent and owner-gated: releasing an absent, already-released,
|
|
3424
|
+
* expired, or non-matching lease is a benign no-op (no error). A
|
|
3425
|
+
* successful `revise`/`retract` carrying the `leaseId` already
|
|
3426
|
+
* auto-releases the lease, so this is only needed when the holder decides
|
|
3427
|
+
* not to mutate. Requires `things:write`.
|
|
3428
|
+
*/
|
|
3429
|
+
releaseLease: (orgName: string, repoName: string, wref: string, leaseId: string) => Promise<void>;
|
|
3262
3430
|
/**
|
|
3263
3431
|
* Get one record and its embedded assertion, about, and wref graph.
|
|
3264
3432
|
*
|
|
3265
3433
|
* Depth and limit options bound traversal size. References the caller cannot read remain string wrefs in the returned graph.
|
|
3266
3434
|
*/
|
|
3267
|
-
graph: (orgName: string, repoName: string, wref: string, opts?: ThingGraphOptions) => Promise<ThingGraphResult>;
|
|
3435
|
+
graph: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: ThingGraphOptions) => Promise<ThingGraphResult>;
|
|
3268
3436
|
/**
|
|
3269
3437
|
* Batch-fetch wrefs, auto-chunking above the backend's 500-wref transport cap.
|
|
3270
3438
|
*
|
|
@@ -3275,7 +3443,7 @@ declare class WarmHubClient {
|
|
|
3275
3443
|
* @param opts.chunkSize Maximum wrefs per backend request. Defaults to 500 and is clamped to the backend cap.
|
|
3276
3444
|
* @param opts.chunkConcurrency Maximum concurrent chunk requests. Defaults to 1 and is clamped to 8.
|
|
3277
3445
|
*/
|
|
3278
|
-
getMany: (orgName: string, repoName: string, wrefs: string[], version?: number, opts?: {
|
|
3446
|
+
getMany: (orgName: string | undefined, repoName: string | undefined, wrefs: string[], version?: number, opts?: {
|
|
3279
3447
|
includeRetracted?: boolean;
|
|
3280
3448
|
chunkSize?: number;
|
|
3281
3449
|
chunkConcurrency?: number;
|
|
@@ -3285,7 +3453,7 @@ declare class WarmHubClient {
|
|
|
3285
3453
|
*
|
|
3286
3454
|
* 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.
|
|
3287
3455
|
*/
|
|
3288
|
-
history: (orgName: string, repoName: string, opts: ThingHistoryOptions) => Promise<ThingHistory>;
|
|
3456
|
+
history: (orgName: string | undefined, repoName: string | undefined, opts: ThingHistoryOptions) => Promise<ThingHistory>;
|
|
3289
3457
|
/**
|
|
3290
3458
|
* Rename a thing within its shape namespace.
|
|
3291
3459
|
*
|
|
@@ -3295,7 +3463,7 @@ declare class WarmHubClient {
|
|
|
3295
3463
|
/**
|
|
3296
3464
|
* Resolve a wref to its current projected record.
|
|
3297
3465
|
*/
|
|
3298
|
-
resolve: (orgName: string, repoName: string, wref: string) => Promise<ResolveWrefResult>;
|
|
3466
|
+
resolve: (orgName: string | undefined, repoName: string | undefined, wref: string) => Promise<ResolveWrefResult>;
|
|
3299
3467
|
/**
|
|
3300
3468
|
* Return assertions about a thing or collection target.
|
|
3301
3469
|
*
|
|
@@ -3313,19 +3481,19 @@ declare class WarmHubClient {
|
|
|
3313
3481
|
*
|
|
3314
3482
|
* Any returned subjective-logic opinion tuple `(b, d, u, α)` is a binomial opinion — well-formed only when the underlying assertion expresses a binary proposition. See [Opinions as Separate Assertions](/data-modeling/patterns/#opinions-as-separate-assertions).
|
|
3315
3483
|
*/
|
|
3316
|
-
about: (orgName: string, repoName: string, wref: string, opts?: AboutOptions) => Promise<AboutResult>;
|
|
3484
|
+
about: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: AboutOptions) => Promise<AboutResult>;
|
|
3317
3485
|
/**
|
|
3318
3486
|
* Iterate every assertion about a thing or collection target.
|
|
3319
3487
|
*
|
|
3320
3488
|
* 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.
|
|
3321
3489
|
*/
|
|
3322
|
-
aboutIter: (orgName: string, repoName: string, wref: string, opts?: AboutOptions) => AsyncIterableIterator<Assertion>;
|
|
3490
|
+
aboutIter: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: AboutOptions) => AsyncIterableIterator<Assertion>;
|
|
3323
3491
|
/**
|
|
3324
3492
|
* Materialize every assertion about a thing or collection target.
|
|
3325
3493
|
*
|
|
3326
3494
|
* Use `max` to guard memory usage; throws a `WarmHubError` with kind `VALIDATION_ERROR` once more than `max` assertions have actually been observed across pages.
|
|
3327
3495
|
*/
|
|
3328
|
-
aboutAll: (orgName: string, repoName: string, wref: string, opts?: AboutOptions & {
|
|
3496
|
+
aboutAll: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: AboutOptions & {
|
|
3329
3497
|
max?: number;
|
|
3330
3498
|
}) => Promise<Assertion[]>;
|
|
3331
3499
|
/**
|
|
@@ -3363,19 +3531,19 @@ declare class WarmHubClient {
|
|
|
3363
3531
|
*
|
|
3364
3532
|
* 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.
|
|
3365
3533
|
*/
|
|
3366
|
-
refs: (orgName: string, repoName: string, wref: string, opts?: RefsOptions) => Promise<RefsResult>;
|
|
3534
|
+
refs: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: RefsOptions) => Promise<RefsResult>;
|
|
3367
3535
|
/**
|
|
3368
3536
|
* Iterate every wref-typed field reference for a record.
|
|
3369
3537
|
*
|
|
3370
3538
|
* 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.
|
|
3371
3539
|
*/
|
|
3372
|
-
refsIter: (orgName: string, repoName: string, wref: string, opts?: RefsOptions) => AsyncIterableIterator<RefLink>;
|
|
3540
|
+
refsIter: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: RefsOptions) => AsyncIterableIterator<RefLink>;
|
|
3373
3541
|
/**
|
|
3374
3542
|
* Materialize every wref-typed field reference for a record.
|
|
3375
3543
|
*
|
|
3376
3544
|
* Use `max` to guard memory usage; throws a `WarmHubError` with kind `VALIDATION_ERROR` once more than `max` refs have actually been observed across pages.
|
|
3377
3545
|
*/
|
|
3378
|
-
refsAll: (orgName: string, repoName: string, wref: string, opts?: RefsOptions & {
|
|
3546
|
+
refsAll: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: RefsOptions & {
|
|
3379
3547
|
max?: number;
|
|
3380
3548
|
}) => Promise<RefLink[]>;
|
|
3381
3549
|
};
|
|
@@ -3636,4 +3804,4 @@ declare class WarmHubClient {
|
|
|
3636
3804
|
private watchRepoQuery;
|
|
3637
3805
|
}
|
|
3638
3806
|
|
|
3639
|
-
export { type AboutOptions, type AboutResult, type AccessTokenProvider, type ActionAttemptInfo, type ActionLeaseAcquire, type ActionLeaseOp, type ActionListNotificationsOptions, type ActionListRunsOptions, type ActionLiveFeed, type ActionLiveFeedOptions, type ActionNotificationInfo, type ActionRunInfo, 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 ComponentInstallSystemResult, 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 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 RepoConfigureStatsView, type RepoDescribeResult, type RepoInfo, type RepoList, type RepoListOptions, type RepoListPageOptions, type RepoListPageResult, type RepoLocator, 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 ThingGraphOptions, type ThingGraphResult, type ThingGraphValue, type ThingHead, type ThingHeadOptions, type ThingHeadRequest, type ThingHistory, type ThingHistoryOptions, type ThingItem, type TokenInfo, type TokenResult, type UndeclaredFieldsWarning, type ValidationDiagnostic, type ValidationResult, type VerifiedCliCall, WarmHubClient, type WarmHubClientOptions, WarmHubError, type WherePredicate, type WhoamiInfo, type WhoamiScopeEntry, type WireScopeEntry, connectionErrorMessage, contentFieldLimitError, countStreamAppendResultStatuses, isConnectionError, isRetryable, isWarmHubError, normalizeWref, resolveFunctionLogMode, sanitizeErrorMessage, sdkVersionIsBelowMinimum, streamAppendResultStatus, submitOperationsViaStream, toWarmHubError, validateAgainstShape, verifyCliCall };
|
|
3807
|
+
export { type AboutOptions, type AboutResult, type AccessTokenProvider, type ActionAttemptInfo, type ActionLeaseAcquire, type ActionLeaseOp, type ActionListNotificationsOptions, type ActionListRunsOptions, type ActionLiveFeed, type ActionLiveFeedOptions, type ActionNotificationInfo, type ActionRunInfo, 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 ComponentInstallSystemResult, 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 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 RepoConfigureStatsView, type RepoDescribeResult, type RepoInfo, type RepoList, type RepoListOptions, type RepoListPageOptions, type RepoListPageResult, type RepoLocator, 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 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-CVMYSRPS.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-CVMYSRPS.js';
|
|
2
|
+
export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-CVMYSRPS.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