@newsletterstudio/umbraco 14.0.0-rc1

package/dist/modules/transactional/template/edit/settings/modal/ns-transactional-template-email-designer.element.d.ts

@@ -0,0 +1,21 @@
+import { NsEmailModalBaseElement } from '@newsletterstudio/umbraco/core';
+import { NsTransactionalTemplateEditModalContext } from './ns-transactional-template-email-designer.context';
+/**
+* ns-transactional-template-email-designer description
+* @element ns-transactional-template-email-designer
+*/
+export declare class NsTransactionalTemplateEmailDesignerElement extends NsEmailModalBaseElement<NsTransactionalTemplateEditModalContext> {
+    context?: NsTransactionalTemplateEditModalContext;
+    workspaceKey?: string;
+    transactionalKey?: string;
+    constructor();
+    connectedCallback(): Promise<void>;
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: import("lit").CSSResult[];
+}
+export default NsTransactionalTemplateEmailDesignerElement;
+declare global {
+    interface HTMLElementTagNameMap {
+        'ns-transactional-template-email-designer': NsTransactionalTemplateEmailDesignerElement;
+    }
+}

package/dist/modules/transactional/template/edit/settings/modal/steps/ns-transactional-template-edit-design.element.d.ts

@@ -0,0 +1,23 @@
+import { NsEmailEditorContext } from '@newsletterstudio/umbraco/email-editor';
+import { NsEmailEditorModel } from '@newsletterstudio/umbraco/extensibility';
+import { LitElement } from '@newsletterstudio/umbraco/lit';
+declare const NsTransactionalTemplateEditDesignElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/element-api").UmbElement> & typeof LitElement;
+/**
+* ns-transactional-template-edit-design description
+* @element ns-transactional-template-edit-design
+* @fires CustomEvent#change - lorem ipsum
+* @cssprop --ns-foo-bar - Color of lorem
+*/
+export declare class NsTransactionalTemplateEditDesignElement extends NsTransactionalTemplateEditDesignElement_base {
+    emailEditorContext?: NsEmailEditorContext;
+    model?: NsEmailEditorModel;
+    connectedCallback(): void;
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: import("lit").CSSResult[];
+}
+export default NsTransactionalTemplateEditDesignElement;
+declare global {
+    interface HTMLElementTagNameMap {
+        'ns-transactional-template-edit-design': NsTransactionalTemplateEditDesignElement;
+    }
+}

package/dist/modules/transactional/template/edit/settings/modal/steps/ns-transactional-template-edit-information.element.d.ts

@@ -0,0 +1,28 @@
+import { UmbValidationContext } from '@umbraco-cms/backoffice/validation';
+import type { DropdownOptionGroupResponseFrontendModel, ThemeListItemFrontendModel } from '@newsletterstudio/umbraco/backend';
+import { LitElement } from '@newsletterstudio/umbraco/lit';
+import type { NsTransactionalTemplateEditContext, TransactionalEditFormModel } from '../../../ns-transactional-template-edit.context.js';
+import '@newsletterstudio/umbraco/components';
+declare const NsTransactionalTemplateEditInformationElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/element-api").UmbElement> & typeof LitElement;
+/**
+* ns-transactional-template-edit-information description
+* @element ns-transactional-template-edit-information
+*/
+export declare class NsTransactionalTemplateEditInformationElement extends NsTransactionalTemplateEditInformationElement_base {
+    context?: NsTransactionalTemplateEditContext;
+    readonly validation: UmbValidationContext;
+    model?: TransactionalEditFormModel;
+    _themes: ThemeListItemFrontendModel[];
+    _mergeFieldModels: DropdownOptionGroupResponseFrontendModel[];
+    constructor();
+    _handleSubmit: (e: SubmitEvent) => void;
+    destroy(): void;
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: import("lit").CSSResult[];
+}
+export default NsTransactionalTemplateEditInformationElement;
+declare global {
+    interface HTMLElementTagNameMap {
+        'ns-transactional-template-edit-information': NsTransactionalTemplateEditInformationElement;
+    }
+}

package/dist/modules/transactional/template/edit/settings/modal/steps/ns-transactional-template-edit-preview.element.d.ts

