@warmhub/sdk-ts 0.93.0 → 0.94.0

package/dist/index.d.ts

@@ -4753,6 +4753,7 @@ type ThingHeadVersionsResult$1 = {
     requested: number;
     items: Array<{
         wref: string;
+        canonicalWref: string;
         durableId: string;
         version: number;
         active: boolean;
@@ -5310,7 +5311,33 @@ declare const ORG_SCOPED_EVENT_TYPES: readonly ["org.renamed", "org.member_added
 type OrgScopedEventType = (typeof ORG_SCOPED_EVENT_TYPES)[number];
 
 /**
- * Validate a data payload against shape field definitions.
+ * Warning details for input fields that no shape in the effective set declares.
+ * @see https://docs.warmhub.ai/sdk-reference/type-aliases/undeclaredfieldswarning/
+ */
+type UndeclaredFieldsWarning = {
+    undeclaredFields: string[];
+    undeclaredFieldsTruncated?: true;
+    totalUndeclared?: number;
+};
+
+/**
+ * Discriminated result returned when input is validated against shape fields.
+ * @see https://docs.warmhub.ai/sdk-reference/type-aliases/shapevalidatorresult/
+ */
+type ShapeValidatorResult = {
+    valid: true;
+    warnings?: UndeclaredFieldsWarning;
+} | {
+    valid: false;
+    errors: string[];
+    warnings?: UndeclaredFieldsWarning;
+};
+/**
+ * Validate a data payload against a single shape's field definitions.
+ *
+ * A single shape is an effective set of one, so this is
+ * {@link compileShapesValidator} with a one-element set — same checks, same
+ * order, same messages.
  *
  * Shape field types:
  * - "number", "string", "boolean": primitive types
@@ -5346,27 +5373,6 @@ type OrgScopedEventType = (typeof ORG_SCOPED_EVENT_TYPES)[number];
  * @see https://docs.warmhub.ai/sdk-reference/functions/validateagainstshape/
  */
 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 = {
-    undeclaredFields: string[];
-    undeclaredFieldsTruncated?: true;
-    totalUndeclared?: number;
-};
-/**
- * Discriminated result returned when input is validated against shape fields.
- * @see https://docs.warmhub.ai/sdk-reference/type-aliases/shapevalidatorresult/
- */
-type ShapeValidatorResult = {
-    valid: true;
-    warnings?: UndeclaredFieldsWarning;
-} | {
-    valid: false;
-    errors: string[];
-    warnings?: UndeclaredFieldsWarning;
-};
 
 /**
  * Hardcoded meta-schema for validating shape definitions.
@@ -7485,8 +7491,23 @@ type ThingDetail = {
     pinnedWref?: string;
     name: string;
     kind: string;
+    /**
+     * @deprecated Legacy alias of `shapeName` from the pre-Postgres API
+     * layering — the two are identical for every thing. Read `shapeName`
+     * instead. This field is retired together with the other single-shape read
+     * fields when the multi-shape read arrays land (the multi-shape program's
+     * write-format change).
+     */
     shape?: string;
+    /** Canonical unversioned shape name (e.g. `"Game"`). */
     shapeName?: string;
+    /**
+     * Version-pinned shape wref (e.g. `"Game@v3"`). Naming caveat: despite the
+     * name, this is synthesized from the shape's *current* version at read
+     * time — exact validation provenance is not stored today. The multi-shape
+     * program's certificate records restore captured provenance, after which
+     * this is served from the certificate rather than synthesized.
+     */
     validatedShape?: string;
     version: number;
     active: boolean;

package/dist/index.js

@@ -1,2 +1,2 @@
-export{m as AllStreamOperationsFailedError,s as CliCallVerificationError,w as DEFAULT_API_URL,j as DEFAULT_STREAM_CHUNK_SIZE,b as MAX_COMMIT_VALIDATION_ENCODED_BYTES,a as MAX_COMMIT_VALIDATION_OPERATIONS,k as MAX_STREAM_APPEND_OPERATION_COUNT,u as OperationBuilder,l as PartialStreamSubmissionError,r as SDK_VERSION,f as StreamSubmissionAggregator,G as WarmHubClient,z as WarmHubError,e as commitValidateRequestBodyBytes,E as connectionErrorMessage,o as countStreamAppendResultStatuses,c as createCommitValidateInput,h as createOperationEventRequestId,g as createOperationEventSubmissionId,d as encodeCommitValidateRequestBody,D as isConnectionError,p as isDefiniteStreamAppendRejection,C as isRetryable,B as isWarmHubError,v as normalizeWref,i as operationEventStreamRequestId,x as resolveFunctionLogMode,y as sanitizeErrorMessage,F as sdkVersionIsBelowMinimum,n as streamAppendResultStatus,q as submitOperationsViaStream,A as toWarmHubError,t as verifyCliCall}from'./chunk-CJGZJYNN.js';export{m as CLI_INSTALL_REPO_HEADER,n as CLI_SIGNATURE_HEADER,o as CLI_TIMESTAMP_HEADER,w as CONTENT_FIELD_LIMIT_ERROR,v as MAX_CONTENT_FIELD_BYTES,y as ORG_AUTH_SCOPES,r as REPO_AUTH_SCOPES,x as contentFieldLimitError,z as isKnownOrgAuthScope,s as isKnownRepoAuthScope,M as validateAgainstShape}from'./chunk-CC45V5YE.js';//# sourceMappingURL=index.js.map
+export{m as AllStreamOperationsFailedError,s as CliCallVerificationError,w as DEFAULT_API_URL,j as DEFAULT_STREAM_CHUNK_SIZE,b as MAX_COMMIT_VALIDATION_ENCODED_BYTES,a as MAX_COMMIT_VALIDATION_OPERATIONS,k as MAX_STREAM_APPEND_OPERATION_COUNT,u as OperationBuilder,l as PartialStreamSubmissionError,r as SDK_VERSION,f as StreamSubmissionAggregator,G as WarmHubClient,z as WarmHubError,e as commitValidateRequestBodyBytes,E as connectionErrorMessage,o as countStreamAppendResultStatuses,c as createCommitValidateInput,h as createOperationEventRequestId,g as createOperationEventSubmissionId,d as encodeCommitValidateRequestBody,D as isConnectionError,p as isDefiniteStreamAppendRejection,C as isRetryable,B as isWarmHubError,v as normalizeWref,i as operationEventStreamRequestId,x as resolveFunctionLogMode,y as sanitizeErrorMessage,F as sdkVersionIsBelowMinimum,n as streamAppendResultStatus,q as submitOperationsViaStream,A as toWarmHubError,t as verifyCliCall}from'./chunk-NCX3V2MO.js';export{m as CLI_INSTALL_REPO_HEADER,n as CLI_SIGNATURE_HEADER,o as CLI_TIMESTAMP_HEADER,w as CONTENT_FIELD_LIMIT_ERROR,v as MAX_CONTENT_FIELD_BYTES,y as ORG_AUTH_SCOPES,r as REPO_AUTH_SCOPES,x as contentFieldLimitError,z as isKnownOrgAuthScope,s as isKnownRepoAuthScope,O as validateAgainstShape}from'./chunk-V5UNTMIL.js';//# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/react.js

@@ -1,2 +1,2 @@
-import {G}from'./chunk-CJGZJYNN.js';export{w as DEFAULT_API_URL,r as SDK_VERSION,G as WarmHubClient,z as WarmHubError,A as toWarmHubError}from'./chunk-CJGZJYNN.js';import'./chunk-CC45V5YE.js';import {createContext,useMemo,useState,useEffect,useContext}from'react';import {jsx}from'react/jsx-runtime';var b=createContext(null),p=createContext({isAuthenticated:false,isLoading:true});function P({apiUrl:e,children:t,auth:i,client:o}){let r=o?.name,n=o?.version,s=useMemo(()=>new G({apiUrl:e,accessToken:async()=>await i.getAccessToken()??void 0,client:{name:r,version:n}}),[e,i.getAccessToken,r,n]);return jsx(b.Provider,{value:s,children:jsx(g,{auth:i,client:s,children:t})})}function g({auth:e,client:t,children:i}){let[o,r]=useState(null),n=e.isAuthenticated&&o===t;useEffect(()=>{if(!e.isAuthenticated){r(null);return}let u=false;return t.auth.sync().then(()=>{u||r(t);}).catch(f=>{console.error("auth.sync failed:",f),u||r(t);}),()=>{u=true;}},[e.isAuthenticated,t]);let s=useMemo(()=>({isAuthenticated:e.isAuthenticated&&n,isLoading:e.isLoading||e.isAuthenticated&&!n}),[e.isAuthenticated,e.isLoading,n]);return e.isLoading||e.isAuthenticated&&!n?null:jsx(p.Provider,{value:s,children:i})}function v(){let e=useContext(b);if(!e)throw new Error("useWarmHubClient must be used within a WarmHubProvider");return e}function S(){return useContext(p)}export{P as WarmHubProvider,S as useWarmHubAuth,v as useWarmHubClient};//# sourceMappingURL=react.js.map
+import {G}from'./chunk-NCX3V2MO.js';export{w as DEFAULT_API_URL,r as SDK_VERSION,G as WarmHubClient,z as WarmHubError,A as toWarmHubError}from'./chunk-NCX3V2MO.js';import'./chunk-V5UNTMIL.js';import {createContext,useMemo,useState,useEffect,useContext}from'react';import {jsx}from'react/jsx-runtime';var b=createContext(null),p=createContext({isAuthenticated:false,isLoading:true});function P({apiUrl:e,children:t,auth:i,client:o}){let r=o?.name,n=o?.version,s=useMemo(()=>new G({apiUrl:e,accessToken:async()=>await i.getAccessToken()??void 0,client:{name:r,version:n}}),[e,i.getAccessToken,r,n]);return jsx(b.Provider,{value:s,children:jsx(g,{auth:i,client:s,children:t})})}function g({auth:e,client:t,children:i}){let[o,r]=useState(null),n=e.isAuthenticated&&o===t;useEffect(()=>{if(!e.isAuthenticated){r(null);return}let u=false;return t.auth.sync().then(()=>{u||r(t);}).catch(f=>{console.error("auth.sync failed:",f),u||r(t);}),()=>{u=true;}},[e.isAuthenticated,t]);let s=useMemo(()=>({isAuthenticated:e.isAuthenticated&&n,isLoading:e.isLoading||e.isAuthenticated&&!n}),[e.isAuthenticated,e.isLoading,n]);return e.isLoading||e.isAuthenticated&&!n?null:jsx(p.Provider,{value:s,children:i})}function v(){let e=useContext(b);if(!e)throw new Error("useWarmHubClient must be used within a WarmHubProvider");return e}function S(){return useContext(p)}export{P as WarmHubProvider,S as useWarmHubAuth,v as useWarmHubClient};//# sourceMappingURL=react.js.map
 //# sourceMappingURL=react.js.map

package/package.json

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