@limetech/limepkg-cpq-order 2.8.0-dev.1

package/dist/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from './components';
+export * from './interfaces/article-selector';

package/dist/types/interface.d.ts

@@ -0,0 +1,6 @@
+// Components interfaces
+export * from './components';
+
+// If you need to export interfaces externally,
+// add them like the example below:
+// export * from './components/my-component/my-interface';

package/dist/types/interfaces/article-selector.d.ts

@@ -0,0 +1,23 @@
+import { EventEmitter } from '../stencil-public-runtime';
+import { Iitem as CpqItem } from './objects';
+import type { Deal as CpqDeal, Order as CpqOrder } from '../classes';
+import { LimeProperty } from '@limetech/lime-web-components';
+export { CpqItem, CpqDeal, CpqOrder };
+export { IarticleGroup as CpqArticleGroup, Iarticle as CpqArticle, } from './objects';
+export declare type ArticleSelectorComponent<Item extends CpqItem = CpqItem> = {
+  /**
+   * The article group relation for the item
+   */
+  articleGroupProperty?: LimeProperty;
+  /**
+   * The article relation for the item
+   */
+  articleProperty?: LimeProperty;
+  /**
+   * The edited deal article or order row item
+   */
+  item: Item;
+  itemParent?: CpqDeal | CpqOrder;
+  additionalProperties?: Array<keyof Item['additionalProperties']>;
+  itemChange?: EventEmitter<Item>;
+};

package/dist/types/interfaces/config.d.ts

@@ -0,0 +1,106 @@
+export interface IconfigArticleMapping {
+  limetype: string;
+  propertyDescription: string;
+  propertyArticleno: string;
+  propertyArticlegroup: string;
+  propertyPricePerUnit: string;
+  propertyCostPrice: string;
+  propertyGrossMarginRatio: string;
+  propertyUnit: string;
+  propertyVat: string;
+  propertyActive: string;
+}
+export interface IconfigArticlegroupMapping {
+  limetype: string;
+  propertyName: string;
+  propertyActive: string;
+}
+export interface IconfigArticle {
+  requireArticle: boolean;
+  articleMapping: IconfigArticleMapping;
+  articlegroupMapping: IconfigArticlegroupMapping;
+}
+export interface IconfigCustomization {
+  articleSelectorComponent?: {
+    name: string;
+    props?: Record<string, unknown>;
+  };
+  additionalItemProperties?: string[];
+}
+export interface IconfigItemMapping {
+  limetype: string;
+  parentRelation: string;
+  propertyArticle: string;
+  propertyArticlegroup: string;
+  propertyArticleno: string;
+  propertyDescription: string;
+  propertyVat: string;
+  propertyQuantity: string;
+  propertyUnit: string;
+  propertyPricePerUnit: string;
+  propertyDiscountPerUnit: string;
+  propertyDiscountPercent: string;
+  propertyDiscountClass: string;
+  propertyCostPrice: string;
+  propertyGrossMarginRatio: string;
+  propertySubtotal: string;
+  propertyDiscount: string;
+  propertyTotalvalue: string;
+  propertyPosition: string;
+}
+export interface IconfigBaseMapping {
+  limetype: string;
+  dynamicProperties: string[];
+  propertyCurrency: string;
+  propertySubtotal: string;
+  propertyDiscount: string;
+}
+export interface IconfigDealMapping extends IconfigBaseMapping {
+  propertyName: string;
+  propertyValue: string;
+  propertyOrder: string;
+  propertyVat: string;
+}
+export interface IconfigDealarticleMapping extends IconfigItemMapping {
+}
+export interface IconfigDocumentMapping {
+  limetype: string;
+  propertyDocument: string;
+  propertyComment: string;
+  propertyType: string;
+  optionTypeQuote: string;
+  propertyDeal: string;
+}
+export interface IconfigCpq {
+  dealMapping: IconfigDealMapping;
+  dealarticleMapping: IconfigDealarticleMapping;
+  documentMapping: IconfigDocumentMapping;
+}
+export interface IconfigOrderMapping extends IconfigBaseMapping {
+  propertyOrderstatus: string;
+  propertyCustomerid: string;
+  propertyCustomerReference: string;
+  propertyCurrency: string;
+  propertyOrderSum: string;
+  propertyOrderVat: string;
+  propertyOrderTotalSum: string;
+  propertyCompany: string;
+  propertyDeal: string;
+}
+export interface IconfigOrderrowMapping extends IconfigItemMapping {
+}
+export interface IconfigOrderFromDealMapping {
+  source: string;
+  target: string;
+}
+export interface IconfigOrder {
+  orderMapping: IconfigOrderMapping;
+  orderrowMapping: IconfigOrderrowMapping;
+  orderFromDealMapping: IconfigOrderFromDealMapping[];
+}
+export interface Iconfig {
+  article: IconfigArticle;
+  customization?: IconfigCustomization;
+  cpq?: IconfigCpq;
+  order?: IconfigOrder;
+}