@@ -0,0 +1,20 @@
+import type { TransactionalEditFormModel } from '../../../ns-transactional-template-edit.context.js';
+import { LitElement } from '@newsletterstudio/umbraco/lit';
+declare const NsTransactionalTemplateEditPreviewElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/element-api").UmbElement> & typeof LitElement;
+/**
+* ns-transactional-template-edit-preview description
+* @element ns-transactional-template-edit-preview
+*/
+export declare class NsTransactionalTemplateEditPreviewElement extends NsTransactionalTemplateEditPreviewElement_base {
+    #private;
+    model?: TransactionalEditFormModel;
+    constructor();
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: import("lit").CSSResult[];
+}
+export default NsTransactionalTemplateEditPreviewElement;
+declare global {
+    interface HTMLElementTagNameMap {
+        'ns-transactional-template-edit-preview': NsTransactionalTemplateEditPreviewElement;
+    }
+}

package/dist/modules/transactional/template/edit/settings/ns-transactional-template-edit-settings.element.d.ts

@@ -0,0 +1,25 @@
+import { LitElement } from '@newsletterstudio/umbraco/lit';
+import type { NsTransactionalTemplateEditContext, TransactionalEditFormModel } from '../ns-transactional-template-edit.context.js';
+declare const NsTransactionalTemplateEditSettingsElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/element-api").UmbElement> & typeof LitElement;
+/**
+* ns-transactional-template-edit-settings description
+* @element ns-transactional-template-edit-settings
+*/
+export declare class NsTransactionalTemplateEditSettingsElement extends NsTransactionalTemplateEditSettingsElement_base {
+    #private;
+    workspaceKey?: string;
+    transactionalKey?: string;
+    context?: NsTransactionalTemplateEditContext;
+    model?: TransactionalEditFormModel;
+    constructor();
+    connectedCallback(): Promise<void>;
+    render(): import("lit-html").TemplateResult<1>;
+    renderForm(): import("lit-html").TemplateResult<1>;
+    static styles: import("lit").CSSResult[];
+}
+export default NsTransactionalTemplateEditSettingsElement;
+declare global {
+    interface HTMLElementTagNameMap {
+        'ns-transactional-template-edit-settings': NsTransactionalTemplateEditSettingsElement;
+    }
+}

package/dist/modules/transactional/template/list/ns-transactional-template-list.element.d.ts

@@ -0,0 +1,26 @@
+import type { NsEmailListElement, NsEmailListParameters } from '@newsletterstudio/umbraco/components';
+import { LitElement } from '@newsletterstudio/umbraco/lit';
+import { type NsDuplicateEvent, type NsRemoveEvent } from '@newsletterstudio/umbraco/core';
+declare const NsTransactionalTemplateListElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/element-api").UmbElement> & typeof LitElement;
+/**
+* ns-transactional-template-list description
+* @element ns-transactional-template-list
+*/
+export declare class NsTransactionalTemplateListElement extends NsTransactionalTemplateListElement_base {
+    #private;
+    emailList: NsEmailListParameters;
+    workspaceKey?: string;
+    _emailListElement: NsEmailListElement;
+    connectedCallback(): Promise<void>;
+    onRemove(e: NsRemoveEvent): Promise<void>;
+    onDuplicate(e: NsDuplicateEvent): Promise<void>;
+    onChange(): Promise<void>;
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: import("lit").CSSResult[];
+}
+export default NsTransactionalTemplateListElement;
+declare global {
+    interface HTMLElementTagNameMap {
+        'ns-transactional-template-list': NsTransactionalTemplateListElement;
+    }
+}

package/dist/modules/transactional/template/manifest.d.ts

@@ -0,0 +1 @@
+export declare const manifests: import("../../../core/extensibility/index.js").ManifestNsAction[];

package/dist/section-tree.element.d.ts

@@ -0,0 +1,12 @@
+import { LitElement } from "@newsletterstudio/umbraco/lit";
+import '@newsletterstudio/umbraco/components';
+export default class DemoIndexElement extends LitElement {
+    constructor();
+    render(): import("lit-html").TemplateResult<1>;
+    static styles: import("lit").CSSResult[];
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'ns-section-tree': DemoIndexElement;
+    }
+}

package/dist/section.d.ts

