@warmhub/sdk-ts 0.67.0 → 0.69.0

package/dist/index.d.ts

@@ -44,10 +44,12 @@ type CommitOperationKind = (typeof COMMIT_OPERATION_KINDS)[number];
  */
 declare const CLI_INSTALL_REPO_HEADER = "X-WarmHub-Install-Repo";
 /**
+ * HMAC signature header used by component CLI dispatch.
  * @see https://docs.warmhub.ai/sdk-reference/variables/cli_signature_header/
  */
 declare const CLI_SIGNATURE_HEADER = "X-WarmHub-Signature";
 /**
+ * Unix-seconds timestamp header used by component CLI dispatch.
  * @see https://docs.warmhub.ai/sdk-reference/variables/cli_timestamp_header/
  */
 declare const CLI_TIMESTAMP_HEADER = "X-WarmHub-Timestamp";
@@ -63,7 +65,7 @@ type CliHttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
  *
  * Shape field types:
  * - "number", "string", "boolean": primitive types
- * - "wref": string (reference to another thing)
+ * - "wref": string (reference to a shape or shaped thing)
  * - Typed field objects: { type: primitive, description?: string }
  * - Nested objects: { fieldName: type, ... }
  * - Arrays: [elementType]
@@ -96,6 +98,7 @@ type CliHttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
  */
 declare function validateAgainstShape(data: Record<string, unknown>, shapeFields: Record<string, unknown>): ShapeValidatorResult;
 /**
+ * Warning details for input fields that the shape does not declare.
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/undeclaredfieldswarning/
  */
 type UndeclaredFieldsWarning = {
@@ -104,6 +107,7 @@ type UndeclaredFieldsWarning = {
     totalUndeclared?: number;
 };
 /**
+ * Discriminated result returned when input is validated against shape fields.
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/shapevalidatorresult/
  */
 type ShapeValidatorResult = {
@@ -1489,6 +1493,7 @@ declare function countStreamAppendResultStatuses(results: StreamAppendResult$1['
 
 type CliCallVerificationFailureReason = 'missing-signature' | 'missing-timestamp' | 'invalid-timestamp' | 'missing-install-repo' | 'unsupported-method' | 'invalid-signature' | 'invalid-format' | 'expired' | 'invalid-body' | 'no-scheme-configured' | 'invalid-bearer' | 'invalid-api-key' | 'invalid-basic';
 /**
+ * Error thrown when component CLI request verification fails.
  * @see https://docs.warmhub.ai/sdk-reference/classes/clicallverificationerror/
  */
 declare class CliCallVerificationError extends Error {
@@ -1496,6 +1501,7 @@ declare class CliCallVerificationError extends Error {
     constructor(reason: CliCallVerificationFailureReason, message: string);
 }
 /**
+ * Authenticated component CLI request, parsed into its install and arguments.
  * @see https://docs.warmhub.ai/sdk-reference/interfaces/verifiedclicall/
  */
 interface VerifiedCliCall {
@@ -1552,6 +1558,7 @@ declare function verifyCliCall(request: Request, secrets: CliCallSecrets, opts?:
 type ShapeFields = Record<string, unknown>;
 
 /**
+ * Collection type discriminator accepted by an add operation.
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/collectionaddtype/
  */
 type CollectionAddType = CollectionTag$1;
@@ -2138,11 +2145,12 @@ type SubscriptionCompatCreateCommon = {
 };
 /**
  * Input shape for `client.subscription.create`, discriminated on `eventType`
- * (GH-4679):
+ * (GH-4679, GH-6553):
  *
  * - default / `commit` — operation-based, repo-scoped (`repoName`); requires a
  *   `filterJson` object and a shape binding (`shapeName` or `filterJson.shape`).
- * - `repo.renamed` — repo-scoped metadata event; no shape/filter/source.
+ * - `repo.renamed` / `thing.renamed` / `shape.renamed` — repo-scoped metadata
+ *   events; no shape/filter/source.
  * - `org.renamed` — org-scoped metadata event; no `repoName`/shape/filter/source.
  *
  * The metadata variants forbid the commit-only fields at the type level so
@@ -2157,7 +2165,7 @@ type SubscriptionCompatCreateInput = (SubscriptionCompatCreateCommon & {
     shapeName?: string;
     sourceRepoRef?: string;
 }) | (SubscriptionCompatCreateCommon & {
-    eventType: 'repo.renamed';
+    eventType: 'repo.renamed' | 'thing.renamed' | 'shape.renamed';
     repoName: string;
     filterJson?: never;
     shapeName?: never;
@@ -2173,7 +2181,7 @@ type SubscriptionCompatCreateInput = (SubscriptionCompatCreateCommon & {
  * Input shape for `client.subscription.update`. `orgName` and `name` identify
  * the subscription; omit `repoName` to update an org-scoped (`org.renamed`)
  * subscription. All other fields are optional and only the ones you provide get
- * patched. Rename subscriptions (`repo.renamed`/`org.renamed`) reject
+ * patched. Metadata subscriptions (any `*.renamed`) reject
  * `shapeName`/`filterJson` — they have only delivery fields to edit.
  *
  * @see https://docs.warmhub.ai/subscriptions/managing/#update-subscription
@@ -2445,6 +2453,7 @@ type GlobalSearchResult = {
     nextCursor?: string;
 };
 /**
+ * Pagination controls for global repo and component search.
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/globalsearchoptions/
  */
 type GlobalSearchOptions = {
@@ -3053,6 +3062,7 @@ type WherePredicate = (WherePredicateBase & {
     rhs?: never;
 });
 /**
+ * Filters accepted by `client.thing.query` and related list operations.
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/filteroptions/
  */
 type FilterOptions = {
@@ -3370,6 +3380,7 @@ type RepoAccessResult = AccessResolveResult$1['repos'][number];
  */
 type OrgAccessResult = AccessResolveResult$1['orgs'][number];
 /**
+ * HTTP client for WarmHub repository, organization, and component APIs.
  * @see https://docs.warmhub.ai/sdk-reference/classes/warmhubclient/
  */
 declare class WarmHubClient {
@@ -3492,9 +3503,10 @@ declare class WarmHubClient {
          */
         list: (orgName: string, repoName: string, opts?: ComponentListOptions) => Promise<ComponentList>;
         /**
-         * Search public registered components across all orgs (GH-4383).
-         * Public-only at launch. Distinct from listing components installed in a
-         * repo (`component.list`).
+         * Search registered components visible to the caller across all orgs
+         * (GH-4383): public components plus private components the caller can
+         * read. Distinct from listing components installed in a repo
+         * (`component.list`).
          */
         search: (query: string, opts?: GlobalSearchOptions) => Promise<GlobalSearchResult>;
         /**
@@ -3593,7 +3605,7 @@ declare class WarmHubClient {
          *
          * @param message Optional commit message stored with the submitted operations.
          * @param operations Add, revise, or retract operations to submit in order.
-         * @param opts.committer Optional wref identifying the actor on whose behalf the write is made. Must be a full wref string like `"Agent/bot-1"` (a thing that already exists), or a cross-repo wref like `"wh:other-org/other-repo/Agent/bot-1"`. Bare names such as `"eval-runner"` are rejected by the backend with a "Thing wref required" error — there is no implicit shape.
+         * @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`.
          * @param opts.componentRef Attribute writes to an installed component, identified by its `Org/Name` ref, when the caller is allowed to claim it.
          * @param opts.chunkSize Maximum operations per stream append. Values are clamped by the SDK.
          * @param opts.skipExisting Return `noop` for add operations whose target already exists.
@@ -3766,8 +3778,9 @@ declare class WarmHubClient {
          */
         list: (orgName: string, opts?: RepoListOptions) => Promise<RepoList>;
         /**
-         * Search public repos across all orgs (GH-4383). Public-only at launch;
-         * BM25 over name/description/shape vocabulary/README.
+         * Search repos visible to the caller across all orgs (GH-4383): public
+         * repos plus private repos the caller can read. BM25 over
+         * name/description/shape vocabulary/README.
          */
         search: (query: string, opts?: GlobalSearchOptions) => Promise<GlobalSearchResult>;
         /**
@@ -4302,7 +4315,7 @@ declare class WarmHubClient {
          */
         resolve: (orgName: string | undefined, repoName: string | undefined, wref: string) => Promise<ResolveWrefResult>;
         /**
-         * Return assertions about a thing or collection target.
+         * Return assertions about a shape, shaped thing, or collection target.
          *
          * Filter by assertion shape or glob `match` pattern, optionally resolve collection targets, and page through large assertion sets with `limit` and `cursor`.
          *
@@ -4326,7 +4339,7 @@ declare class WarmHubClient {
          */
         about: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: AboutOptions) => Promise<AboutResult>;
         /**
-         * Iterate every assertion about a thing or collection target.
+         * Iterate every assertion about a shape, shaped thing, or collection target.
          *
          * 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.
          *
@@ -4338,7 +4351,7 @@ declare class WarmHubClient {
          */
         aboutIter: (orgName: string | undefined, repoName: string | undefined, wref: string, opts?: AboutOptions) => AsyncIterableIterator<Assertion>;
         /**
-         * Materialize every assertion about a thing or collection target.
+         * Materialize every assertion about a shape, shaped thing, or collection target.
          *
          * Use `max` to guard memory usage; throws a `WarmHubError` with kind `VALIDATION_ERROR` once more than `max` assertions have actually been observed across pages.
          *

package/dist/index.js

@@ -1,3 +1,3 @@
-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-2KN2JWJU.js';
+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-QI7ELATB.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/react.js

@@ -1,5 +1,5 @@
-import { WarmHubClient } from './chunk-2KN2JWJU.js';
-export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-2KN2JWJU.js';
+import { WarmHubClient } from './chunk-QI7ELATB.js';
+export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-QI7ELATB.js';
 import { createContext, useMemo, useState, useEffect, useContext } from 'react';
 import { jsx } from 'react/jsx-runtime';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@warmhub/sdk-ts",
-  "version": "0.67.0",
+  "version": "0.69.0",
   "private": false,
   "type": "module",
   "description": "The TypeScript SDK for WarmHub — create repos, commit and query data, and compound knowledge with your AI agents.",