@salesforce/platform-sdk 11.64.0 → 11.66.2

package/dist/data/index.d.ts

@@ -1,4 +1,4 @@
-import { DataSDK, ExtendedSDK, Plugin, PluginsFor, SDKOptions, UniquePluginNames, ValidAliasNames } from '../core';
+import { DataSDK, ExtendedSDK, Extension, ExtensionsFor, SDKOptions, UniqueExtensionNames, ValidAliasNames } from '../core';
 import { MosaicDataSDKOptions } from './mosaic';
 /**
  * A callback the host invokes for a given HTTP status (see {@link WebAppDataSDKOptions.onStatus}).
@@ -27,28 +27,30 @@ export interface WebAppDataSDKOptions {
 }
 export type { MosaicDataSDKOptions };
 /**
- * A plugin authored for the DataSDK surface: {@link Plugin} with the base SDK
- * pre-applied to `DataSDK`. Author these with {@link defineDataPlugin}.
+ * A extension authored for the DataSDK surface: {@link Extension} with the base SDK
+ * pre-applied to `DataSDK`. Author these with {@link defineDataExtension}.
  */
-export type DataSDKPlugin<Name extends string = string, Api = unknown> = Plugin<DataSDK, Name, Api>;
+export type DataSDKExtension<Name extends string = string, Api = unknown> = Extension<DataSDK, Name, Api>;
 /**
- * Author a DataSDK plugin without annotating `setup`'s parameter — the base
+ * Author a DataSDK extension without annotating `setup`'s parameter — the base
  * SDK is bound to `DataSDK`, so `setup(sdk)` infers `sdk: DataSDK`. This is the
- * recommended way to author DataSDK plugins.
+ * recommended way to author DataSDK extensions.
  *
  * Because `DataSDK` is fixed here, an author can never forget the annotation
  * and silently get `Sdk = unknown` — the universally-attachable binding that
- * would slip a DataSDK-only plugin past the per-surface `PluginsFor` guard.
- * Equivalent to the internal `definePlugin` with `Sdk = DataSDK` pre-applied;
- * see {@link createPluginFactory} for the underlying mechanism.
+ * would slip a DataSDK-only extension past the per-surface `ExtensionsFor` guard.
+ * Equivalent to the internal `defineExtension` with `Sdk = DataSDK` pre-applied;
+ * see {@link createExtensionFactory} for the underlying mechanism.
  */
-export declare const defineDataPlugin: <const Name extends string, Api>(plugin: Plugin<DataSDK, import('..').LiteralName<Name>, Api, []>) => Plugin<DataSDK, Name, Api, []>;
+export declare const defineDataExtension: <const Name extends string, Api>(extension: Extension<DataSDK, import('..').LiteralName<Name>, Api, []>) => Extension<DataSDK, Name, Api, []>;
 /**
- * A DataSDK carrying every namespace contributed by an ordered plugin tuple.
- * Entries may be bare plugins or `{ plugin, as }` aliases; each mounts under its
- * effective key (the alias when present), so aliasing is reflected here for free.
+ * A DataSDK carrying an `ext` namespace with every API contributed by an
+ * ordered extension tuple (e.g. `sdk.ext.labels`). Entries may be bare extensions or
+ * `{ extension, as }` aliases; each mounts under its effective key (the alias when
+ * present) inside `ext`, so aliasing is reflected here for free. A extension-less
+ * tuple resolves to a plain {@link DataSDK} with no `ext` key.
  */
-export type DataSDKWithPlugins<Plugins extends PluginsFor<DataSDK>> = ExtendedSDK<DataSDK, Plugins>;
+export type DataSDKWithExtensions<Extensions extends ExtensionsFor<DataSDK>> = ExtendedSDK<DataSDK, Extensions>;
 /**
  * Options for creating a DataSDK instance.
  */
