@salesforce/platform-sdk 11.45.9 → 11.45.11

package/dist/core/data.d.ts

@@ -3,6 +3,10 @@
  * All rights reserved.
  * For full license text, see the LICENSE.txt file
  */
+/**
+ * A single GraphQL error entry returned in a {@link GraphQLResponse}.
+ * Contains the error message and optional location/path information.
+ */
 export interface GraphQLError {
     message: string;
     locations?: {
@@ -11,6 +15,11 @@ export interface GraphQLError {
     }[];
     path?: string[];
 }
+/**
+ * The raw GraphQL response envelope containing data and optional errors.
+ *
+ * @typeParam T - The shape of the `data` field.
+ */
 export interface GraphQLResponse<T> {
     data: T;
     errors?: GraphQLError[];
@@ -28,6 +37,11 @@ export interface GraphQLResponse<T> {
  * OpenAI surface delegates to an MCP tool that exposes no header channel.
  */
 export type GraphQLRequestHeaders = HeadersInit;
+/**
+ * A GraphQL request containing the operation source and optional variables.
+ *
+ * @typeParam V - The shape of the `variables` object.
+ */
 export interface GraphQLRequest<V = Record<string, unknown>> {
     query: string;
     variables?: V;
@@ -58,6 +72,11 @@ export interface QuerySnapshot<T> {
     data: T | undefined;
     errors?: GraphQLError[];
 }
+/**
+ * Callback invoked with each new {@link QuerySnapshot}.
+ *
+ * @typeParam T - The shape of the query result data.
+ */
 export type QuerySubscriber<T> = (snapshot: QuerySnapshot<T>) => void;
 /**
  * Reactive query handle resolved by {@link DataSDKGraphQL.query}.
@@ -68,11 +87,24 @@ export type QuerySubscriber<T> = (snapshot: QuerySnapshot<T>) => void;
  * `refresh` re-issues the underlying request, bypassing the cache where one
  * exists and propagating the result to subscribers.
  *
+ * @remarks
  * On uncached surfaces (Mosaic, OpenAI), `subscribe` only emits in response
  * to `refresh()` — there is no cache to push background updates.
  */
 export interface QueryResult<T> extends QuerySnapshot<T> {
     subscribe(cb: QuerySubscriber<T>): Unsubscribe;
+    /**
+     * Re-fetch the query, bypassing the cache where one exists and
+     * propagating the result to subscribers.
+     *
+     * @remarks
+     * Never rejects. A failed re-fetch does not throw on the awaited
+     * `refresh()` call: on uncached surfaces (Mosaic, OpenAI) the failure is
+     * delivered to `subscribe()` callbacks as a {@link QuerySnapshot} with a
+     * populated `errors` array; on cached surfaces (WebApp) a failed re-fetch
+     * is not observable on the awaited call — subscribers receive the
+     * resulting cache state.
+     */
     refresh(): Promise<void>;
 }
 /**
@@ -98,12 +130,23 @@ export type CacheControlShorthand = "no-cache" | "only-if-cached";
 /**
  * Override the default TTL (300 seconds) with a custom max-age in seconds.
  *
+ * @remarks
  * - `maxAge: 0` — entry is written but immediately considered stale
  *   (always re-fetches, similar to `"no-cache"` but writes a 0s TTL).
  * - Invalid values (NaN, Infinity, negative) fall back to the 300s default.
  */
 export interface CacheControlMaxAge {
     type: "max-age";
+    /**
+     * Cache TTL in seconds.
+     *
+     * @remarks
+     * Rule of thumb by data volatility: short (~30s) for frequently-changing
+     * records, longer (~15min, i.e. 900s) for stable object/metadata.
+     *
+     * @example 30
+     * @example 900
+     */
     maxAge: number;
 }
 /**
@@ -124,11 +167,16 @@ export interface QueryOptions<V = Record<string, unknown>> {
     cacheControl?: CacheControl;
     /**
      * Extra HTTP headers for this request, merged over the surface's canonical
-     * header set. Part of the cache key: two calls that differ only in `headers`
-     * resolve to different cache entries. This prevents a response scoped by a
-     * header — e.g. `Authorization` — from being served to a later caller that
-     * passed a different value. Calls with equivalent headers still share an
-     * entry. @see {@link GraphQLRequestHeaders}
+     * header set.
+     *
+     * @remarks
+     * On cached surfaces (WebApp), `headers` is part of the cache key: two calls
+     * that differ only in `headers` resolve to different cache entries. This
+     * prevents a response scoped by a header — e.g. `Authorization` — from being
+     * served to a later caller that passed a different value, while calls with
+     * equivalent headers still share an entry.
+     *
+     * @see {@link GraphQLRequestHeaders}
      */
     headers?: GraphQLRequestHeaders;
 }
@@ -167,18 +215,79 @@ export interface DataSDKGraphQL {
      * updates, so `refresh()` is the sole source of new snapshots and each
      * call costs one network request.
      *
-     * Mutations and subscriptions passed here are rejected via `result.errors`
-     * (the Promise still resolves — it does not reject). Parse failures are
-     * surfaced the same way.
+     * @remarks
+     * The Promise always resolves — it does not reject. All failures (parse
+     * errors, wrong operation kind, non-serializable variables, network errors)
+     * are funnelled into the resolved `result.errors` array. Mutations and
+     * subscriptions passed here are rejected via `result.errors`.
+     *
+     * @example
+     * ```typescript
+     * import { createDataSDK, gql } from '@salesforce/platform-sdk';
+     *
+     * const sdk = await createDataSDK();
+     *
+     * // Narrow the optional `graphql` namespace once, then call without `?.`.
+     * if (!sdk.graphql) {
+     *   throw new Error('GraphQL not supported on this surface');
+     * }
+     *
+     * const result = await sdk.graphql.query<{ account: { name: string } }>({
+     *   query: gql`query GetAccount($id: ID!) { account(id: $id) { name } }`,
+     *   variables: { id: '001xx000003DGb0AAG' }
+     * });
+     *
+     * if (result.errors) {
+     *   console.error('GraphQL errors:', result.errors);
+     * } else {
+     *   console.log('Account name:', result.data?.account?.name);
+     * }
+     * ```
      */
     query<T, V = Record<string, unknown>>(options: QueryOptions<V>): Promise<QueryResult<T>>;
     /**
      * Run a GraphQL mutation. Pass-through to the underlying transport — does
      * not read or write the cache. Queries and subscriptions passed here are
      * rejected via the resolved `errors` field.
+     *
+     * @remarks
+     * The Promise always resolves — it does not reject. All failures (parse
+     * errors, wrong operation kind, non-serializable variables, network errors)
+     * are funnelled into the resolved `result.errors` array.
+     *
+     * @example
+     * ```typescript
+     * import { createDataSDK, gql } from '@salesforce/platform-sdk';
+     *
+     * const sdk = await createDataSDK();
+     *
+     * // Narrow the optional `graphql` namespace once, then call without `?.`.
+     * if (!sdk.graphql) {
+     *   throw new Error('GraphQL not supported on this surface');
+     * }
+     *
+     * const result = await sdk.graphql.mutate<{ updateAccount: { id: string; name: string } }>({
+     *   mutation: gql`mutation UpdateAccount($id: ID!, $name: String!) {
+     *     updateAccount(id: $id, name: $name) { id name }
+     *   }`,
+     *   variables: { id: '001xx000003DGb0AAG', name: 'Acme Corp' }
+     * });
+     *
+     * if (result.errors) {
+     *   console.error('Mutation errors:', result.errors);
+     * } else {
+     *   console.log('Updated account:', result.data?.updateAccount);
+     * }
+     * ```
      */
     mutate<T, V = Record<string, unknown>>(options: MutateOptions<V>): Promise<MutationResult<T>>;
 }
+/**
+ * The data SDK object returned by {@link createDataSDK}.
+ *
+ * May be a bare `{}` on unsupported surfaces — feature-detect `graphql` or
+ * `fetch` before use to avoid runtime errors.
+ */
 export interface DataSDK {
     /** GraphQL namespace. Present when the surface supports data operations. */
     graphql?: DataSDKGraphQL;
@@ -188,6 +297,7 @@ export interface DataSDK {
      * @param input - The URL or Request object
      * @param init - Optional RequestInit configuration
      * @returns Promise resolving to Response
+     * @throws {TypeError} when the network request fails.
      */
     fetch?: typeof fetch;
 }

package/dist/core/data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../src/core/data.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,WAAW,YAAY;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC/C,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,MAAM,WAAW,eAAe,CAAC,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,qBAAqB,GAAG,WAAW,CAAC;AAEhD,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,CAAC,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,yCAAyC;IACzC,OAAO,CAAC,EAAE,qBAAqB,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC;AAErC;;;;;GAKG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC/B,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEtE;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;IACvD,SAAS,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;IAC/C,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC;IAChC,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAElE;;;;;;GAMG;AACH,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,qBAAqB,GAAG,kBAAkB,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACxD,KAAK,EAAE,kBAAkB,CAAC;IAC1B,SAAS,CAAC,EAAE,CAAC,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oFAAoF;IACpF,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACzD,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,SAAS,CAAC,EAAE,CAAC,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAEzF;;;;OAIG;IACH,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;CAC9F;AAED,MAAM,WAAW,OAAO;IACvB,4EAA4E;IAC5E,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACrB"}
+{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../src/core/data.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC/C,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,CAAC;IACjC,IAAI,EAAE,CAAC,CAAC;IACR,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,qBAAqB,GAAG,WAAW,CAAC;AAEhD;;;;GAIG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,CAAC,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,yCAAyC;IACzC,OAAO,CAAC,EAAE,qBAAqB,CAAC;CAChC;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC;AAErC;;;;;GAKG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC/B,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED;;;;GAIG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC;AAEtE;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,CAAE,SAAQ,aAAa,CAAC,CAAC,CAAC;IACvD,SAAS,CAAC,EAAE,EAAE,eAAe,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC;IAC/C;;;;;;;;;;;OAWG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc,CAAC,CAAC;IAChC,IAAI,EAAE,CAAC,GAAG,SAAS,CAAC;IACpB,MAAM,CAAC,EAAE,YAAY,EAAE,CAAC;CACxB;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,qBAAqB,GAAG,UAAU,GAAG,gBAAgB,CAAC;AAElE;;;;;;;GAOG;AACH,MAAM,WAAW,kBAAkB;IAClC,IAAI,EAAE,SAAS,CAAC;IAChB;;;;;;;;;OASG;IACH,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,qBAAqB,GAAG,kBAAkB,CAAC;AAEtE;;GAEG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACxD,KAAK,EAAE,kBAAkB,CAAC;IAC1B,SAAS,CAAC,EAAE,CAAC,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,oFAAoF;IACpF,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACzD,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,SAAS,CAAC,EAAE,CAAC,CAAC;IACd,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC;CAChC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,cAAc;IAC9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA0CG;IACH,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;IAEzF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,MAAM,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;CAC9F;AAED;;;;;GAKG;AACH,MAAM,WAAW,OAAO;IACvB,4EAA4E;IAC5E,OAAO,CAAC,EAAE,cAAc,CAAC;IAEzB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACrB"}

package/dist/data/gql.d.ts

@@ -3,5 +3,21 @@
  * All rights reserved.
  * For full license text, see the LICENSE.txt file
  */
+/**
+ * A pass-through template tag for GraphQL query/mutation strings. Exists so IDE GraphQL
+ * integrations syntax-highlight and validate the embedded query. It performs no parsing —
+ * it simply interpolates values and returns the assembled string.
+ *
+ * @param strings - The template string segments.
+ * @param values - Interpolated values, stringified and spliced between segments.
+ * @returns The assembled GraphQL document string.
+ *
+ * @example
+ * ```typescript
+ * import { gql } from '@salesforce/platform-sdk';
+ *
+ * const query = gql`query { account { name } }`;
+ * ```
+ */
 export declare function gql(strings: TemplateStringsArray, ...values: unknown[]): string;
 //# sourceMappingURL=gql.d.ts.map

package/dist/data/gql.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"gql.d.ts","sourceRoot":"","sources":["../../src/data/gql.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,wBAAgB,GAAG,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAS/E"}
+{"version":3,"file":"gql.d.ts","sourceRoot":"","sources":["../../src/data/gql.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,GAAG,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAM/E"}

package/dist/data/index.d.ts

@@ -1,11 +1,23 @@
 import { DataSDK, SDKOptions } from '../core';
 import { MosaicDataSDKOptions } from './mosaic';
+/**
+ * A callback the host invokes for a given HTTP status (see {@link WebAppDataSDKOptions.onStatus}).
+ * May be sync or async.
+ */
 export type StatusCallback = () => Promise<unknown> | void;
 /**
  * Options for creating a WebAppDataSDK
  */
 export interface WebAppDataSDKOptions {
+    /**
+     * The API base path prefix.
+     * @example "/services/data/v64.0"
+     */
     basePath?: string;
+    /**
+     * Per-HTTP-status callbacks (e.g. re-auth on 401).
+     * @example { 401: () => reauthenticate() }
+     */
     onStatus?: Partial<Record<number, StatusCallback>>;
 }
 export type { MosaicDataSDKOptions };
@@ -13,19 +25,59 @@ export type { MosaicDataSDKOptions };
  * Options for creating a DataSDK instance.
  */
 export interface DataSDKOptions extends SDKOptions {
+    /**
+     * WebApp-surface options.
+     * @example { basePath: "/services/data/v64.0" }
+     */
     webapp?: WebAppDataSDKOptions;
+    /**
+     * Mosaic-surface options.
+     * @example { instanceUrl: "https://my.salesforce.com", accessToken: "00D..." }
+     */
     mosaic?: MosaicDataSDKOptions;
 }
 /**
  * Create and initialize a DataSDK instance based on the detected surface.
- * Each call creates a new instance; options are applied to every call.
  *
  * @param options - Optional configuration including surface override and web app options
  * @returns Promise resolving to an initialized DataSDK instance
+ *
+ * @remarks
+ * Each call creates a new instance; options are applied to every call.
+ *
+ * If the surface is unusable (e.g. MCPApps handshake never succeeded, or detection throws),
+ * the function resolves to a bare `{}` rather than rejecting, so the host still renders.
+ * Feature-detect `sdk.graphql` / `sdk.fetch` before use.
+ *
+ * @throws {TypeError} when the returned Promise is used without `await`
+ *
+ * @example
+ * ```typescript
+ * import { createDataSDK, gql } from '@salesforce/platform-sdk';
+ *
+ * const sdk = await createDataSDK();
+ * const result = await sdk.graphql?.query({
+ *   query: gql`query { account { name } }`
+ * });
+ *
+ * if (!result) {
+ *   console.error('GraphQL not supported on this surface');
+ * } else if (result.errors) {
+ *   console.error('GraphQL errors:', result.errors);
+ * } else {
+ *   console.log(result.data);
+ * }
+ * ```
  */
 export declare function createDataSDK(options?: DataSDKOptions): Promise<DataSDK>;
 export { gql } from './gql';
 export type { CacheControl, DataSDK, DataSDKGraphQL, GraphQLError, GraphQLRawDocument, GraphQLRequest, GraphQLRequestHeaders, GraphQLResponse, MutateOptions, MutationResult, QueryOptions, QueryResult, QuerySubscriber, SDKOptions, Unsubscribe, } from '../core';
+/**
+ * A utility type that unwraps the `node` element type from a Relay-style
+ * `{ edges: [{ node }] }` connection. Resolves to `never` when `T` is not such a connection.
+ *
+ * @typeParam T - The connection type to unwrap.
+ */
 export type NodeOfConnection<T> = T extends {
     edges?: (infer E)[] | null;
 } | null ? E extends {

package/dist/data/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAiB,KAAK,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAIpE,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;CACnD;AAED,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IACjD,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC9B;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CA2BxE;AAED,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,YAAY,EACX,YAAY,EACZ,OAAO,EACP,cAAc,EACd,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,qBAAqB,EACrB,eAAe,EACf,aAAa,EACb,cAAc,EACd,YAAY,EACZ,WAAW,EACX,eAAe,EACf,UAAU,EACV,WAAW,GACX,MAAM,SAAS,CAAC;AAEjB,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS;IAC3C,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;CAC3B,GAAG,IAAI,GACL,CAAC,SAAS;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,IAAI,GAClC,CAAC,GACD,KAAK,GACN,KAAK,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAiB,KAAK,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAIpE;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC,CAAC;CACnD;AAED,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IACjD;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,wBAAgB,aAAa,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CA2BxE;AAED,OAAO,EAAE,GAAG,EAAE,MAAM,OAAO,CAAC;AAC5B,YAAY,EACX,YAAY,EACZ,OAAO,EACP,cAAc,EACd,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACd,qBAAqB,EACrB,eAAe,EACf,aAAa,EACb,cAAc,EACd,YAAY,EACZ,WAAW,EACX,eAAe,EACf,UAAU,EACV,WAAW,GACX,MAAM,SAAS,CAAC;AAEjB;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS;IAC3C,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC;CAC3B,GAAG,IAAI,GACL,CAAC,SAAS;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;CAAE,GAAG,IAAI,GAClC,CAAC,GACD,KAAK,GACN,KAAK,CAAC"}

package/dist/data/index.js

@@ -245,7 +245,7 @@ const w = "Accept-Language", me = (r) => {
     return u(r);
   const [t, n] = r;
   return (t instanceof Request && !n?.headers ? t.headers.has(w) : new Headers(n?.headers).has(w)) ? u(r) : u(b(w, e, r));
-}, ye = "X-SFDC-Client-Name", be = "X-SFDC-Client-Version", ve = "@salesforce/platform-sdk", Se = "11.45.9", ge = (r) => {
+}, ye = "X-SFDC-Client-Name", be = "X-SFDC-Client-Version", ve = "@salesforce/platform-sdk", Se = "11.45.11", ge = (r) => {
   let e = b(ye, ve, r);
   return e = b(be, Se, e), u(e);
 }, we = "X-CSRF-Token";

package/dist/data/mosaic/index.d.ts

@@ -3,8 +3,20 @@ import { DataSDK, DataSDKGraphQL } from '../../core';
  * Options for creating a MosaicDataSDK
  */
 export interface MosaicDataSDKOptions {
+    /**
+     * The Salesforce instance URL.
+     * @example "https://my.salesforce.com"
+     */
     instanceUrl?: string;
+    /**
+     * An OAuth access token for server-side auth.
+     * @example "00Dxx0000001gP!AQ…"
+     */
     accessToken?: string;
+    /**
+     * The Salesforce API version.
+     * @example "64.0"
+     */
     apiVersion?: string;
 }
 /**

package/dist/data/mosaic/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/data/mosaic/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAmC,MAAM,YAAY,CAAC;AAc3F;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,qBAAa,aAAc,YAAW,OAAO;IAC5C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAe;IAC3C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;gBAErB,OAAO,CAAC,EAAE,oBAAoB;YAa5B,iBAAiB;CAc/B"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/data/mosaic/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAmC,MAAM,YAAY,CAAC;AAc3F;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACpC;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;GAKG;AACH,qBAAa,aAAc,YAAW,OAAO;IAC5C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAe;IAC3C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,QAAQ,CAAC,OAAO,EAAE,cAAc,CAAC;gBAErB,OAAO,CAAC,EAAE,oBAAoB;YAa5B,iBAAiB;CAc/B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/platform-sdk",
-  "version": "11.45.9",
+  "version": "11.45.11",
   "license": "SEE LICENSE IN LICENSE.txt",
   "type": "module",
   "main": "./dist/index.js",
@@ -111,7 +111,8 @@
     "build": "vite build",
     "clean": "rm -rf dist",
     "dev": "vite build --watch",
-    "test": "vitest run",
+    "test": "vitest run && npm run test:examples",
+    "test:examples": "tsx scripts/check-examples.mts",
     "test:watch": "vitest",
     "test:coverage": "vitest run --coverage"
   },
@@ -125,7 +126,7 @@
     "@conduit-client/service-pubsub": "3.19.6",
     "@conduit-client/service-retry": "3.19.6",
     "@conduit-client/utils": "3.19.6",
-    "@salesforce/jsonrpc": "^11.45.9",
+    "@salesforce/jsonrpc": "^11.45.11",
     "@salesforce/sf-embedding-bridge": "2.2.5-rc.2"
   },
   "peerDependencies": {
@@ -133,6 +134,8 @@
     "o11y_schema": ">=264.85.0"
   },
   "devDependencies": {
+    "ts-morph": "^27.0.2",
+    "tsx": "^4.21.0",
     "vite": "^7.3.5",
     "vite-plugin-dts": "^4.5.4",
     "vitest": "^4.0.6"