@warmhub/sdk-ts 0.67.0 → 0.68.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
|
@@ -63,7 +63,7 @@ type CliHttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
|
|
|
63
63
|
*
|
|
64
64
|
* Shape field types:
|
|
65
65
|
* - "number", "string", "boolean": primitive types
|
|
66
|
-
* - "wref": string (reference to
|
|
66
|
+
* - "wref": string (reference to a shape or shaped thing)
|
|
67
67
|
* - Typed field objects: { type: primitive, description?: string }
|
|
68
68
|
* - Nested objects: { fieldName: type, ... }
|
|
69
69
|
* - Arrays: [elementType]
|
|
@@ -2138,11 +2138,12 @@ type SubscriptionCompatCreateCommon = {
|
|
|
2138
2138
|
};
|
|
2139
2139
|
/**
|
|
2140
2140
|
* Input shape for `client.subscription.create`, discriminated on `eventType`
|
|
2141
|
-
* (GH-4679):
|
|
2141
|
+
* (GH-4679, GH-6553):
|
|
2142
2142
|
*
|
|
2143
2143
|
* - default / `commit` — operation-based, repo-scoped (`repoName`); requires a
|
|
2144
2144
|
* `filterJson` object and a shape binding (`shapeName` or `filterJson.shape`).
|
|
2145
|
-
* - `repo.renamed` — repo-scoped metadata
|
|
2145
|
+
* - `repo.renamed` / `thing.renamed` / `shape.renamed` — repo-scoped metadata
|
|
2146
|
+
* events; no shape/filter/source.
|
|
2146
2147
|
* - `org.renamed` — org-scoped metadata event; no `repoName`/shape/filter/source.
|
|
2147
2148
|
*
|
|
2148
2149
|
* The metadata variants forbid the commit-only fields at the type level so
|
|
@@ -2157,7 +2158,7 @@ type SubscriptionCompatCreateInput = (SubscriptionCompatCreateCommon & {
|
|
|
2157
2158
|
shapeName?: string;
|
|
2158
2159
|
sourceRepoRef?: string;
|
|
2159
2160
|
}) | (SubscriptionCompatCreateCommon & {
|
|
2160
|
-
eventType: 'repo.renamed';
|
|
2161
|
+
eventType: 'repo.renamed' | 'thing.renamed' | 'shape.renamed';
|
|
2161
2162
|
repoName: string;
|
|
2162
2163
|
filterJson?: never;
|
|
2163
2164
|
shapeName?: never;
|
|
@@ -2173,7 +2174,7 @@ type SubscriptionCompatCreateInput = (SubscriptionCompatCreateCommon & {
|
|
|
2173
2174
|
* Input shape for `client.subscription.update`. `orgName` and `name` identify
|
|
2174
2175
|
* the subscription; omit `repoName` to update an org-scoped (`org.renamed`)
|
|
2175
2176
|
* subscription. All other fields are optional and only the ones you provide get
|
|
2176
|
-
* patched.
|
|
2177
|
+
* patched. Metadata subscriptions (any `*.renamed`) reject
|
|
2177
2178
|
* `shapeName`/`filterJson` — they have only delivery fields to edit.
|
|
2178
2179
|
*
|
|
2179
2180
|
* @see https://docs.warmhub.ai/subscriptions/managing/#update-subscription
|
|
@@ -3593,7 +3594,7 @@ declare class WarmHubClient {
|
|
|
3593
3594
|
*
|
|
3594
3595
|
* @param message Optional commit message stored with the submitted operations.
|
|
3595
3596
|
* @param operations Add, revise, or retract operations to submit in order.
|
|
3596
|
-
* @param opts.committer Optional wref identifying the actor on whose behalf the write is made.
|
|
3597
|
+
* @param opts.committer Optional untyped wref identifying the actor on whose behalf the write is made. It may target an existing shape (`"Agent"`) or shaped thing (`"Agent/bot-1"`), locally or canonically (`"wh:other-org/other-repo/Agent"` or `"wh:other-org/other-repo/Agent/bot-1"`). A one-segment value is a shape wref, not a free-form label, and succeeds only when that shape exists. On success, `OperationSubmitResult.committer` echoes the supplied wref string; version reads expose the resolved target as `committerWref`.
|
|
3597
3598
|
* @param opts.componentRef Attribute writes to an installed component, identified by its `Org/Name` ref, when the caller is allowed to claim it.
|
|
3598
3599
|
* @param opts.chunkSize Maximum operations per stream append. Values are clamped by the SDK.
|
|
3599
3600
|
* @param opts.skipExisting Return `noop` for add operations whose target already exists.
|
|
@@ -4302,7 +4303,7 @@ declare class WarmHubClient {
|
|
|
4302
4303
|
*/
|
|
4303
4304
|
resolve: (orgName: string | undefined, repoName: string | undefined, wref: string) => Promise<ResolveWrefResult>;
|
|
4304
4305
|
/**
|
|
4305
|
-
* Return assertions about a thing or collection target.
|
|
4306
|
+
* Return assertions about a shape, shaped thing, or collection target.
|
|
4306
4307
|
*
|
|
4307
4308
|
* Filter by assertion shape or glob `match` pattern, optionally resolve collection targets, and page through large assertion sets with `limit` and `cursor`.
|
|
4308
4309
|
*
|
|
@@ -4326,7 +4327,7 @@ declare class WarmHubClient {
|
|
|
4326
4327
|
*/
|
|
4327
4328
|
about: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: AboutOptions) => Promise<AboutResult>;
|
|
4328
4329
|
/**
|
|
4329
|
-
* Iterate every assertion about a thing or collection target.
|
|
4330
|
+
* Iterate every assertion about a shape, shaped thing, or collection target.
|
|
4330
4331
|
*
|
|
4331
4332
|
* 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.
|
|
4332
4333
|
*
|
|
@@ -4338,7 +4339,7 @@ declare class WarmHubClient {
|
|
|
4338
4339
|
*/
|
|
4339
4340
|
aboutIter: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: AboutOptions) => AsyncIterableIterator<Assertion>;
|
|
4340
4341
|
/**
|
|
4341
|
-
* Materialize every assertion about a thing or collection target.
|
|
4342
|
+
* Materialize every assertion about a shape, shaped thing, or collection target.
|
|
4342
4343
|
*
|
|
4343
4344
|
* Use `max` to guard memory usage; throws a `WarmHubError` with kind `VALIDATION_ERROR` once more than `max` assertions have actually been observed across pages.
|
|
4344
4345
|
*
|
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-GNNCLRNC.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-GNNCLRNC.js';
|
|
2
|
+
export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-GNNCLRNC.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