@@ -64,26 +66,32 @@ export interface DataSDKOptions extends SDKOptions {
      */
     mosaic?: MosaicDataSDKOptions;
     /**
-     * Plugins to attach. Each entry is a bare {@link DataSDKPlugin} (mounts under
-     * its own `name`) or a `{ plugin, as }` alias (mounts under `as`). Aliasing
-     * is the recourse when two plugins want the same key — e.g. two third-party
-     * labels plugins the consumer can't edit.
+     * Extensions to attach. Each entry is a bare {@link DataSDKExtension} (mounts under
+     * its own `name`) or a `{ extension, as }` alias (mounts under `as`), and each
+     * lands inside the SDK's `ext` namespace — `sdk.ext.<name>`. Aliasing is the
+     * recourse when two extensions want the same key — e.g. two third-party labels
+     * extensions the consumer can't edit.
+     *
+     * Pass the array inline to keep `sdk.ext.<name>` typed. A pre-bound
+     * `const extensions: DataSDKExtension[] = […]` widens the tuple away, so the
+     * result narrows to a plain {@link DataSDK} with no typed `ext`; add `as const`
+     * to the array to recover it.
      */
-    plugins?: PluginsFor<DataSDK>;
+    extensions?: ExtensionsFor<DataSDK>;
 }
 /**
  * Create and initialize a DataSDK instance based on the detected surface.
  *
  * @param options - Optional configuration including surface override, web app
- *   options, and plugins to attach
- * @returns Promise resolving to an initialized DataSDK, extended per plugin
+ *   options, and extensions to attach
+ * @returns Promise resolving to an initialized DataSDK, extended per extension
  *
  * @remarks
  * Each call creates a new instance; options are applied to every call.
  *
- * When `plugins` is supplied, the result type accumulates each plugin's
- * namespace under its own key (see {@link DataSDKWithPlugins}); otherwise it is
- * a plain {@link DataSDK}.
+ * When `extensions` is supplied, the result type accumulates each extension's
+ * namespace under its own key inside the SDK's `ext` container — `sdk.ext.<name>`
+ * (see {@link DataSDKWithExtensions}); otherwise it is a plain {@link DataSDK}.
  *
  * 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.
@@ -109,9 +117,9 @@ export interface DataSDKOptions extends SDKOptions {
  * }
  * ```
  */
-export declare function createDataSDK<const Plugins extends PluginsFor<DataSDK> = []>(options?: Omit<DataSDKOptions, "plugins"> & {
-    plugins?: Plugins;
-} & UniquePluginNames<Plugins> & ValidAliasNames<Plugins>): Promise<DataSDKWithPlugins<Plugins>>;
+export declare function createDataSDK<const Extensions extends ExtensionsFor<DataSDK> = []>(options?: Omit<DataSDKOptions, "extensions"> & {
+    extensions?: Extensions;
+} & UniqueExtensionNames<Extensions> & ValidAliasNames<Extensions>): Promise<DataSDKWithExtensions<Extensions>>;
 export { gql } from './gql';
 export type { CacheControl, DataSDK, DataSDKGraphQL, GraphQLError, GraphQLRawDocument, GraphQLRequest, GraphQLRequestHeaders, GraphQLResponse, MutateOptions, MutationResult, QueryOptions, QueryResult, QuerySubscriber, SDKOptions, Unsubscribe, } from '../core';
 /**

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,EACX,OAAO,EACP,WAAW,EACX,MAAM,EACN,UAAU,EACV,UAAU,EACV,iBAAiB,EACjB,eAAe,EACf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAiB,KAAK,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAMpE;;;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;IACnD;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,GAAG,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;AAEpG;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,sIAAiC,CAAC;AAE/D;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,OAAO,SAAS,UAAU,CAAC,OAAO,CAAC,IAAI,WAAW,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAEpG;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IACjD;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;CAC9B;AAqCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAiBH,wBAAgB,aAAa,CAAC,KAAK,CAAC,OAAO,SAAS,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,EAC3E,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,SAAS,CAAC,GAAG;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,iBAAiB,CAAC,OAAO,CAAC,GAC7F,eAAe,CAAC,OAAO,CAAC,GACvB,OAAO,CAAC,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC;AAexC,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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EACX,OAAO,EACP,WAAW,EACX,SAAS,EACT,aAAa,EACb,UAAU,EACV,oBAAoB,EACpB,eAAe,EACf,MAAM,SAAS,CAAC;AACjB,OAAO,EAAiB,KAAK,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAKpE;;;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;IACnD;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,YAAY,EAAE,oBAAoB,EAAE,CAAC;AAErC;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,EAAE,GAAG,GAAG,OAAO,IAAI,SAAS,CACpF,OAAO,EACP,IAAI,EACJ,GAAG,CACH,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,mBAAmB,+IAAoC,CAAC;AAErE;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,CAAC,UAAU,SAAS,aAAa,CAAC,OAAO,CAAC,IAAI,WAAW,CACzF,OAAO,EACP,UAAU,CACV,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IACjD;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;OAGG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B;;;;;;;;;;;OAWG;IACH,UAAU,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;CACpC;AAqCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AAiBH,wBAAgB,aAAa,CAAC,KAAK,CAAC,UAAU,SAAS,aAAa,CAAC,OAAO,CAAC,GAAG,EAAE,EACjF,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,YAAY,CAAC,GAAG;IAC9C,UAAU,CAAC,EAAE,UAAU,CAAC;CACxB,GAAG,oBAAoB,CAAC,UAAU,CAAC,GACnC,eAAe,CAAC,UAAU,CAAC,GAC1B,OAAO,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAC,CAAC;AAe9C,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"}