@warmhub/sdk-ts 0.52.1 → 0.53.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
@@ -74,6 +74,29 @@ type ActionRunStats = {
74
74
  dead_letter: number;
75
75
  };
76
76
  };
77
+ type AccessResolveInput$1 = {
78
+ repos?: Array<{
79
+ orgName: string;
80
+ repoName: string;
81
+ }>;
82
+ orgs?: Array<{
83
+ orgName: string;
84
+ }>;
85
+ };
86
+ type AccessResolveResult$1 = {
87
+ repos: Array<{
88
+ orgName: string;
89
+ repoName: string;
90
+ visible: boolean;
91
+ scopes: Array<'repo:read' | 'repo:write' | 'repo:configure' | 'repo:admin'>;
92
+ allowedMatches?: Array<string>;
93
+ }>;
94
+ orgs: Array<{
95
+ orgName: string;
96
+ visible: boolean;
97
+ scopes: Array<'org:read' | 'org:configure' | 'org:admin'>;
98
+ }>;
99
+ };
77
100
  type AuthSyncResult = {
78
101
  success: boolean;
79
102
  };
@@ -107,7 +130,7 @@ type CommitApplyResult = {
107
130
  }>;
108
131
  };
109
132
  type ComponentDetail = {
110
- componentId: string;
133
+ ref?: string;
111
134
  componentName: string;
112
135
  version?: string;
113
136
  state?: string;
@@ -150,14 +173,14 @@ type ComponentDetail = {
150
173
  data: unknown;
151
174
  dataHash: string;
152
175
  } | null;
153
- componentId?: string;
176
+ componentRef?: string;
154
177
  }>;