package/dist/types/interfaces/index.d.ts

@@ -0,0 +1,3 @@
+export * from './article-selector';
+export * from './config';
+export * from './objects';

package/dist/types/interfaces/objects.d.ts

@@ -0,0 +1,73 @@
+import { IconfigBaseMapping } from './config';
+export interface Iitem<T extends {} = Record<string, any>> {
+  id: number;
+  articleGroup?: IarticleGroup;
+  article?: Iarticle;
+  articleno?: string;
+  description: string;
+  position: number;
+  vat: number;
+  unit: string;
+  pricePerUnit: number;
+  discountPerUnit: number;
+  discountPercent: number;
+  discountClass: DiscountClasses;
+  costPrice: number;
+  grossMarginRatio: number;
+  quantity: number;
+  subtotal: number;
+  discount: number;
+  total: number;
+  guid?: string;
+  deleted: boolean;
+  additionalProperties?: T;
+}
+export interface Iarticle {
+  id: number;
+  description: string;
+  articleGroup?: IarticleGroup;
+  articleno: string;
+  price: number;
+  costPrice: number;
+  grossMarginRatio: number;
+  unit: string;
+  vat: number;
+}
+export interface IarticleGroup {
+  id: number;
+  name: string;
+}
+export interface Base {
+  id: number;
+  limetype: string;
+  currency: string;
+  items: Iitem[];
+  mapping: IconfigBaseMapping;
+  subtotal: number;
+  discount: number;
+  total: number;
+  vat: number;
+  totalInclVat: number;
+}
+export interface Ideal extends Base {
+  name: string;
+}
+export interface Iorder extends Base {
+  deal: number;
+  orderstatus: ErpStatus;
+}
+export interface Icolumn {
+  title: string;
+  field: string;
+  headerSort: boolean;
+  horizontalAlign?: 'left' | 'center' | 'right';
+  formatter?: any;
+}
+export declare enum ErpStatus {
+  notready = "notready",
+  readytobesent = "readytobesent",
+  inprocess = "inprocess",
+  senttoerp = "senttoerp",
+  error = "error"
+}
+export declare type DiscountClasses = 'amount' | 'percent';

package/dist/types/services/article.d.ts

@@ -0,0 +1,7 @@
+import { Iarticle, IarticleGroup, Iconfig, IconfigArticle, IconfigArticlegroupMapping } from '../interfaces';
+import { LimeWebComponentPlatform } from '@limetech/lime-web-components';
+export declare function getArticleConfig(platform: LimeWebComponentPlatform, config?: Iconfig): IconfigArticle;
+export declare function getArticleGroups(platform: LimeWebComponentPlatform, articlegroupMapping?: IconfigArticlegroupMapping): Promise<IarticleGroup[]>;
+export declare function getArticles(platform: LimeWebComponentPlatform, articleConfig: IconfigArticle, articleGroup?: IarticleGroup, searchText?: string): Promise<Iarticle[]>;
+export declare function articleResponseFormat(articleConfig: IconfigArticle): any;
+export declare function mapArticleResult(result: Record<string, any>, articleConfig: IconfigArticle): Iarticle;

package/dist/types/services/deal.d.ts

@@ -0,0 +1,5 @@
+import { LimeWebComponentPlatform } from '@limetech/lime-web-components';
+import { Deal } from '../classes';
+import { Iconfig } from '../interfaces';
+export declare function loadDeal(platform: LimeWebComponentPlatform, config: Iconfig, id: number): Promise<Deal>;
+export declare function saveDeal(deal: Deal, platform: LimeWebComponentPlatform): Promise<number>;

