@spiffcommerce/core 22.1.5 → 22.2.0-beta.4d3c03ea-bbcf-5554-acbf-81d2affe87e2

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export { Animatable, AnyStepData, AspectType, Asset, AssetType, BringForwardComm
 import { ApolloClient, MutationOptions, FetchResult } from '@apollo/client/core';
 import { RenderableContextService, RenderableContext, ThreeDPreviewService, ModelContainer } from '@spiffcommerce/preview';
 import * as lodash from 'lodash';
+import { ThemeInstallConfigurationResource } from '@spiffcommerce/theme-bridge';
 import { FuseResult } from 'fuse.js';
 
 declare class OptionService {
@@ -1793,6 +1794,13 @@ interface GetWorkflowFromExternalProductOptions extends GetNewWorkflowOptionsBas
 }
 type GetNewWorkflowOptions = GetWorkflowFromIntegrationProductOptions | GetWorkflowFromExternalProductOptions;
 type GetWorkflowOptions = GetWorkflowFromTransactionOptions | GetNewWorkflowOptions;
+interface ClientConfiguration {
+    hubUrl: string;
+    serverUrl: string;
+    servicesApiUrl: string;
+    marketplaceThemeInstallId: string;
+    marketplaceThemeInstallConfigurationId: string;
+}
 /**
  * The Spiff Commerce Javascript Client. Required for
  * creating workflow experiences.
@@ -1803,12 +1811,17 @@ declare class SpiffCommerceClient {
     private currencyCode?;
     private customer?;
     private activeIntegration?;
+    private marketplaceThemeInstallId?;
+    private marketplaceThemeInstallConfigurationId?;
     /**
      * @deprecated This object is passed to the WorkflowExperience constructor and is no longer needed on this object.
      * Any functionality referencing this object will be removed in a future release.
      */
     private experienceOptions?;
     constructor(options: ClientOptions);
+    /** @deprecated Use configureClient instead */
+    configureUrls(hubUrl: string, serverUrl: string, servicesApiUrl: string): void;
+    configureClient(configuration: ClientConfiguration): void;
     /**
      * @returns The asset manager allows for common operations related to assets
      * and the Spiff Commerce platform.
@@ -1937,7 +1950,6 @@ declare class SpiffCommerceClient {
      * @returns The transaction associated with this client.
      */
     getTransaction(): Transaction;
-    configureUrls(hubUrl: string, serverUrl: string, servicesApiUrl: string): void;
     /**
      * A function used to synchronize transaction state with the server.
      * @param options New state details. To be spread into the query.
@@ -2120,6 +2132,11 @@ interface WorkflowManager {
      * The updated transactionShareActions overwrite the existing values on the Transaction object returned by `getTransaction()`.
      */
     updateTransactionShareActions(): Promise<void>;
+    /**
+     * Re-fetches the stakeholders and currentStakeholder for this WorkflowManager's Transaction object.
+     * The updated stakeholders and currentStakeholder overwrite the existing values on the Transaction object returned by `getTransaction()`.
+     */
+    updateTransactionStakeholders(): Promise<void>;
 }
 
 interface StepService<T extends AnyStepData> {
@@ -2285,6 +2302,8 @@ interface Transaction {
      * The users who have access to this transaction.
      */
     stakeholders?: Stakeholder[];
+    /** The stakeholder of the currently logged in user, if applicable. */
+    currentStakeholder?: Stakeholder;
     /**
      * The amount of this transaction that was, or will be, ordered
      */
@@ -2308,6 +2327,9 @@ interface Transaction {
      * A list of actions that have been associated to this transaction. To be used by the client to interact further post design.
      */
     transactionShareActions?: TransactionShareAction[];
+    /** Whether any share actions for this Transaction require the user to be authenticated as a stakeholder */
+    hasAuthenticatedActions?: boolean;
+    marketplaceThemeInstallConfiguration?: ThemeInstallConfigurationResource;
 }
 interface TransactionShareAction {
     id: string;
@@ -3126,6 +3148,7 @@ declare class MockWorkflowManager implements WorkflowManager {
     getValidationErrors(): {
         steps: Map<any, any>;
     };
+    updateTransactionStakeholders(): Promise<void>;
 }
 
 declare const generateCommands: (designInputSteps: DesignInputStep[], workflow: Workflow, layouts: ILayout[], productOverlayImageUrl?: string) => Promise<CanvasCommand[]>;