@progressive-development/pd-order 0.7.11 → 1.0.0

package/LICENSE

@@ -1,2 +1,21 @@
-No License, all rights reserved
-@2021 - PD Progressive Development UG
+MIT License
+
+Copyright (c) 2021-present PD Progressive Development UG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,76 +1,50 @@
-# \<pd-order>
+# @progressive-development/pd-order
 
-This webcomponent follows the [open-wc](https://github.com/open-wc/open-wc) recommendation.
+[![npm version](https://img.shields.io/npm/v/@progressive-development/pd-order.svg)](https://www.npmjs.com/package/@progressive-development/pd-order)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+
+Order flow components for multi-address management and order summaries.
+
+## Features
+
+- **Lit 3 & TypeScript** – Modern, type-safe web components
+- **Accessible** – WCAG 2.1 compliant, keyboard navigation, ARIA support
+- **Themeable** – CSS Custom Properties for easy customization
+- **Localized** – Built-in i18n support (EN, DE, BE)
+- **Lightweight** – No heavy dependencies, tree-shakeable
+- **Framework-agnostic** – Works with React, Vue, Angular, or vanilla JS
+- **Multi-Address Management** – Handle customer, billing, property, and manager addresses with smart fallbacks
+- **Property Owner Scenarios** – Specialized fields for landlord workflows with conditional address sections
+- **Dual Display Modes** – Switch between full edit form and compact summary view
+- **Order Summary with Terms** – Price table integration, tax display, and legal consent checkbox with modal
 
 ## Installation
 
 ```bash
-npm i pd-order
+npm install @progressive-development/pd-order
 ```
 
-## Usage
+## Quick Start
 
 ```html
 <script type="module">
-  import 'pd-order/pd-order.js';
+  import '@progressive-development/pd-order';
 </script>
 
-<pd-order></pd-order>
+<pd-order-contacts></pd-order-contacts>
 ```
 
-## Linting and formatting
+## Components
 
-To scan the project for linting and formatting errors, run
+| Component | Description |
+|-----------|-------------|
+| `<pd-order-contacts>` | Multi-address contact management |
+| `<pd-order-summary>` | Order overview with pricing and terms |
 
-```bash
-npm run lint
-```
-
-To automatically fix linting and formatting errors, run
-
-```bash
-npm run format
-```
+## Documentation
 
-## Testing with Web Test Runner
-
-To execute a single test run:
-
-```bash
-npm run test
-```
-
-To run the tests in interactive watch mode run:
-
-```bash
-npm run test:watch
-```
+📖 **Full documentation:** [pd-components.web.app](https://pd-components.web.app/)
 
-## Demoing with Storybook
-
-To run a local instance of Storybook for your component, run
-
-```bash
-npm run storybook
-```
-
-To build a production version of Storybook, run
-
-```bash
-npm run storybook:build
-```
-
-
-## Tooling configs
-
-For most of the tools, the configuration is in the `package.json` to minimize the amount of files in your project.
-
-If you customize the configuration a lot, you can consider moving them to individual files.
-
-## Local Demo with `web-dev-server`
-
-```bash
-npm start
-```
+## License
 
-To run a local development server that serves the basic demo located in `demo/index.html`
+MIT © [PD Progressive Development UG](https://progressive-development.com)

package/dist/generated/locales/be.d.ts

@@ -2,7 +2,8 @@ export declare const templates: {
     "pd.order.contacts.billingContact.inputHeader": string;
     "pd.order.contacts.orderContact.inputHeader": string;
     "pd.order.contacts.propertyContact.checkBox": string;
-    "pd.order.summary.agree.link": import('lit-html').TemplateResult<1>;
+    "pd.order.summary.agree.link1": string;
+    "pd.order.summary.agree.link2": string;
     "pd.order.summary.agree.required": string;
     "pd.order.summary.billing": string;
     "pd.order.summary.title": string;

package/dist/generated/locales/be.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"be.d.ts","sourceRoot":"","sources":["../../../src/generated/locales/be.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;CAqBrB,CAAC"}
+{"version":3,"file":"be.d.ts","sourceRoot":"","sources":["../../../src/generated/locales/be.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;CAqBrB,CAAC"}

package/dist/generated/locales/de.d.ts

@@ -17,6 +17,7 @@ export declare const templates: {
     "pd.order.summary.title": string;
     "pd.order.summary.billing": string;
     "pd.order.summary.agree.required": string;
-    "pd.order.summary.agree.link": import('lit-html').TemplateResult<1>;
+    "pd.order.summary.agree.link1": string;
+    "pd.order.summary.agree.link2": string;
 };
 //# sourceMappingURL=de.d.ts.map

package/dist/generated/locales/de.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"de.d.ts","sourceRoot":"","sources":["../../../src/generated/locales/de.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;CAsBrB,CAAC"}
+{"version":3,"file":"de.d.ts","sourceRoot":"","sources":["../../../src/generated/locales/de.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;CAqBrB,CAAC"}

package/dist/generated/locales/en.d.ts

@@ -2,7 +2,8 @@ export declare const templates: {
     "pd.order.contacts.billingContact.inputHeader": string;
     "pd.order.contacts.orderContact.inputHeader": string;
     "pd.order.contacts.propertyContact.checkBox": string;
-    "pd.order.summary.agree.link": import('lit-html').TemplateResult<1>;
+    "pd.order.summary.agree.link1": string;
+    "pd.order.summary.agree.link2": string;
     "pd.order.summary.agree.required": string;
     "pd.order.summary.billing": string;
     "pd.order.summary.title": string;

package/dist/generated/locales/en.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"en.d.ts","sourceRoot":"","sources":["../../../src/generated/locales/en.ts"],"names":[],"mappings":"AAQA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;CAqBrB,CAAC"}
+{"version":3,"file":"en.d.ts","sourceRoot":"","sources":["../../../src/generated/locales/en.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,SAAS;;;;;;;;;;;;;;;;;;;;;CAqBrB,CAAC"}

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { PdOrderContacts } from './pd-order-contacts.js';
-export { PdOrderSummary } from './pd-order-summary.js';
+export { PdOrderContacts } from './pd-order-contacts/pd-order-contacts.js';
+export { PdOrderSummary } from './pd-order-summary/pd-order-summary.js';
 export type { PdOrderContactData, PdOrderStep } from './types.js';
 export { templates as beTemplates } from './generated/locales/be.js';
 export { templates as deTemplates } from './generated/locales/de.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAElE,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,2BAA2B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,0CAA0C,CAAC;AAC3E,OAAO,EAAE,cAAc,EAAE,MAAM,wCAAwC,CAAC;AAExE,YAAY,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAElE,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACrE,OAAO,EAAE,SAAS,IAAI,WAAW,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/index.js

@@ -1,12 +1,7 @@
-import { PdOrderContacts } from "./pd-order-contacts.js";
-import { PdOrderSummary } from "./pd-order-summary.js";
-import { templates } from "./locales/be.js";
-import { templates as templates2 } from "./locales/de.js";
-import { templates as templates3 } from "./locales/en.js";
-export {
-  PdOrderContacts,
-  PdOrderSummary,
-  templates as beTemplates,
-  templates2 as deTemplates,
-  templates3 as enTemplates
-};
+import './pd-order-contacts.js';
+import './pd-order-summary.js';
+export { templates as beTemplates } from './locales/be.js';
+export { templates as deTemplates } from './locales/de.js';
+export { templates as enTemplates } from './locales/en.js';
+export { PdOrderContacts } from './pd-order-contacts/PdOrderContacts.js';
+export { PdOrderSummary } from './pd-order-summary/PdOrderSummary.js';

package/dist/locales/be.js

@@ -1,10 +1,9 @@
-import { html } from "lit";
 const templates = {
   "pd.order.contacts.billingContact.inputHeader": `Facturatieadres`,
   "pd.order.contacts.orderContact.inputHeader": `Adres`,
   "pd.order.contacts.propertyContact.checkBox": `Is de klant een verhuurder?`,
-  "pd.order.summary.agree.link": html`Ga akkoord met onze
-    <a @click="${0}" @keypress="${1}">algemene voorwaarden</a>.`,
+  "pd.order.summary.agree.link1": `Ik aanvaard de`,
+  "pd.order.summary.agree.link2": `Algemene voorwaarden`,
   "pd.order.summary.agree.required": `Ga akkoord met de algemene voorwaarden om verder te gaan.`,
   "pd.order.summary.billing": `Factuur`,
   "pd.order.summary.title": `Overzicht`,
@@ -21,6 +20,5 @@ const templates = {
   se1b4ea2cbb1f9bb4: `Immobilie`,
   s3be4da85df39b1c2: `Verwaltung`
 };
-export {
-  templates
-};
+
+export { templates };

package/dist/locales/de.js

@@ -1,4 +1,3 @@
-import { html } from "lit";
 const templates = {
   "pd.order.contacts.orderContact.inputHeader": `Adresse`,
   "pd.order.contacts.billingContact.inputHeader": `Rechnungsadresse (optional)`,
@@ -18,10 +17,8 @@ const templates = {
   "pd.order.summary.title": `Übersicht`,
   "pd.order.summary.billing": `Rechnung`,
   "pd.order.summary.agree.required": `Bitte stimmen Sie den Allgemeinen Geschäftsbedingungen zu, um fortzufahren.`,
-  "pd.order.summary.agree.link": html`Stimmen Sie unseren
-    <a @click="${0}" @keypress="${1}">Allgemeinen Geschäftsbedingungen</a>
-    zu`
-};
-export {
-  templates
+  "pd.order.summary.agree.link1": `Ich akzeptiere die`,
+  "pd.order.summary.agree.link2": `Allgemeinen Geschäftsbedingungen`
 };
+
+export { templates };

package/dist/locales/en.js

@@ -1,10 +1,9 @@
-import { html } from "lit";
 const templates = {
   "pd.order.contacts.billingContact.inputHeader": `Billing Address`,
   "pd.order.contacts.orderContact.inputHeader": `Address`,
   "pd.order.contacts.propertyContact.checkBox": `Is the customer a landlord?`,
-  "pd.order.summary.agree.link": html`Agree to our
-    <a @click="${0}" @keypress="${1}">terms and conditions</a>.`,
+  "pd.order.summary.agree.link1": `I accept the`,
+  "pd.order.summary.agree.link2": `Terms and Conditions`,
   "pd.order.summary.agree.required": `Please agree to the terms and conditions to proceed.`,
   "pd.order.summary.billing": `Invoice`,
   "pd.order.summary.title": `Overview`,
@@ -21,6 +20,5 @@ const templates = {
   se1b4ea2cbb1f9bb4: `Immobilie`,
   s3be4da85df39b1c2: `Verwaltung`
 };
-export {
-  templates
-};
+
+export { templates };

package/dist/pd-order-contacts/PdOrderContacts.d.ts

@@ -0,0 +1,50 @@
+import { LitElement, CSSResultGroup, PropertyValues } from 'lit';
+import { PdContactData, PdContactMatch } from '@progressive-development/pd-contact';
+/**
+ * Order contact management with multiple address sections.
+ *
+ * @tagname pd-order-contacts
+ * @summary Multi-contact form with order, billing, admin, and property addresses.
+ *
+ * @event validate-form - Fired during contact validation.
+ */
+export declare class PdOrderContacts extends LitElement {
+    /** Show read-only summary mode */
+    summary: boolean;
+    /** Section title overrides for contact headers */
+    contactTitle: Record<string, string>;
+    /** Required field names per contact (e.g., ['street', 'zip']) */
+    requiredFields: string[];
+    /** Primary order contact data */
+    orderContact?: PdContactData;
+    /** Optional separate billing address */
+    billingContact?: PdContactData;
+    /** Optional admin/management contact */
+    adminContact?: PdContactData;
+    /** Property address if different from order address */
+    propertyContact?: PdContactData;
+    /** Enable billing address option */
+    withPayment: boolean;
+    /** Enable property owner/landlord options */
+    withPropertyOwner: boolean;
+    /** Enable property date field */
+    withPropertyDate: boolean;
+    /** Optional field validation/mapping configuration */
+    match?: PdContactMatch;
+    /** @ignore */
+    private _ownBillingContact;
+    /** @ignore */
+    private _ownAdminContact;
+    /** @ignore */
+    private _isPropertyOwner;
+    static styles: CSSResultGroup;
+    update(changedProps: PropertyValues<this>): void;
+    protected render(): import('lit').TemplateResult<1>;
+    private _renderEditContacts;
+    private _renderSummary;
+    get valid(): boolean;
+    triggerValidate(): Promise<boolean>;
+    getValues(): any;
+    private _getCollapseMap;
+}
+//# sourceMappingURL=PdOrderContacts.d.ts.map

package/dist/pd-order-contacts/PdOrderContacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PdOrderContacts.d.ts","sourceRoot":"","sources":["../../src/pd-order-contacts/PdOrderContacts.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EAIV,cAAc,EACd,cAAc,EACf,MAAM,KAAK,CAAC;AAIb,OAAO,uDAAuD,CAAC;AAC/D,OAAO,iDAAiD,CAAC;AACzD,OAAO,gDAAgD,CAAC;AACxD,OAAO,+CAA+C,CAAC;AAIvD,OAAO,EAEL,aAAa,EACb,cAAc,EACf,MAAM,qCAAqC,CAAC;AAE7C;;;;;;;GAOG;AACH,qBACa,eAAgB,SAAQ,UAAU;IAC7C,kCAAkC;IAElC,OAAO,UAAS;IAEhB,kDAAkD;IAElD,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAM;IAE1C,iEAAiE;IAEjE,cAAc,EAAE,MAAM,EAAE,CAAM;IAE9B,iCAAiC;IAEjC,YAAY,CAAC,EAAE,aAAa,CAAC;IAE7B,wCAAwC;IAExC,cAAc,CAAC,EAAE,aAAa,CAAC;IAE/B,wCAAwC;IAExC,YAAY,CAAC,EAAE,aAAa,CAAC;IAE7B,uDAAuD;IAEvD,eAAe,CAAC,EAAE,aAAa,CAAC;IAEhC,oCAAoC;IAEpC,WAAW,UAAS;IAEpB,6CAA6C;IAE7C,iBAAiB,UAAS;IAE1B,iCAAiC;IAEjC,gBAAgB,UAAS;IAEzB,sDAAsD;IAEtD,KAAK,CAAC,EAAE,cAAc,CAAC;IAEvB,cAAc;IAEd,OAAO,CAAC,kBAAkB,CAAS;IAEnC,cAAc;IAEd,OAAO,CAAC,gBAAgB,CAAS;IAEjC,cAAc;IAEd,OAAO,CAAC,gBAAgB,CAAS;IAEjC,OAAgB,MAAM,EAAE,cAAc,CA+CpC;IAEO,MAAM,CAAC,YAAY,EAAE,cAAc,CAAC,IAAI,CAAC,GAAG,IAAI;IAazD,SAAS,CAAC,MAAM;IAIhB,OAAO,CAAC,mBAAmB;IAiK3B,OAAO,CAAC,cAAc;IA+CtB,IAAI,KAAK,IAAI,OAAO,CASnB;IAEY,eAAe,IAAI,OAAO,CAAC,OAAO,CAAC;IAkCzC,SAAS;IAWhB,OAAO,CAAC,eAAe;CAoBxB"}