@veloceapps/api 8.0.0-99 → 9.0.0-1

package/index.d.ts

@@ -4,6 +4,7 @@ export { VeloceAuthService } from './lib/services/auth.service';
 export { CatalogAdminApiService } from './lib/services/catalog-admin-api.service';
 export { CatalogApiService } from './lib/services/catalog-api.service';
 export { ConfigurationApiService } from './lib/services/configuration-api.service';
+export { ConfigurationProcessorsApiService } from './lib/services/configuration-processors-api.service';
 export { ConfigurationSettingsApiService } from './lib/services/configuration-settings-api.service';
 export { ContextApiService } from './lib/services/context-api.service';
 export { ContractedPriceApiService } from './lib/services/contracted-price-api.service';
@@ -11,12 +12,14 @@ export { DeltaApiService } from './lib/services/delta-api.service';
 export { DocumentAttachmentApiService } from './lib/services/document-attachment-api.service';
 export { DocumentTemplatesApiService } from './lib/services/document-templates-api.service';
 export { EndpointsApiService } from './lib/services/endpoints-api.service';
+export { FlowStateApiService } from './lib/services/flow-state-api';
 export { FlowsApiService } from './lib/services/flows-api.service';
 export { GuidedSellingsAdminApiService } from './lib/services/guided-sellings-admin-api.service';
 export { GuidedSellingApiService } from './lib/services/guided-sellings-api.service';
 export { OffersApiService } from './lib/services/offers-api.service';
 export { OrgInfoApiService } from './lib/services/org-info-api.service';
 export { PicklistsApiService } from './lib/services/picklists-api.service';
+export { PortalsApiService } from './lib/services/portals-api.service';
 export { PriceApiService } from './lib/services/price-api.service';
 export { ProceduresApiService } from './lib/services/procedures-api.service';
 export { ProductApiService } from './lib/services/product-api.service';
@@ -35,6 +38,5 @@ export { StatefulConfigurationApiService } from './lib/services/stateful-configu
 export { UIDefinitionsApiService } from './lib/services/ui-definitions-api.service';
 export { UITemplatesApiService } from './lib/services/ui-templates-api.service';
 export { VeloceObjectsApiService } from './lib/services/veloce-objects-api.service';
-export { PortalsApiService } from './lib/services/portals-api.service';
-export { ConfigurationProcessorsApiService } from './lib/services/configuration-processors-api.service';
+export { SandboxManagerApiService } from './lib/services/sandbox-manager-api.service';
 export * from './lib/types';

package/lib/services/account-api.service.d.ts

@@ -1,4 +1,4 @@
-import { Account, BaseHttpService, HttpRequestConfigurableOptions, LineItem, Order, Quote } from '@veloceapps/core';
+import { Account, AccountAssetsState, BaseHttpService, HttpRequestConfigurableOptions, LineItem, Order, Quote } from '@veloceapps/core';
 import { Observable } from 'rxjs';
 import { QuerySearchParams } from '../types';
 import * as i0 from "@angular/core";