package/dist/types/services/documenttemplate.service.interface.d.ts

@@ -0,0 +1,142 @@
+import { FileInfo } from '@limetech/lime-elements';
+export interface Template {
+  id: number;
+  extension?: string;
+  last_modified?: string;
+  mimetype?: string;
+  filename?: string;
+  size?: number;
+  storage_type?: string;
+  metadata?: {
+    [key: string]: any;
+  };
+  filetype: TemplateFileType;
+}
+export declare enum TemplateFileType {
+  DOCUMENT_TEMPLATE = 113,
+  DOCUMENT_TEMPLATE_2 = 115
+}
+/**
+ * The registered name of the document template service.
+ */
+export declare const DocumentTemplateServiceName = "limepkg-document-templates.documenttemplateservice";
+/**
+ * Array of supported document template extensions. Currently allowed ones are: .docx, .pdf, .xlsx
+ */
+export declare const SupportedDocumentTemplateExtensions: readonly ["docx", "pdf", "xlsx"];
+/**
+ * The supported document template extension.
+ */
+export declare type SupportedDocumentTemplateExtension = (typeof SupportedDocumentTemplateExtensions)[number];
+/**
+ * The available options used when getting templates.
+ */
+export declare type GetOptions = {
+  /**
+   * Only return templates compatible with this lime type.
+   */
+  limetype?: string;
+  /**
+   * Only return templates matching this extension.
+   */
+  extension?: SupportedDocumentTemplateExtension[];
+};
+/**
+ * Defines the document template service.
+ */
+export interface DocumentTemplateService {
+  /**
+   * Returns a list of available templates based
+   * on the provided options.
+   *
+   * @param {GetOptions} options The options for the request
+   * @returns {Promise<DocumentTemplate[]>} The document templates.
+   */
+  getTemplates(options?: GetOptions): Promise<DocumentTemplate[]>;
+  /**
+   * Returns a file info representation of a document template.
+   *
+   * @param {DocumentTemplate} template The document template
+   * @returns {FileInfo} The file info representation
+   */
+  templateToFileInfo(template: DocumentTemplate): FileInfo;
+  /**
+   * Returns a document template representation of a file info.
+   *
+   * @param {FileInfo} file The file info
+   * @returns {DocumentTemplate} The document template representation
+   */
+  fileInfoToTemplate(file: FileInfo): DocumentTemplate;
+}
+export interface Locale {
+  /**
+   * The locale code.
+   * For example "en_US".
+   */
+  code?: string;
+  /**
+   * The locale display name.
+   */
+  displayName?: string;
+}
+/**
+ * The available document template types.
+ */
+export declare type DocumentTemplateType = 'document_template' | 'legacy_template' | 'field_file';
+export interface DocumentTemplate {
+  /**
+   * The id of the document template.
+   *
+   * When this value is a string it has a custom template id which will
+   * stay persisted even if the document template file changes.
+   * When this value is a number it is the same as {@link DocumentTemplate#id}.
+   */
+  templateId: string | number;
+  /**
+   * The id of the document template's file.
+   *
+   * IMPORTANT!
+   * This id is volatile since it is the id of the document template
+   * file and thus will change when the template document file changes.
+   */
+  fileId: number;
+  /**
+   * The name of the document template file.
+   */
+  fileName: string;
+  /**
+   * The extension of the document template file.
+   */
+  extension: string;
+  /**
+   * Additional tags for this document template.
+   */
+  tags?: string[];
+  /**
+   * An optional category for this document template.
+   *
+   * NOTE! Only used with legacy templates.
+   */
+  category?: string;
+  /**
+   * Defines the default locale for this document template.
+   */
+  locale?: Locale;
+  /**
+   * The type of this document template.
+   */
+  type?: DocumentTemplateType;
+}
+export interface TemplatePickerComponent {
+  /**
+   * The name of the web component.
+   */
+  name: string;
+  /**
+   * The optional web component properties.
+   */
+  props?: object;
+}
+export interface LoadTemplateOptions {
+  limetype?: string;
+}