155
178
  ownedThings: Array<{
156
179
  wref: string;
157
180
  name: string;
158
181
  kind: 'shape' | 'thing' | 'assertion' | 'collection';
159
182
  shapeName?: string;
160
- componentId?: string;
183
+ componentRef?: string;
161
184
  version: number;
162
185
  createdAt: number;
163
186
  data?: unknown;
@@ -172,7 +195,7 @@ type ComponentDetail = {
172
195
  };
173
196
  type ComponentListResult = {
174
197
  items: Array<{
175
- componentId: string;
198
+ ref?: string;
176
199
  componentName: string;
177
200
  version?: string;
178
201
  state?: string;
@@ -188,7 +211,7 @@ type ComponentListResult = {
188
211
  nextCursor?: string;
189
212
  };
190
213
  type ComponentSummary = {
191
- componentId: string;
214
+ ref?: string;
192
215
  componentName: string;
193
216
  version?: string;
194
217
  state?: string;
@@ -222,7 +245,7 @@ type StreamAppendInput$1 = {
222
245
  orgName: string;
223
246
  repoName: string;
224
247
  streamId: string;
225
- componentId?: string;
248
+ componentRef?: string;
226
249
  workspaceName?: never;
227
250
  committer?: string;
228
251
  message?: string;
@@ -407,7 +430,7 @@ type ShapeGetResult = {
407
430
  data: unknown;
408
431
  dataHash: string;
409
432
  } | null;
410
- componentId?: string;
433
+ componentRef?: string;
411
434
  };
412
435
  type ShapeListResult = {
413
436
  items: Array<{
@@ -420,7 +443,7 @@ type ShapeListResult = {
420
443
  data: unknown;
421
444
  dataHash: string;
422
445
  } | null;
423
- componentId?: string;
446
+ componentRef?: string;
424
447
  }>;
425
448
  };
426
449
  type ThingGetManyResult$1 = {
@@ -1006,7 +1029,7 @@ declare function submitOperationsViaStream(client: OperationStreamClient, args:
1006
1029
  committer?: string;
1007
1030
  message?: string;
1008
1031
  operations: Operation[];
1009
- componentId?: string;
1032
+ componentRef?: string;
1010
1033
  chunkSize?: number;
1011
1034
  skipExisting?: boolean;
1012
1035
  streamId?: string;
@@ -1748,7 +1771,7 @@ type SubscriptionInfo = {
1748
1771
  };
1749
1772
  allowTraceReentry?: boolean;
1750
1773
  notifyOnSuccess?: boolean;
1751
- componentId?: string;
1774
+ componentRef?: string;
1752
1775
  credentialSetNames: Array<string>;
1753
1776
  createdAt: number;
1754
1777
  };
@@ -1767,7 +1790,7 @@ type SubscriptionCompatCreateBase = {
1767
1790
  fallbackWebhookUrl?: string;
1768
1791
  allowTraceReentry?: boolean;
1769
1792
  notifyOnSuccess?: boolean;
1770
- componentId?: string;
1793
+ componentRef?: string;
1771
1794
  workspacePolicy?: never;
1772
1795
  /** @internal */
1773
1796
  actionContainer?: string;
@@ -1887,7 +1910,6 @@ type ComponentListOptions = {
1887
1910
  cursor?: string;
1888
1911
  };
1889
1912
  type ComponentRegistryInfo = {
1890
- id: string;
1891
1913
  ownerOrgName: string;
1892
1914
  componentName: string;
1893
1915
  ref: string;
@@ -1962,7 +1984,7 @@ type ComponentRegistryCliCallResult = ComponentRegistrySetupCallResult;
1962
1984
  /** @internal */
1963
1985
  type ShapeListOptions = {
1964
1986
  match?: string;
1965
- componentId?: string;
1987
+ componentRef?: string;
1966
1988
  excludeComponents?: boolean;
1967
1989
  includeRetracted?: boolean;
1968
1990
  };
@@ -2321,7 +2343,7 @@ type ThingHeadRequest = {
2321
2343
  includeRetracted?: boolean;
2322
2344
  limit?: number;
2323
2345
  cursor?: string;
2324
- componentId?: string;
2346
+ componentRef?: string;
2325
2347
  excludeComponents?: boolean;
2326
2348
  excludeInfraShapes?: boolean;
2327
2349
  where?: WherePredicate[];
@@ -2575,8 +2597,8 @@ type FilterOptions = {
2575
2597
  limit?: number;
2576
2598
  /** Pagination cursor returned by the prior call. */
2577
2599
  cursor?: string;
2578
- /** Filter to records attributed to this component identifier. */
2579
- componentId?: string;
2600
+ /** Filter to records attributed to this installed component's `Org/Name` ref. */
2601
+ componentRef?: string;
2580
2602
  /** Exclude records attributed to any component. */
2581
2603
  excludeComponents?: boolean;
2582
2604
  /** Exclude internal infrastructure shapes from the result set. */
@@ -2797,6 +2819,29 @@ declare function sdkVersionIsBelowMinimum(version: string, minimum: string): boo
2797
2819
  *
2798
2820
  * @see https://docs.warmhub.ai/sdk/client/
2799
2821
  */
2822
+ /**
2823
+ * Input for {@link WarmHubClient.access.resolve} — repos/orgs addressed by name.
2824
+ * @internal
2825
+ */
2826
+ type AccessResolveInput = AccessResolveInput$1;
2827
+ /**
2828
+ * Batch effective-access result; correlate by the echoed `orgName`/`repoName`.
2829
+ * @internal
2830
+ */
2831
+ type AccessResolveResult = AccessResolveResult$1;
2832
+ /**
2833
+ * Effective repo access for the caller (one entry of {@link AccessResolveResult}).
2834
+ * @internal
2835
+ */
2836
+ type RepoAccessResult = AccessResolveResult$1['repos'][number];
2837
+ /**
2838
+ * Effective org-level access for the caller (one entry of {@link AccessResolveResult}).
2839
+ * @internal
2840
+ */
2841
+ type OrgAccessResult = AccessResolveResult$1['orgs'][number];
2842
+ /**
2843
+ * @see https://docs.warmhub.ai/sdk-reference/classes/warmhubclient/
2844
+ */
2800
2845
  declare class WarmHubClient {
2801
2846
  /**
2802
2847
  * The resolved API base URL the client issues requests against. Defaults to
@@ -2839,22 +2884,21 @@ declare class WarmHubClient {
2839
2884
  whoami: () => Promise<WhoamiInfo>;
2840
2885
  };
2841
2886
  /**
2842
- * Lightweight permission checks for UI gating and service-side authorization probes.
2843
- * @see https://docs.warmhub.ai/sdk-reference/classes/warmhubclient/#access
2887
+ * Effective-access resolution for UI gating and service-side authorization.
2888
+ * First-party surface (web UI + whedge edge); the underlying `access.resolve`
2889
+ * procedure is `@internal`.
2890
+ * @internal
2844
2891
  */
2845
2892
  readonly access: {
2846
2893
  /**
2847
- * Check whether the caller has a repo-scoped permission.
2848
- *
2849
- * @param permission Permission string such as `repo:read`, `repo:write`, `repo:configure`, or `repo:admin`.
2850
- */
2851
- checkRepoPermission: (orgName: string, repoName: string, permission: string) => Promise<boolean>;
2852
- /**
2853
- * Check whether the caller has an org-scoped permission.
2854
- *
2855
- * @param permission Permission string such as `org:read`, `org:configure`, or `org:admin`.
2894
+ * Resolve the caller's effective access for a batch of repos and/or orgs
2895
+ * (addressed by name). Returns the coarse scope SET per target so one call
2896
+ * answers any permission via `scopes.includes(...)` e.g.
2897
+ * `scopes.includes('repo:configure')`. Non-throwing: `visible: false` means
2898
+ * not-found/not-visible; `scopes: []` means authenticated-but-no-access.
2899
+ * Correlate results by the echoed `orgName`/`repoName`, not by position.
2856
2900
  */
2857
- checkOrgPermission: (orgName: string, permission: string) => Promise<boolean>;
2901
+ resolve: (input: AccessResolveInput) => Promise<AccessResolveResult>;
2858
2902
  };
2859
2903
  /**
2860
2904
  * Connectivity and compatibility helpers for checking the configured WarmHub backend.
@@ -2900,9 +2944,9 @@ declare class WarmHubClient {
2900
2944
  */
2901
2945
  list: (orgName: string, repoName: string, opts?: ComponentListOptions) => Promise<ComponentList>;
2902
2946
  /**
2903
- * Fetch one installed component by component ID.
2947
+ * Fetch one installed component by its `Org/Name` ref.
2904
2948
  */
2905
- get: (orgName: string, repoName: string, componentId: string) => Promise<ComponentView>;
2949
+ get: (orgName: string, repoName: string, componentRef: string) => Promise<ComponentView>;
2906
2950
  /**
2907
2951
  * Registered-component identity and install-pipeline operations.
2908
2952
  *
@@ -2959,7 +3003,7 @@ declare class WarmHubClient {
2959
3003
  * @param message Optional commit message stored with the submitted operations.
2960
3004
  * @param operations Add, revise, or retract operations to submit in order.
2961
3005
  * @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.
2962
- * @param opts.componentId Attribute writes to an installed component when the caller is allowed to claim it.
3006
+ * @param opts.componentRef Attribute writes to an installed component, identified by its `Org/Name` ref, when the caller is allowed to claim it.
2963
3007
  * @param opts.chunkSize Maximum operations per stream append. Values are clamped by the SDK.
2964
3008
  * @param opts.skipExisting Return `noop` for add operations whose target already exists.
2965
3009
  * @param opts.streamId Advanced continuation hook for caller-managed streams.
@@ -2967,7 +3011,7 @@ declare class WarmHubClient {
2967
3011
  */
2968
3012
  apply: (orgName: string, repoName: string, message: string | undefined, operations: Operation[], opts?: {
2969
3013
  committer?: string;
2970
- componentId?: string;
3014
+ componentRef?: string;
2971
3015
  chunkSize?: number;
2972
3016
  skipExisting?: boolean;
2973
3017
  streamId?: string;
@@ -3914,4 +3958,4 @@ declare class WarmHubClient {
3914
3958
  private watchRepoQuery;
3915
3959
  }
3916
3960
 
3917
- 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 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 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 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 };
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 };
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-OPTB23HY.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-L5PODJ66.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-OPTB23HY.js';
2
- export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-OPTB23HY.js';
1
+ import { WarmHubClient } from './chunk-L5PODJ66.js';
2
+ export { DEFAULT_API_URL, SDK_VERSION, WarmHubClient, WarmHubError, toWarmHubError } from './chunk-L5PODJ66.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.52.1",
3
+ "version": "0.53.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.",