@warmhub/sdk-ts 0.68.0 → 0.69.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
@@ -44,10 +44,12 @@ type CommitOperationKind = (typeof COMMIT_OPERATION_KINDS)[number];
44
44
  */
45
45
  declare const CLI_INSTALL_REPO_HEADER = "X-WarmHub-Install-Repo";
46
46
  /**
47
+ * HMAC signature header used by component CLI dispatch.
47
48
  * @see https://docs.warmhub.ai/sdk-reference/variables/cli_signature_header/
48
49
  */
49
50
  declare const CLI_SIGNATURE_HEADER = "X-WarmHub-Signature";
50
51
  /**
52
+ * Unix-seconds timestamp header used by component CLI dispatch.
51
53
  * @see https://docs.warmhub.ai/sdk-reference/variables/cli_timestamp_header/
52
54
  */
53
55
  declare const CLI_TIMESTAMP_HEADER = "X-WarmHub-Timestamp";
@@ -96,6 +98,7 @@ type CliHttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
96
98
  */
97
99
  declare function validateAgainstShape(data: Record<string, unknown>, shapeFields: Record<string, unknown>): ShapeValidatorResult;
98
100
  /**
101
+ * Warning details for input fields that the shape does not declare.
99
102
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/undeclaredfieldswarning/
100
103
  */
101
104
  type UndeclaredFieldsWarning = {
@@ -104,6 +107,7 @@ type UndeclaredFieldsWarning = {
104
107
  totalUndeclared?: number;
105
108
  };
106
109
  /**
110
+ * Discriminated result returned when input is validated against shape fields.
107
111
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/shapevalidatorresult/
108
112
  */
109
113
  type ShapeValidatorResult = {
@@ -1489,6 +1493,7 @@ declare function countStreamAppendResultStatuses(results: StreamAppendResult$1['
1489
1493
 
1490
1494
  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';
1491
1495
  /**
1496
+ * Error thrown when component CLI request verification fails.
1492
1497
  * @see https://docs.warmhub.ai/sdk-reference/classes/clicallverificationerror/
1493
1498
  */
1494
1499
  declare class CliCallVerificationError extends Error {
@@ -1496,6 +1501,7 @@ declare class CliCallVerificationError extends Error {
1496
1501
  constructor(reason: CliCallVerificationFailureReason, message: string);
1497
1502
  }
1498
1503
  /**
1504
+ * Authenticated component CLI request, parsed into its install and arguments.
1499
1505
  * @see https://docs.warmhub.ai/sdk-reference/interfaces/verifiedclicall/
1500
1506
  */
1501
1507
  interface VerifiedCliCall {
@@ -1552,6 +1558,7 @@ declare function verifyCliCall(request: Request, secrets: CliCallSecrets, opts?:
1552
1558
  type ShapeFields = Record<string, unknown>;
1553
1559
 
1554
1560
  /**
1561
+ * Collection type discriminator accepted by an add operation.
1555
1562
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/collectionaddtype/
1556
1563
  */
1557
1564
  type CollectionAddType = CollectionTag$1;
@@ -2446,6 +2453,7 @@ type GlobalSearchResult = {
2446
2453
  nextCursor?: string;
2447
2454
  };
2448
2455
  /**
2456
+ * Pagination controls for global repo and component search.
2449
2457
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/globalsearchoptions/
2450
2458
  */
2451
2459
  type GlobalSearchOptions = {
@@ -3054,6 +3062,7 @@ type WherePredicate = (WherePredicateBase & {
3054
3062
  rhs?: never;
3055
3063
  });
3056
3064
  /**
3065
+ * Filters accepted by `client.thing.query` and related list operations.
3057
3066
  * @see https://docs.warmhub.ai/sdk-reference/type-aliases/filteroptions/
3058
3067
  */
3059
3068
  type FilterOptions = {
@@ -3371,6 +3380,7 @@ type RepoAccessResult = AccessResolveResult$1['repos'][number];
3371
3380
  */
3372
3381
  type OrgAccessResult = AccessResolveResult$1['orgs'][number];
3373
3382
  /**
3383
+ * HTTP client for WarmHub repository, organization, and component APIs.
3374
3384
  * @see https://docs.warmhub.ai/sdk-reference/classes/warmhubclient/
3375
3385
  */
3376
3386
  declare class WarmHubClient {
@@ -3493,9 +3503,10 @@ declare class WarmHubClient {
3493
3503
  */
3494
3504
  list: (orgName: string, repoName: string, opts?: ComponentListOptions) => Promise<ComponentList>;
3495
3505
  /**
3496
- * Search public registered components across all orgs (GH-4383).
3497
- * Public-only at launch. Distinct from listing components installed in a
3498
- * repo (`component.list`).
3506
+ * Search registered components visible to the caller across all orgs
3507
+ * (GH-4383): public components plus private components the caller can
3508
+ * read. Distinct from listing components installed in a repo
3509
+ * (`component.list`).
3499
3510
  */
3500
3511
  search: (query: string, opts?: GlobalSearchOptions) => Promise<GlobalSearchResult>;
3501
3512
  /**
@@ -3767,8 +3778,9 @@ declare class WarmHubClient {
3767
3778
  */
3768
3779
  list: (orgName: string, opts?: RepoListOptions) => Promise<RepoList>;
3769
3780
  /**
3770
- * Search public repos across all orgs (GH-4383). Public-only at launch;
3771
- * BM25 over name/description/shape vocabulary/README.
3781
+ * Search repos visible to the caller across all orgs (GH-4383): public
3782
+ * repos plus private repos the caller can read. BM25 over
3783
+ * name/description/shape vocabulary/README.
3772
3784
  */
3773
3785
  search: (query: string, opts?: GlobalSearchOptions) => Promise<GlobalSearchResult>;
3774
3786
  /**
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-GNNCLRNC.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-QI7ELATB.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-GNNCLRNC.js';
2
- export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-GNNCLRNC.js';
1
+ import { WarmHubClient } from './chunk-QI7ELATB.js';
2
+ export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-QI7ELATB.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.68.0",
3
+ "version": "0.69.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.",