@@ -0,0 +1 @@
+export declare const NS_SECTION_ALIAS = "Ns.Section.NewsletterStudio";

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@newsletterstudio/umbraco",
+  "private": false,
+  "version": "14.0.0-rc1",
+  "type": "module",
+  "exports": {
+    ".": null,
+    "./core": "./dist/core/index.js",
+    "./forms": "./dist/core/forms/index.js",
+    "./realtime": "./dist/core/realtime/index.js",
+    "./components": "./dist/core/components/index.js",
+    "./backend": "./dist/backend-api/index.js",
+    "./constants": "./dist/constants.js",
+    "./lit": "./dist/external/lit/index.js",
+    "./style": "./dist/core/components/ns-css/index.js",
+    "./extensibility": "./dist/core/extensibility/index.js",
+    "./administration": "./dist/modules/administration/index.js",
+    "./campaign": "./dist/modules/campaign/index.js",
+    "./email-editor": "./dist/modules/email-editor/index.js",
+    "./global": "./dist/modules/global/index.js",
+    "./mailing-list": "./dist/modules/mailing-list/index.js",
+    "./property-editors": "./dist/modules/property-editors/index.js",
+    "./recipient": "./dist/modules/recipient/index.js",
+    "./settings": "./dist/modules/settings/index.js",
+    "./transactional": "./dist/modules/transactional/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "@umbraco-cms/backoffice": "^14.3.0",
+    "@umbraco-ui/uui": "^1.10.0",
+    "lit": "^3.2.0"
+  }
+}

package/readme.md

@@ -0,0 +1,74 @@
+# Newsletter Studio Client
+This is the frontend files for Newsletter Studio, the project uses Vite and Lit to build web components for the Umbraco backoffice.
+
+## Develop
+Use 
+
+```bash
+npm run watch
+# or
+npm run build
+```
+
+## NPM Package
+The NPM package is built using the npm cli, there is a script ready to execute the build.
+
+### Build NPM Package
+
+```bash
+npm run build:npm
+```
+
+This script will run a Typescript-build, clean the output (in the dist-folder), cleanse the package.json file and use `npm pack` to create the package. After this we also need to publish the artifact to npmjs.org.
+
+```bash
+#TODO: How to publish NPM-package to npmjs.org
+```
+
+### Adding new exports / paths
+In `tsconfig.json` there are a number of `paths` configured. These paths can be used internally to make our own code simpler **BUT** this also means that we probably need to export it in the published NPM-package.
+
+When do we need to publish the path?
+
+* IF the path is used in ANY OTHER component, class or type that is published - the new path also needs to be included in the published NPM-package.
+
+To add a new path to the NPM package we need to:
+
+* [ ] Add the path to the `tsconfig.json`
+* [ ] Add the path to the `package.json`s `exports`-section (note that this is a relative path to the dist-folder created during build).
+* [ ] Add the path to `vite.config.ts` to ensure that the outputed js-file always have the same name (no hash).
+* [ ] Add the path as a a important map in `umbraco-package.json` (In `/NewsletterStudio/wwwroot/App_Plugins/newsletterstudio/`), have it point to the file outputted by vite.
+
+### Local build/install of NPM package
+When we want to try out a new version of the NPM-package we can create a new local build.
+
+Run 
+
+```bash
+npm run build:npm
+```
+
+This will output a `.tgz` file, move/copy this file into the project where we want to test it and install using any of the methods below.
+
+
+```bash
+# Install local package
+npm install "D:\Development\Newsletter Studio\Arkiv\Releases\newsletterstudio-umbraco-14.0.0.tgz"
+```
+
+Or in package.json, just add the path to the file and run `npm install`
+
+```json
+{
+   ...
+  "dependencies": {
+    "@newsletterstudio/umbraco": "./../npm-package-src/newsletter-studio-umbraco-ui-0.0.0.tgz",
+  }
+}
+```
+
+## Debugging
+We have several debugging concepts in the package:
+* `<umb-debug visible></umb-debug>` to show Umbraco contexts
+* `<ns-json-debug .data=${}>` to render a object as json inside a pre-element.
+* `<ns-validation-errors-debug></ns-validation-errors-debug>` to show validation errors from the closest context.