@@ -9,6 +9,7 @@ export declare class AccountApiService {
     getAccounts$(options?: HttpRequestConfigurableOptions): Observable<Account[]>;
     searchAccounts$(searchParams?: QuerySearchParams, options?: HttpRequestConfigurableOptions): Observable<Account[]>;
     getAccount$(id: string, options?: HttpRequestConfigurableOptions): Observable<Account>;
+    getAssetsState(accountId: string, options?: HttpRequestConfigurableOptions): Observable<AccountAssetsState>;
     getAssets(accountId: string, options?: HttpRequestConfigurableOptions): Observable<LineItem[]>;
     getOrders(accountId: string, options?: HttpRequestConfigurableOptions): Observable<Order[]>;
     getQuotes(accountId: string, options?: HttpRequestConfigurableOptions): Observable<Quote[]>;

package/lib/services/flow-state-api.d.ts

@@ -0,0 +1,84 @@
+import { BaseHttpService, ConfigurationStateExecuteRequest, ConfigurationStateNewRequest, ConfigurationStateStartRequest, FlowState, FlowStateExecutionRequestDTO, FlowStateExecutionResult, FlowStateInitRequest, FlowStateInitResponse } from '@veloceapps/core';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+export declare class FlowStateApiService {
+    private httpService;
+    private readonly SERVICE_URL;
+    constructor(httpService: BaseHttpService);
+    /**
+     * Initialize flow state
+     * @param request Request
+     * @returns Flow initialization response, which contains session ID and result of selectors
+     */
+    init(request: FlowStateInitRequest): Observable<FlowStateInitResponse>;
+    /**
+     * Get existing state by ID
+     * @param id ID
+     * @returns Flow State
+     */
+    get(id: string): Observable<FlowState>;
+    /**
+     * Execute actions/selectors
+     * @param id State ID
+     * @param request Request
+     * @returns Execute result
+     */
+    execute(id: string, request: FlowStateExecutionRequestDTO): Observable<FlowStateExecutionResult>;
+    /**
+     * Save Quote in the state
+     * @param id State ID
+     */
+    save(id: string): Observable<{
+        quoteId: string;
+    }>;
+    /**
+     * Submit Quote in the state
+     * @param id State ID
+     */
+    submit(id: string): Observable<{
+        quoteId: string;
+    }>;
+    /**
+     * Close Flow state
+     * @param id State ID
+     */
+    cancel(id: string): Observable<void>;
+    /**
+     * Initialize stateful configuration
+     * @param stateId string
+     * @param request Request
+     * @returns Flow initialization response, which contains session ID and result of selectors
+     */
+    newConfiguration(stateId: string, request: ConfigurationStateNewRequest): Observable<FlowStateExecutionResult>;
+    /**
+     * Start stateful configuration
+     * @param stateId string
+     * @param request Request
+     * @returns Flow initialization response, which contains session ID and result of selectors
+     */
+    startConfiguration(stateId: string, request: ConfigurationStateStartRequest): Observable<FlowStateExecutionResult>;
+    /**
+     * Execute stateful configuration
+     * @param stateId string
+     * @param configurationId string
+     * @param request Request
+     * @returns Flow initialization response, which contains session ID and result of selectors
+     */
+    executeConfiguration(stateId: string, configurationId: string, request: ConfigurationStateExecuteRequest): Observable<FlowStateExecutionResult>;
+    /**
+     * Save stateful configuration
+     * @param stateId string
+     * @param configurationId string
+     */
+    saveConfiguration(stateId: string, configurationId: string): Observable<{
+        quoteId: string;
+    }>;
+    /**
+     * Cancel stateful configuration
+     * @param stateId string
+     * @param configurationId string
+     */
+    cancelConfiguration(stateId: string, configurationId: string): Observable<void>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FlowStateApiService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<FlowStateApiService>;
+}

package/lib/services/flows-api.service.d.ts

@@ -6,7 +6,7 @@ export declare class FlowsApiService {
     private configurationSettingsApiService;
     private readonly flowsKey;
     constructor(configurationSettingsApiService: ConfigurationSettingsApiService);
-    getFlow(id: string): Observable<Flow | undefined>;
+    getFlow(id: string): Observable<Flow>;
     fetchFlows(): Observable<Flow[]>;
     static ɵfac: i0.ɵɵFactoryDeclaration<FlowsApiService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<FlowsApiService>;

package/lib/services/org-info-api.service.d.ts

@@ -1,13 +1,19 @@
-import { HttpClient } from '@angular/common/http';
+import { MessageService } from 'primeng/api';
 import { Observable } from 'rxjs';
-import { OrgInfo } from '../types/org-info.types';
+import { AvailableVersionsInfo, OrgInfo } from '../types/org-info.types';
 import * as i0 from "@angular/core";
 export declare class OrgInfoApiService {
-    private http;
-    private readonly CANVAS_URL_FALLBACK;
-    private readonly hostUrl;
-    constructor(http: HttpClient);
-    getOrgInfo$(organizationId: string): Observable<OrgInfo>;
+    private messageService;
+    constructor(messageService: MessageService);
+    getOrgInfo$(): Observable<OrgInfo | undefined>;
+    getAvailableVersionsInfo$(): Observable<AvailableVersionsInfo | undefined>;
+    upgradeVersion$(targetVersion: string): Observable<OrgInfo | undefined>;
+    /**
+     * Shows an error message using the message service.
+     *
+     * @param {string} message - the error message to be published.
+     */
+    private publishErrorMessage;
     static ɵfac: i0.ɵɵFactoryDeclaration<OrgInfoApiService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<OrgInfoApiService>;
 }

package/lib/services/procedures-api.service.d.ts

@@ -23,6 +23,7 @@ export declare class ProceduresApiService {
      * @returns
      */
     apply$(body: QuoteDraft): Observable<QuoteDraft>;
+    fetchDefaultPricingSteps$(): Observable<any>;
     static ɵfac: i0.ɵɵFactoryDeclaration<ProceduresApiService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<ProceduresApiService>;
 }

package/lib/services/quote-api.service.d.ts

@@ -1,18 +1,25 @@
 import { BaseHttpService, HttpRequestConfigurableOptions, QuoteDraft } from '@veloceapps/core';
 import { Dictionary } from 'lodash';
 import { Observable } from 'rxjs';
+import { SaveQuoteResponse, SubmitQuoteResponse } from '../types';
 import * as i0 from "@angular/core";
 export declare class QuoteApiService {
     private httpService;
     private readonly SERVICE_URL;
     constructor(httpService: BaseHttpService);
+    /**
+     * @deprecated Use getQuoteState instead
+     */
     getQuoteDraft(objectId: string, params?: Dictionary<string>, errorHandler?: (error: any) => void): Observable<QuoteDraft>;
-    upsertQuote(request: QuoteDraft, options?: HttpRequestConfigurableOptions): Observable<{
-        quoteId: string;
-    }>;
-    submitQuote(request: QuoteDraft, options?: HttpRequestConfigurableOptions): Observable<{
-        quoteId: string;
-    }>;
+    /**
+     * Comparing to deprecated `getQuoteDraft` this endpoint doesn't include orders and assets
+     * @param objectId quoteId | accountId | opportunityId | orderId
+     * @param params Query params
+     * @param options Request options
+     */
+    getQuoteState(objectId: string, params?: Dictionary<string>, options?: HttpRequestConfigurableOptions): Observable<QuoteDraft>;
+    upsertQuote(request: QuoteDraft, options?: HttpRequestConfigurableOptions): Observable<SaveQuoteResponse>;
+    submitQuote(request: QuoteDraft, options?: HttpRequestConfigurableOptions): Observable<SubmitQuoteResponse>;
     attachDocument(id: string, documentName: string, data: any): Observable<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<QuoteApiService, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<QuoteApiService>;

package/lib/services/sandbox-manager-api.service.d.ts

@@ -0,0 +1,24 @@
+import { NewSalesforceOrganization, SalesforceOrganization } from '@veloceapps/core';
+import { Dictionary } from 'lodash';
+import { MessageService } from 'primeng/api';
+import { Observable } from 'rxjs';
+import * as i0 from "@angular/core";
+export declare class SandboxManagerApiService {
+    private messageService;
+    constructor(messageService: MessageService);
+    getSalesforceOrganizations$(): Observable<SalesforceOrganization[]>;
+    getAvailableSalesforceOrganizationSizes$(): Observable<Dictionary<number>>;
+    createSalesforceOrganization$(payload: NewSalesforceOrganization): Observable<SalesforceOrganization | undefined>;
+    updateSalesforceOrganization$(payload: SalesforceOrganization): Observable<SalesforceOrganization | undefined>;
+    deleteSalesforceOrganization$(payload: SalesforceOrganization): Observable<SalesforceOrganization | undefined>;
+    activateSalesforceOrganization$(payload: SalesforceOrganization): Observable<SalesforceOrganization | undefined>;
+    deactivateSalesforceOrganization$(payload: SalesforceOrganization): Observable<SalesforceOrganization | undefined>;
+    /**
+     * Shows an error message using the message service.
+     *
+     * @param {string} message - the error message to be published.
+     */
+    private publishErrorMessage;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SandboxManagerApiService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SandboxManagerApiService>;
+}

package/lib/services/scripts-api.service.d.ts

@@ -10,7 +10,7 @@ export declare class ScriptsApiService {
     searchScripts$: (expression: Expression, skip?: number, count?: number) => Observable<Script[]>;
     fetchScript$: (id: string) => Observable<ScriptDetails>;
     createScript$: (script: NewScript) => Observable<Script>;
-    updateScriptMeta$: (script: Script) => Observable<Script>;
+    updateScriptMeta$: (script: Script) => Observable<ScriptDetails>;
     updateScriptDetails$: (script: ScriptDetails) => Observable<ScriptDetails>;
     cloneScript$: (cloneRequest: CloneRequest) => Observable<string>;
     removeScript$: (id: string) => Observable<string>;

package/lib/services/stateful-configuration-api.d.ts

@@ -1,4 +1,4 @@
-import { BaseHttpService, ConfigurationExecuteRequest, ConfigurationExecuteResponse, StatefulConfigurationState } from '@veloceapps/core';
+import { BaseHttpService, ConfigurationExecuteRequest, ConfigurationExecuteResponse, QuoteDraft } from '@veloceapps/core';
 import { Observable } from 'rxjs';
 import { StatefulConfigurationRequest } from '../types/stateful-configuration.types';
 import * as i0 from "@angular/core";
@@ -17,7 +17,7 @@ export declare class StatefulConfigurationApiService {
      * @param id ID
      * @returns Configuration State
      */
-    get(id: string): Observable<StatefulConfigurationState>;
+    get(id: string): Observable<QuoteDraft>;
     /**
      * Execute actions/selectors
      * @param id State ID

package/lib/services/ui-templates-api.service.d.ts

@@ -42,6 +42,7 @@ export declare class UITemplatesApiService {
     attachTemplateThumbnail$(templateId: string, file: File): Observable<any>;
     removeTemplateThumbnail$(templateId: string): Observable<any>;
     fetchComponentAttachments$: (templateId: string, component: TemplateComponent) => Observable<ComponentAttachments>;
+    fetchComponentsAttachments$: (templateId: string) => Observable<ComponentAttachments[]>;
     private fetchComponentAttachmentFile$;
     uploadComponentAttachments$: (templateId: string, componentId: string, attachments: ComponentAttachments) => Observable<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<UITemplatesApiService, never>;

package/lib/types/index.d.ts

@@ -2,5 +2,6 @@ export * from './auth.types';
 export * from './clone-request.types';
 export * from './delta-request.types';
 export * from './org-info.types';
+export * from './quote.types';
 export * from './ramp-request.types';
 export * from './search-request.types';

package/lib/types/org-info.types.d.ts

@@ -23,4 +23,23 @@ export interface OrgInfo {
     DefaultDataVersion: string;
     SelfRegistered: boolean;
     SelfRegisteredExpireAt: string;
+    Scratch: boolean;
+}
+export interface AvailableVersionsInfo {
+    orgId: string;
+    name: string;
+    envId: string;
+    client: string;
+    currentVersion: VersionInfo;
+    availableVersions: VersionInfo[];
+}
+export interface VersionInfo {
+    release: string;
+    integrationVersion?: string;
+    componentVersions: ComponentVersionInfo[];
+}
+export interface ComponentVersionInfo {
+    name: string;
+    displayName: string;
+    version: string;
 }

package/lib/types/quote.types.d.ts

@@ -0,0 +1,8 @@
+export interface SaveQuoteResponse {
+    quoteId: string;
+    configurationId?: string;
+}
+export interface SubmitQuoteResponse {
+    quoteId: string;
+    configurationId?: string;
+}

package/lib/utils/canvas.utils.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Parses the response from Canvas and checks for errors.
+ *  - If an error is found, publishes an error message and returns the failover value.
+ *  - If no error is found, returns the parsed response.
+ *
+ * Note! The API call first goes to APEX before reaching the Canvas, so errors can originate from either APEX or Canvas.
+ *
+ * @param {string} response - The JSON string response from the Canvas call.
+ * @param {T} failover - The value to return in case of error.
+ * @returns {T | K} The parsed response or the failover value.
+ *
+ * @template T The expected type of the parsed response.
+ * @template K The type of the failover value.
+ *
+ * @remarks If there's an Apex error, the response data can be an array.
+ * In such cases, the function extracts the first element of the array.
+ */
+export declare const handleCanvasResponse: <T, K>(response: string, failover: K, errorPublisher: (message: string) => void) => T | K;

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@veloceapps/api",
-  "version": "8.0.0-99",
+  "version": "9.0.0-1",
   "private": false,
   "peerDependencies": {
     "@angular/common": "~15.2.0",
     "@angular/core": "~15.2.0",
-    "@veloceapps/core": "^8.0.0-0",
+    "@veloceapps/core": "^9.0.0-0",
     "lodash": "^4.17.21",
     "moment": "^2.29.1",
     "rxjs": "~7.8.0"