@veloceapps/api 12.0.0-13 → 12.0.0-15

package/index.d.ts

@@ -1 +1,382 @@
-export * from './src';
+import * as i0 from '@angular/core';
+import * as i1 from '@angular/common/http';
+import { HttpClient } from '@angular/common/http';
+import * as i2 from '@veloceapps/api/v2';
+import { LineItem, BaseHttpService, HttpRequestConfigurableOptions, Account, AccountAssetsState, Order, Quote, ContractedPrice, NewContractedPrice, Expression, GuidedSelling, FlowStateInitRequest, FlowStateInitResponse, FlowState, FlowStateExecutionRequestDTO, FlowStateExecutionResult, ConfigurationStateNewRequest, ConfigurationStateStartRequest, ConfigurationStateExecuteRequest, NewOffer, Offer, OfferProduct, NewOfferProduct, NewPortal, Portal, PortalCustomization, Promotion, NewPromotion, RebateProgram, NewRebateProgram, RebateType, NewRebateType, SalesforceOrganization, NewSalesforceOrganization, QuoteDraft, ConfigurationExecuteRequest, ConfigurationExecuteResponse } from '@veloceapps/core';
+import { Observable } from 'rxjs';
+import { MessageService } from 'primeng/api';
+import { Dictionary } from 'lodash';
+
+declare class ApiModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<ApiModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<ApiModule, never, [typeof i1.HttpClientModule, typeof i2.ApiV2Module], never>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<ApiModule>;
+}
+
+interface VeloceAuthResponse {
+    token: string;
+    serverUrl: string;
+}
+
+interface CloneRequest {
+    id: string;
+    propertiesToOverride: Dictionary<any>;
+}
+
+interface CalculateDeltaRequest {
+    initialState: LineItem[];
+    currentState: LineItem[];
+}
+
+interface OrgInfo {
+    Name: string;
+    EnvID: string;
+    Client: string;
+    Prefix: string;
+    Deleted: boolean;
+    OrgID: string;
+    BackendURL: string;
+    FrontendURL: string;
+    StudioURL: string;
+    IntegrationURL: string;
+    ShoppingCartURL: string;
+    CatalogURL: string;
+    DefaultDataURL: string;
+    BackendVersion: string;
+    FrontendVersion: string;
+    StudioVersion: string;
+    IntegrationVersion: string;
+    ShoppingCartVersion: string;
+    CatalogVersion: string;
+    DefaultDataVersion: string;
+    SelfRegistered: boolean;
+    SelfRegisteredExpireAt: string;
+    Scratch: boolean;
+}
+interface AvailableVersionsInfo {
+    orgId: string;
+    name: string;
+    envId: string;
+    client: string;
+    currentVersion: VersionInfo;
+    availableVersions: VersionInfo[];
+}
+interface VersionInfo {
+    release: string;
+    integrationVersion?: string;
+    componentVersions: ComponentVersionInfo[];
+}
+interface ComponentVersionInfo {
+    name: string;
+    displayName: string;
+    version: string;
+}
+
+type QuerySearchParams = {
+    skip?: number;
+    count?: number;
+    sort?: string;
+    asc?: boolean;
+} & {
+    [param: string]: string | number | boolean | ReadonlyArray<string | number | boolean>;
+};
+
+declare class AccountApiService {
+    private httpService;
+    private readonly SERVICE_URL;
+    constructor(httpService: BaseHttpService);
+    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[]>;
+    getAsset(accountId: string, assetId: string, options?: HttpRequestConfigurableOptions): Observable<LineItem>;
+    getOrder(accountId: string, orderId: string, options?: HttpRequestConfigurableOptions): Observable<LineItem[]>;
+    getQuote(accountId: string, quoteId: string, options?: HttpRequestConfigurableOptions): Observable<LineItem[]>;
+    quoteToOrder(accountId: string, quoteId: string, options?: HttpRequestConfigurableOptions): Observable<any>;
+    orderToAsset(accountId: string, orderId: string, options?: HttpRequestConfigurableOptions): Observable<any>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AccountApiService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AccountApiService>;
+}
+
+declare class VeloceAuthService {
+    private http;
+    constructor(http: HttpClient);
+    auth$(instanceUrl: string, accessToken: string): Observable<VeloceAuthResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<VeloceAuthService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<VeloceAuthService>;
+}
+
+declare class ContractedPriceApiService {
+    private baseHttpService;
+    private readonly serviceUrl;
+    constructor(baseHttpService: BaseHttpService);
+    fetchContractedPrices$: () => Observable<ContractedPrice[]>;
+    fetchContractedPrice$: (id: string) => Observable<ContractedPrice>;
+    createContractedPrice$: (data: NewContractedPrice) => Observable<ContractedPrice>;
+    updateContractedPrice$: (data: ContractedPrice) => Observable<ContractedPrice>;
+    searchContractedPrices$: (searchParams?: QuerySearchParams, expression?: Expression) => Observable<GuidedSelling[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ContractedPriceApiService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ContractedPriceApiService>;
+}
+
+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>;
+}
+
+declare class OffersApiService {
+    private baseHttpService;
+    static MAX_RESULTS: number;
+    private readonly serviceUrl;
+    constructor(baseHttpService: BaseHttpService);
+    createOffer$(body: NewOffer): Observable<Offer>;
+    fetchOffers$(): Observable<Offer[]>;
+    fetchOffer$(id: string): Observable<Offer>;
+    updateOffer$(offer: Offer): Observable<Offer>;
+    removeOffer$(id: string): Observable<void>;
+    searchOffers$(expression: Expression, skip: number, count: number): Observable<Offer[]>;
+    fetchOfferProducts$(id: string): Observable<OfferProduct[]>;
+    upsertOfferProducts$(id: string, products: (OfferProduct | NewOfferProduct)[]): Observable<OfferProduct[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<OffersApiService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<OffersApiService>;
+}
+
+declare class OrgInfoApiService {
+    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>;
+}
+
+declare class PortalsApiService {
+    private baseHttpService;
+    static MAX_RESULTS: number;
+    private readonly serviceUrl;
+    constructor(baseHttpService: BaseHttpService);
+    createNewPortal$(body: NewPortal): Observable<Portal>;
+    updatePortal$(portal: Portal, settings: PortalCustomization): Observable<Portal>;
+    getPortals$: (skip?: number, name?: string) => Observable<Portal[]>;
+    searchPortals$: (skip?: number, expression?: Expression) => Observable<Portal[]>;
+    removePortal$: (id: string) => Observable<string>;
+    restore$: (id: string) => Observable<void>;
+    duplicatePortal$: (cloneRequest: CloneRequest) => Observable<string>;
+    getPortal$: (id: string) => Observable<Portal>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PortalsApiService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PortalsApiService>;
+}
+
+declare class PromotionsApiService {
+    private baseHttpService;
+    private readonly serviceUrl;
+    constructor(baseHttpService: BaseHttpService);
+    fetchAll$: () => Observable<Promotion>;
+    search$(expression: Expression, skip?: number, count?: number): Observable<Promotion[]>;
+    fetchOne$: (id: string) => Observable<Promotion>;
+    create$(body: NewPromotion): Observable<Promotion>;
+    update$(body: Promotion): Observable<Promotion>;
+    remove$: (id: string) => Observable<string>;
+    restore$: (id: string) => Observable<void>;
+    duplicate$: (body: CloneRequest) => Observable<string>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PromotionsApiService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PromotionsApiService>;
+}
+
+declare class RebateProgramApiService {
+    private baseHttpService;
+    private readonly serviceUrl;
+    constructor(baseHttpService: BaseHttpService);
+    fetchAll$: () => Observable<RebateProgram[]>;
+    search$(expression: Expression, skip?: number, count?: number): Observable<RebateProgram[]>;
+    fetchOne$: (id: string) => Observable<RebateProgram>;
+    create$(body: NewRebateProgram): Observable<RebateProgram>;
+    update$(body: RebateProgram): Observable<RebateProgram>;
+    remove$: (id: string) => Observable<string>;
+    restore$: (id: string) => Observable<void>;
+    duplicate$: (body: CloneRequest) => Observable<string>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RebateProgramApiService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<RebateProgramApiService>;
+}
+
+declare class RebateTypeApiService {
+    private baseHttpService;
+    private readonly serviceUrl;
+    constructor(baseHttpService: BaseHttpService);
+    fetchAll$: () => Observable<RebateType>;
+    search$(expression: Expression, skip?: number, count?: number): Observable<RebateType[]>;
+    fetchOne$: (id: string) => Observable<RebateType>;
+    create$(body: NewRebateType): Observable<RebateType>;
+    update$(body: RebateType): Observable<RebateType>;
+    remove$: (id: string) => Observable<string>;
+    restore$: (id: string) => Observable<void>;
+    duplicate$: (body: CloneRequest) => Observable<string>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<RebateTypeApiService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<RebateTypeApiService>;
+}
+
+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>;
+}
+
+interface ConfigurationProcessorOverride {
+    name: string;
+    script: string;
+}
+interface StatefulConfigurationRequest {
+    item: unknown;
+    actions?: ConfigurationProcessorOverride[];
+    selectors?: ConfigurationProcessorOverride[];
+}
+
+declare class StatefulConfigurationApiService {
+    private httpService;
+    private readonly SERVICE_URL;
+    constructor(httpService: BaseHttpService);
+    /**
+     * Initialize configuration state
+     * @param request Request
+     * @returns ID of new configuration state
+     */
+    init(request: StatefulConfigurationRequest): Observable<string>;
+    /**
+     * Get existing state by ID
+     * @param id ID
+     * @returns Configuration State
+     */
+    get(id: string): Observable<QuoteDraft>;
+    /**
+     * Execute actions/selectors
+     * @param id State ID
+     * @param request Request
+     * @returns Execute result
+     */
+    execute(id: string, request: ConfigurationExecuteRequest): Observable<ConfigurationExecuteResponse>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<StatefulConfigurationApiService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<StatefulConfigurationApiService>;
+}
+
+/**
+ * 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.
+ */
+declare const handleCanvasResponse: <T, K>(response: string, failover: K, errorPublisher: (message: string) => void) => T | K;
+
+export { AccountApiService, ApiModule, ContractedPriceApiService, FlowStateApiService, OffersApiService, OrgInfoApiService, PortalsApiService, PromotionsApiService, RebateProgramApiService, RebateTypeApiService, SandboxManagerApiService, StatefulConfigurationApiService, VeloceAuthService, handleCanvasResponse };
+export type { AvailableVersionsInfo, CalculateDeltaRequest, CloneRequest, ComponentVersionInfo, OrgInfo, QuerySearchParams, VeloceAuthResponse, VersionInfo };

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@veloceapps/api",
-  "version": "12.0.0-13",
+  "version": "12.0.0-15",
   "private": false,
   "peerDependencies": {
-    "@angular/common": "~15.2.0",
-    "@angular/core": "~15.2.0",
-    "@veloceapps/core": "^11.0.0-0",
+    "@angular/common": "~20.1.4",
+    "@angular/core": "~20.1.4",
+    "@veloceapps/core": "12.0.0-0",
     "lodash": "^4.17.21",
     "moment": "^2.29.1",
     "rxjs": "~7.8.0"
@@ -17,11 +17,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "module": "fesm2015/veloceapps-api.mjs",
-  "es2020": "fesm2020/veloceapps-api.mjs",
-  "esm2020": "esm2020/veloceapps-api.mjs",
-  "fesm2020": "fesm2020/veloceapps-api.mjs",
-  "fesm2015": "fesm2015/veloceapps-api.mjs",
+  "module": "fesm2022/veloceapps-api.mjs",
   "typings": "index.d.ts",
   "exports": {
     "./package.json": {
@@ -29,19 +25,11 @@
     },
     ".": {
       "types": "./index.d.ts",
-      "esm2020": "./esm2020/veloceapps-api.mjs",
-      "es2020": "./fesm2020/veloceapps-api.mjs",
-      "es2015": "./fesm2015/veloceapps-api.mjs",
-      "node": "./fesm2015/veloceapps-api.mjs",
-      "default": "./fesm2020/veloceapps-api.mjs"
+      "default": "./fesm2022/veloceapps-api.mjs"
     },
     "./v2": {
       "types": "./v2/index.d.ts",
-      "esm2020": "./esm2020/v2/veloceapps-api-v2.mjs",
-      "es2020": "./fesm2020/veloceapps-api-v2.mjs",
-      "es2015": "./fesm2015/veloceapps-api-v2.mjs",
-      "node": "./fesm2015/veloceapps-api-v2.mjs",
-      "default": "./fesm2020/veloceapps-api-v2.mjs"
+      "default": "./fesm2022/veloceapps-api-v2.mjs"
     }
   }
 }