@umbraco-commerce/backoffice 14.0.0-rc2

package/README.md

@@ -0,0 +1,7 @@
+# @umbraco-commerce/backoffice
+This package contains the TypeScript type definitions for the Umbraco Commerce Backoffice.
+
+## Installation
+```bash
+npm install -D @umbraco-commerce/backoffice
+```

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@umbraco-commerce/backoffice",
+  "version": "14.0.0-rc2",
+  "type": "module",
+  "types": "./types/umbraco-commerce-public.d.ts",
+  "files": [
+    "types/umbraco-commerce-public.d.ts",
+    "README.md"
+  ],
+  "engines": {
+    "node": ">=20.9 <21",
+    "npm": ">=10.1 < 11"
+  },
+  "bugs": {
+    "url": "https://github.com/umbraco/Umbraco.Commerce.Issues/issues"
+  },
+  "author": {
+    "name": "Umbraco A/S",
+    "email": "dxp@umbraco.com",
+    "url": "https://umbraco.com"
+  },
+  "peerDependencies": {
+    "@umbraco-cms/backoffice": ">= 14.1.0 < 15"
+  }
+}

package/types/umbraco-commerce-public.d.ts

@@ -0,0 +1,200 @@
+import { HTMLElementConstructor } from '@umbraco-cms/backoffice/extension-api';
+import { LitElement } from '@umbraco-cms/backoffice/external/lit';
+import { ManifestBase } from '@umbraco-cms/backoffice/extension-api';
+import { ManifestElement } from '@umbraco-cms/backoffice/extension-api';
+import { ManifestElementAndApi } from '@umbraco-cms/backoffice/extension-api';
+import { ManifestKind } from '@umbraco-cms/backoffice/extension-api';
+import { TemplateResult } from 'lit-html';
+import { UmbApi } from '@umbraco-cms/backoffice/extension-api';
+import { UmbControllerHostElement } from '@umbraco-cms/backoffice/controller-api';
+import { UmbElement } from '@umbraco-cms/backoffice/element-api';
+import { UmbExtensionElementInitializer } from '@umbraco-cms/backoffice/extension-api';
+import { UmbPropertyEditorConfig } from '@umbraco-cms/backoffice/property-editor';
+
+/** @public **/
+export declare const UC_ENTITY_QUICK_ACTION_DEFAULT_KIND_MANIFEST: UcDefaultManifestEntityQuickActionKind;
+
+/** @public **/
+export declare type UcAnalyticsTimeframe = {
+    dateRange: UcAnalyticsTimeframeRange;
+    comparisonDateRange?: UcAnalyticsTimeframeRange;
+};
+
+/** @public **/
+export declare type UcAnalyticsTimeframeRange = {
+    alias: string;
+    from: Date;
+    to: Date;
+};
+
+/** @public **/
+export declare interface UcAnalyticsWidget extends UmbControllerHostElement {
+    storeId: string;
+    manifest: UcManifestAnalyticsWidget;
+    timeframe: UcAnalyticsTimeframe;
+}
+
+/** @public **/
+export declare type UcDefaultManifestEntityQuickActionKind = ManifestKind<UcManifestEntityQuickAction> & ManifestBase;
+
+/** @public **/
+export declare interface UcEntityQuickActionApi extends UmbApi {
+    manifest: UcManifestEntityQuickAction;
+    execute(): Promise<void>;
+}
+
+/** @public **/
+export declare interface UcEntityQuickActionElement extends UmbControllerHostElement {
+    manifest: UcManifestEntityQuickAction;
+    api?: UcEntityQuickActionApi;
+}
+
+/** @public **/
+export declare interface UcManifestActivityLogEntry extends ManifestBase {
+    type: 'ucActivityLogEntry';
+    forEventType: string;
+    meta: UcMetaActivityLogEntry;
+}
+
+/** @public **/
+export declare interface UcManifestAnalyticsWidget extends ManifestElement<UcAnalyticsWidget> {
+    type: 'ucAnalyticsWidget';
+    meta: UcMetaAnalyticsWidget;
+}
+
+/** @public **/
+export declare interface UcManifestEntityQuickAction extends ManifestElementAndApi<UcEntityQuickActionElement, UcEntityQuickActionApi> {
+    type: 'ucEntityQuickAction';
+    meta: UcMetaEntityQuickAction;
+}
+
+/** @public **/
+export declare interface UcManifestOrderCollectionProperty extends UcManifestResolvableOrderProperty<UcMetaOrderCollectionProperty>, ManifestBase {
+    type: 'ucOrderCollectionProperty';
+    forEntityTypes?: Array<string>;
+    meta: UcMetaOrderCollectionProperty;
+}
+
+/** @public **/
+export declare interface UcManifestOrderLineProperty extends ManifestBase {
+    type: 'ucOrderLineProperty';
+    forEntityTypes?: Array<string>;
+    meta: UcMetaOrderLineProperty;
+}
+
+/** @public **/
+export declare interface UcManifestOrderProperty extends UcManifestResolvableOrderProperty<UcMetaOrderProperty>, ManifestBase {
+    type: 'ucOrderProperty';
+    forEntityTypes?: Array<string>;
+    meta: UcMetaOrderProperty;
+}
+
+/** @public **/
+export declare interface UcManifestResolvableOrderProperty<TMeta extends UcMetaResolvableOrderProperty> {
+    meta: TMeta;
+}
+
+/** @public **/
+export declare interface UcManifestStoreMenuItem extends ManifestElement<UcStoreMenuItemElement> {
+    type: 'ucStoreMenuItem';
+    meta: UcMetaStoreMenuItem;
+}
+
+/** @public **/
+export declare interface UcMetaActivityLogEntry {
+    color?: string;
+    tag?: string;
+    label?: string;
+    href?: string;
+}
+
+/** @public **/
+export declare interface UcMetaAnalyticsWidget {
+    label: string;
+    description?: string;
+}
+
+/** @public **/
+export declare interface UcMetaEntityQuickAction {
+    entityType: string;
+    label: string;
+    look?: 'primary' | 'secondary';
+}
+
+/** @public **/
+export declare interface UcMetaOrderCollectionProperty extends UcMetaResolvableOrderProperty {
+    label?: string | null;
+    placeholder?: string | null;
+    align?: "left" | "center" | "right" | null;
+    labelUiAlias?: string | null;
+    labelConfig?: UmbPropertyEditorConfig | undefined;
+}
+
+/** @public **/
+export declare interface UcMetaOrderLineProperty {
+    propertyAlias: string;
+    readOnly?: boolean;
+    showInOrderLineSummary?: boolean;
+    summaryStyle?: "inline" | "table";
+    label?: string | null;
+    description?: string | null;
+    placeholder?: string | null;
+    editorUiAlias?: string | null;
+    editorElementName?: string | null;
+    editorConfig?: UmbPropertyEditorConfig | undefined;
+    labelUiAlias?: string | null;
+    labelElementName?: string | null;
+    labelConfig?: UmbPropertyEditorConfig | undefined;
+}
+
+/** @public **/
+export declare interface UcMetaOrderProperty extends UcMetaResolvableOrderProperty {
+    group: string;
+    label?: string | null;
+    description?: string | null;
+    placeholder?: string | null;
+    editorUiAlias?: string | null;
+    editorElementName?: string | null;
+    editorConfig?: UmbPropertyEditorConfig | undefined;
+    labelUiAlias?: string | null;
+    labelElementName?: string | null;
+    labelConfig?: UmbPropertyEditorConfig | undefined;
+}
+
+/** @public **/
+export declare interface UcMetaResolvableOrderProperty {
+    propertyAlias: string;
+}
+
+/** @public **/
+export declare interface UcMetaStoreMenuItem {
+    menus: string[];
+    label?: string;
+    entityType: string;
+    childEntityTypes?: string[];
+    parentAlias?: string;
+    icon?: string;
+    selectable?: boolean;
+}
+
+/** @public **/
+export declare class UcStoreMenuItemElement extends UcStoreMenuItemElementBase {
+    #private;
+    manifest: UcManifestStoreMenuItem;
+    rootUnique: string;
+    rootEntityType: string;
+    exts: Array<UmbExtensionElementInitializer>;
+    _href?: string;
+    _childHrefs: string[];
+    private _isActive;
+    constructor();
+    private _observeSection;
+    private _constructPath;
+    connectedCallback(): void;
+    render(): TemplateResult<1>;
+}
+
+/** @public **/
+export declare const UcStoreMenuItemElementBase: HTMLElementConstructor<UmbElement> & typeof LitElement;
+
+export { }