package/dist/types/services/index.d.ts

@@ -0,0 +1,8 @@
+export * from './article';
+export * from './deal';
+export * from './item';
+export * from './limetype';
+export * from './order';
+export * from './template';
+export * from './translate';
+export * from './notification';

package/dist/types/services/item.d.ts

@@ -0,0 +1,6 @@
+import { LimeWebComponentPlatform } from '@limetech/lime-web-components';
+import { ServerCommand } from './servercommand.service.interface';
+import { Item } from '../classes';
+import { Iconfig, IconfigItemMapping } from '../interfaces';
+export declare function getItems(platform: LimeWebComponentPlatform, itemMapping: IconfigItemMapping, config: Iconfig, id: number): Promise<Item[]>;
+export declare function mapItemsCommands(items: Item[], itemMapping: IconfigItemMapping, ref: string, commands: ServerCommand[]): void;

package/dist/types/services/limetype.d.ts

@@ -0,0 +1,4 @@
+import { LimeType, LimeWebComponentPlatform } from '@limetech/lime-web-components';
+export declare function getLimeColor(color: string): string;
+export declare function getTranslatedName(limetype: LimeType): string;
+export declare function loadLimeobject(platform: LimeWebComponentPlatform, limetype: string, id: number): Promise<any>;

package/dist/types/services/notification.d.ts

@@ -0,0 +1,3 @@
+import { Notifications } from '@limetech/lime-web-components';
+export declare function notifyUser(notificationService: Notifications, message: string): Promise<boolean>;
+export declare function alertUser(notificationService: Notifications, title: string, message: string): Promise<void>;

package/dist/types/services/order.d.ts

@@ -0,0 +1,6 @@
+import { LimeWebComponentPlatform, LimeProperty } from '@limetech/lime-web-components';
+import { Order } from '../classes';
+import { Iconfig } from '../interfaces';
+export declare function loadOrder(platform: LimeWebComponentPlatform, config: Iconfig, id: number): Promise<Order>;
+export declare function saveOrder(order: Order, platform: LimeWebComponentPlatform): Promise<number>;
+export declare function orderFromDeal(platform: LimeWebComponentPlatform, config: Iconfig, dealId: number, order?: Order, orderrowProperties?: Record<string, LimeProperty>): Promise<Order>;

package/dist/types/services/servercommand.service.interface.d.ts

@@ -0,0 +1,36 @@
+export declare const ServerCommandServiceName = "limepkg-server-commands.service";
+export interface ServerCommandService {
+  /**
+   * Posts the commands to the command endpoint.
+   *
+   * @param {ServerCommand[]} payload The commands.
+   * @returns {Promise<ServerCommandBatchResponse>} The response.
+   */
+  postCommands(payload: ServerCommand[]): Promise<ServerCommandBatchResponse>;
+}
+export interface ServerCommand {
+  name: string;
+  parameters: object;
+}
+export interface ServerCommandResponse {
+  successful: boolean;
+  command: object;
+  data: any;
+  error: ServerCommandError;
+}
+export interface ServerCommandError {
+  code: string;
+  message: string;
+}
+export interface ServerCommandBatch {
+  commands: ServerCommand[];
+}
+export interface ServerCommandBatchResponse {
+  successful: boolean;
+  id: string;
+  commands: ServerCommandResponse[];
+}
+export declare enum ServerCommandName {
+  upsert = "upsert-limeobject",
+  delete = "delete-limeobject"
+}

package/dist/types/services/template.d.ts

@@ -0,0 +1,4 @@
+import { CreateLimeobjectDialogCommand, LimeWebComponentPlatform } from '@limetech/lime-web-components';
+import { DocumentTemplate } from './documenttemplate.service.interface';
+export declare function loadAllTemplates(platform: LimeWebComponentPlatform, limetype: string): Promise<DocumentTemplate[]>;
+export declare function openGenerateQuotationDialog(platform: LimeWebComponentPlatform, command: CreateLimeobjectDialogCommand): void;

package/dist/types/services/translate.d.ts

@@ -0,0 +1,2 @@
+import { Translator } from '@limetech/lime-web-components';
+export declare function getTranslation(translateService: Translator, tag: string, params?: {}): string;