@myparcel-dev/pdk-admin 1.13.0

package/src/__tests__/__snapshots__/exports.spec.ts.snap

@@ -0,0 +1,195 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`exports > exports from index.ts 1`] = `
+[
+  "ActionButton",
+  "AdminAction",
+  "AdminComponent",
+  "AdminContextKey",
+  "AdminIcon",
+  "AdminInstanceContextKey",
+  "AdminModalKey",
+  "AdminView",
+  "BackendEndpoint",
+  "BulkSelectCheckbox",
+  "ChildProductSettingsView",
+  "FORM_KEYS",
+  "FORM_KEY_ACCOUNT_SETTINGS",
+  "FORM_KEY_CHILD_PRODUCT_SETTINGS",
+  "FORM_KEY_MODAL",
+  "FORM_KEY_MODAL_PRINT_OPTIONS",
+  "FORM_KEY_MODAL_RETURN_OPTIONS",
+  "FORM_KEY_MODAL_SHIPMENT_OPTIONS",
+  "FORM_KEY_PLUGIN_SETTINGS",
+  "FORM_KEY_PRODUCT_SETTINGS",
+  "FormHook",
+  "FrontendEndpoint",
+  "INJECT_ADMIN_INSTANCE",
+  "INJECT_GLOBAL_PDK_ADMIN",
+  "LogLevel",
+  "ModalsView",
+  "NotificationCategory",
+  "NotificationContainer",
+  "NotificationsView",
+  "OrderBoxView",
+  "OrderListItemView",
+  "PackageType",
+  "PdkAdmin",
+  "PlainElement",
+  "PluginSettingsView",
+  "ProductSettingsView",
+  "QUERY_KEY_ORDER",
+  "QUERY_KEY_SHIPMENT",
+  "ResetButton",
+  "ReturnsForm",
+  "ShipmentBarcode",
+  "ShipmentOptionsForm",
+  "ShipmentStatus",
+  "Size",
+  "SortType",
+  "Status",
+  "StatusIndicator",
+  "StopActionHandler",
+  "SubmitButton",
+  "TabNavigation",
+  "TriState",
+  "Variant",
+  "allAdminComponentNames",
+  "createAdminConfig",
+  "createFormElement",
+  "createHandlerWithParameters",
+  "createLogger",
+  "createMutationHandler",
+  "createOrdersMutationHandler",
+  "createPdkAdmin",
+  "createPdkAdminPlugin",
+  "createQueryHandler",
+  "createShipmentsMutationHandler",
+  "defineAction",
+  "deleteAccountAction",
+  "doMutate",
+  "downloadLogsAction",
+  "executeAction",
+  "executeAfterHandle",
+  "executeBeforeHandle",
+  "executeHandler",
+  "executeNextAction",
+  "fetchDynamicContextAction",
+  "fetchPluginSettingsViewContextAction",
+  "generateFieldId",
+  "getActionIdentifier",
+  "modalCloseAction",
+  "modalSubmitFormAction",
+  "openOrPrintPdf",
+  "optionalAdminActionContainerComponentNames",
+  "optionalAdminComponentNames",
+  "optionalAdminPlainWrapperComponentNames",
+  "orderExportAction",
+  "orderExportToShipmentsAction",
+  "orderViewInBackofficeAction",
+  "ordersEditAction",
+  "ordersExportPrintShipmentsAction",
+  "ordersFetchAction",
+  "ordersPrintAction",
+  "ordersUpdateAction",
+  "pluginSettingsUpdateAction",
+  "prefixComponent",
+  "refreshAccountAction",
+  "requiredAdminComponentNames",
+  "resolveFormComponent",
+  "resolveOrderParameters",
+  "resolvePrintParameters",
+  "resolveQuerySuffix",
+  "shipmentActions",
+  "shipmentsDeleteAction",
+  "shipmentsExportReturnAction",
+  "shipmentsPrintAction",
+  "shipmentsUpdateAction",
+  "switchToAcceptanceApiAction",
+  "switchToProductionApiAction",
+  "updateAccountAction",
+  "useActionStore",
+  "useAdminConfig",
+  "useAppInfo",
+  "useCheckboxGroupContext",
+  "useCreateWebhooksMutation",
+  "useDeleteAccountMutation",
+  "useDeleteShipmentsMutation",
+  "useDeleteWebhooksMutation",
+  "useDownloadLogsMutation",
+  "useDropOffInputContext",
+  "useDropdownButtonContext",
+  "useDropdownData",
+  "useElement",
+  "useElementContext",
+  "useElementOptions",
+  "useExportOrdersMutation",
+  "useExportReturnMutation",
+  "useFetchContextQuery",
+  "useFetchOrdersQuery",
+  "useFetchProductsQuery",
+  "useFetchShipmentsQuery",
+  "useFetchWebhooksQuery",
+  "useForm",
+  "useFormBuilder",
+  "useFormatter",
+  "useGlobalContext",
+  "useGlobalPdkAdmin",
+  "useInputWithOptionsContext",
+  "useLanguage",
+  "useLoadMore",
+  "useLogger",
+  "useModalContext",
+  "useModalElementContext",
+  "useModalStore",
+  "useMultiSelectInputContext",
+  "useNotificationStore",
+  "useOrderData",
+  "useOrdersData",
+  "usePdkMutation",
+  "usePrintOrdersMutation",
+  "usePrintShipmentsMutation",
+  "useProductData",
+  "useQueryStore",
+  "useRadioGroupContext",
+  "useSelectInputContext",
+  "useShippingMethodsInputContext",
+  "useStoreQuery",
+  "useSwitchToAcceptanceApiMutation",
+  "useSwitchToProductionApiMutation",
+  "useTableContext",
+  "useToggleInputContext",
+  "useTriStateInputContext",
+  "useUpdateAccountMutation",
+  "useUpdateOrdersMutation",
+  "useUpdatePluginSettingsMutation",
+  "useUpdateProductSettingsMutation",
+  "useUpdateShipmentsMutation",
+  "useWeekdays",
+  "waitForLabelPrompt",
+  "webhooksCreateAction",
+  "webhooksDeleteAction",
+  "webhooksFetchAction",
+]
+`;
+
+exports[`exports > exports from testing.ts 1`] = `
+[
+  "doComponentTestSetup",
+  "doComponentTestTeardown",
+  "mockDefaultAccount",
+  "mockDefaultAppConfig",
+  "mockDefaultAppInfo",
+  "mockDefaultCarriers",
+  "mockDefaultConfig",
+  "mockDefaultDynamicContext",
+  "mockDefaultEndpoints",
+  "mockDefaultGlobalContext",
+  "mockDefaultLogger",
+  "mockDefaultPlatform",
+  "mockDefaultPluginSettings",
+  "mockDefaultPrintOptionsView",
+  "mockDefaultShop",
+  "mockDefaultTranslations",
+]
+`;

package/src/__tests__/doComponentTestSetup.ts

@@ -0,0 +1,54 @@
+import {vi} from 'vitest';
+import {config} from '@vue/test-utils';
+import {createTestingPinia} from '@pinia/testing';
+import {prefixComponent} from '../utils';
+import {type AdminAppConfig, type AdminComponentMap} from '../types';
+import {useQueryStore} from '../stores';
+import {globalLogger, LogLevel} from '../services';
+import {
+  createContextPlugin,
+  createLoggerPlugin,
+  createRegisterComponentsPlugin,
+  createVueQueryPlugin,
+  testIdDirective,
+} from '../pdk';
+import {allAdminComponentNames} from '../data';
+import {mockDefaultAppConfig, mockDefaultConfig, mockDefaultLogger} from './mocks';
+
+export const doComponentTestSetup = (components?: Partial<AdminComponentMap>): void => {
+  const logger = mockDefaultLogger();
+  logger.level = LogLevel.Off;
+
+  const appConfig: AdminAppConfig = {
+    ...mockDefaultAppConfig(),
+    config: {
+      ...mockDefaultConfig(),
+      components: (components ?? {}) as AdminComponentMap,
+    },
+    logger,
+  };
+
+  globalLogger.level = LogLevel.Off;
+
+  config.global.plugins = [
+    createTestingPinia({
+      createSpy: vi.fn,
+      stubActions: false,
+    }),
+    createVueQueryPlugin(appConfig),
+    createContextPlugin(appConfig),
+    createLoggerPlugin(appConfig),
+    createRegisterComponentsPlugin(appConfig),
+    (app) => {
+      app.runWithContext(() => {
+        useQueryStore().registerContextQueries();
+      });
+    },
+  ];
+
+  config.global.directives.test = testIdDirective;
+
+  const stubsArray = allAdminComponentNames.map((name) => [prefixComponent(name), true]);
+
+  config.global.stubs = Object.fromEntries(stubsArray);
+};

package/src/__tests__/doComponentTestTeardown.ts

@@ -0,0 +1,6 @@
+import {config} from '@vue/test-utils';
+
+export const doComponentTestTeardown = (): void => {
+  config.global.plugins = [];
+  config.global.stubs = {};
+};

package/src/__tests__/exports.spec.ts

@@ -0,0 +1,13 @@
+import {describe, expect, it} from 'vitest';
+import * as testing from '../testing';
+import * as index from '../index';
+
+describe('exports', () => {
+  it('exports from index.ts', () => {
+    expect(Object.keys(index).sort()).toMatchSnapshot();
+  });
+
+  it('exports from testing.ts', () => {
+    expect(Object.keys(testing).sort()).toMatchSnapshot();
+  });
+});

package/src/__tests__/getElementContext.spec.ts

@@ -0,0 +1,18 @@
+import {describe, expect, it} from 'vitest';
+import {getElementContext} from '../services';
+
+describe('get element context', () => {
+  it('gets context from an element', () => {
+    const div = document.createElement('div');
+    div.setAttribute('id', 'a-div-with-context');
+    div.setAttribute('data-pdk-context', '{"json":"content"}');
+
+    document.body.appendChild(div);
+
+    expect(getElementContext('#a-div-with-context')).toEqual({json: 'content'});
+  });
+
+  it('returns empty object for element that does not exist', () => {
+    expect(getElementContext('#does-not-exist')).toEqual({});
+  });
+});

package/src/__tests__/index.ts

@@ -0,0 +1,3 @@
+export * from './doComponentTestSetup';
+export * from './doComponentTestTeardown';
+export * from './mocks';

package/src/__tests__/mocks/index.ts

@@ -0,0 +1,14 @@
+export * from './mockDefaultAccount';
+export * from './mockDefaultAppConfig';
+export * from './mockDefaultAppInfo';
+export * from './mockDefaultCarriers';
+export * from './mockDefaultConfig';
+export * from './mockDefaultDynamicContext';
+export * from './mockDefaultEndpoints';
+export * from './mockDefaultGlobalContext';
+export * from './mockDefaultLogger';
+export * from './mockDefaultPlatform';
+export * from './mockDefaultPluginSettings';
+export * from './mockDefaultPrintOptionsView';
+export * from './mockDefaultShop';
+export * from './mockDefaultTranslations';

package/src/__tests__/mocks/mockDefaultAccount.ts

@@ -0,0 +1,18 @@
+import {vi} from 'vitest';
+import {type Account} from '@myparcel-dev/pdk-common';
+import {mockDefaultShop} from './mockDefaultShop';
+
+export const mockDefaultAccount = vi.fn((): Account.ModelAccount => {
+  return {
+    id: 1,
+    platformId: 1,
+    status: 2,
+    contactInfo: {},
+    generalSettings: {
+      isTest: false,
+      hasCarrierContract: false,
+      orderMode: false,
+    },
+    shops: [mockDefaultShop()],
+  };
+});

package/src/__tests__/mocks/mockDefaultAppConfig.ts

@@ -0,0 +1,21 @@
+import {vi} from 'vitest';
+import {AdminContextKey} from '@myparcel-dev/pdk-common';
+import {type AdminAppConfig} from '../../types';
+import {AdminView} from '../../data';
+import {mockDefaultLogger} from './mockDefaultLogger';
+import {mockDefaultGlobalContext} from './mockDefaultGlobalContext';
+import {mockDefaultDynamicContext} from './mockDefaultDynamicContext';
+import {mockDefaultConfig} from './mockDefaultConfig';
+
+export const mockDefaultAppConfig = vi.fn((): AdminAppConfig => {
+  return {
+    appName: 'test',
+    config: mockDefaultConfig(),
+    context: {
+      [AdminContextKey.Dynamic]: mockDefaultDynamicContext(),
+      [AdminContextKey.Global]: mockDefaultGlobalContext(),
+    },
+    logger: mockDefaultLogger(),
+    view: AdminView.OrderBox,
+  };
+});

package/src/__tests__/mocks/mockDefaultAppInfo.ts

@@ -0,0 +1,12 @@
+import {vi} from 'vitest';
+import {type Plugin} from '@myparcel-dev/pdk-common';
+
+export const mockDefaultAppInfo = vi.fn((): Plugin.ModelContextGlobalContext['appInfo'] => {
+  return {
+    name: 'test',
+    version: '1.0.0',
+    path: '/test',
+    title: 'test',
+    url: 'http://test.com',
+  };
+});

package/src/__tests__/mocks/mockDefaultCarriers.ts

@@ -0,0 +1,4 @@
+import {vi} from 'vitest';
+import {type Plugin} from '@myparcel-dev/pdk-common';
+
+export const mockDefaultCarriers = vi.fn((): Plugin.ModelContextDynamicContext['carriers'] => []);

package/src/__tests__/mocks/mockDefaultConfig.ts

@@ -0,0 +1,11 @@
+import {vi} from 'vitest';
+import {type AdminComponentMap, type AdminConfiguration} from '../../types';
+import {LogLevel} from '../../services';
+
+export const mockDefaultConfig = vi.fn(
+  (): AdminConfiguration => ({
+    components: {} as AdminComponentMap,
+    logLevel: LogLevel.Off,
+    generateFieldId: (element) => `${element.form.name}-${element.name}`,
+  }),
+);

package/src/__tests__/mocks/mockDefaultDynamicContext.ts

@@ -0,0 +1,17 @@
+import {vi} from 'vitest';
+import {type Plugin} from '@myparcel-dev/pdk-common';
+import {mockDefaultShop} from './mockDefaultShop';
+import {mockDefaultPrintOptionsView} from './mockDefaultPrintOptionsView';
+import {mockDefaultPluginSettings} from './mockDefaultPluginSettings';
+import {mockDefaultCarriers} from './mockDefaultCarriers';
+import {mockDefaultAccount} from './mockDefaultAccount';
+
+export const mockDefaultDynamicContext = vi.fn((): Plugin.ModelContextDynamicContext => {
+  return {
+    account: mockDefaultAccount(),
+    carriers: mockDefaultCarriers(),
+    pluginSettings: mockDefaultPluginSettings(),
+    printOptionsView: mockDefaultPrintOptionsView(),
+    shop: mockDefaultShop(),
+  };
+});

package/src/__tests__/mocks/mockDefaultEndpoints.ts

@@ -0,0 +1,19 @@
+import {vi} from 'vitest';
+import {BackendEndpoint} from '@myparcel-dev/pdk-common';
+import {type GlobalAdminContext} from '../../types';
+
+export const mockDefaultEndpoints = vi.fn((): GlobalAdminContext['endpoints'] =>
+  Object.values(BackendEndpoint).reduce((acc, endpoint) => {
+    return {
+      ...acc,
+      [endpoint]: {
+        body: '',
+        headers: [],
+        method: '',
+        parameters: [],
+        path: endpoint,
+        property: '',
+      },
+    };
+  }, {} as GlobalAdminContext['endpoints']),
+);

package/src/__tests__/mocks/mockDefaultGlobalContext.ts

@@ -0,0 +1,21 @@
+import {vi} from 'vitest';
+import {type GlobalAdminContext} from '../../types';
+import {mockDefaultTranslations} from './mockDefaultTranslations';
+import {mockDefaultPlatform} from './mockDefaultPlatform';
+import {mockDefaultEndpoints} from './mockDefaultEndpoints';
+import {mockDefaultAppInfo} from './mockDefaultAppInfo';
+
+export const mockDefaultGlobalContext = vi.fn((): GlobalAdminContext => {
+  return {
+    appInfo: mockDefaultAppInfo(),
+    baseUrl: '',
+    bootId: '',
+    endpoints: mockDefaultEndpoints(),
+    eventPing: 'test1',
+    eventPong: 'test2',
+    language: 'en-US',
+    mode: '',
+    platform: mockDefaultPlatform(),
+    translations: mockDefaultTranslations(),
+  };
+});

package/src/__tests__/mocks/mockDefaultLogger.ts

@@ -0,0 +1,4 @@
+import {vi} from 'vitest';
+import {createLogger} from '../../services';
+
+export const mockDefaultLogger = vi.fn(() => createLogger('test'));

package/src/__tests__/mocks/mockDefaultPlatform.ts

@@ -0,0 +1,14 @@
+import {vi} from 'vitest';
+import {type GlobalAdminContext} from '../../types';
+
+export const mockDefaultPlatform = vi.fn((): GlobalAdminContext['platform'] => {
+  return {
+    backofficeUrl: 'https://backoffice.test.myparcel.nl',
+    defaultCarrier: 'postnl',
+    defaultCarrierId: 1,
+    human: 'Test',
+    localCountry: 'NL',
+    name: 'test',
+    supportUrl: 'https://developer.myparcel.nl/contact',
+  };
+});

package/src/__tests__/mocks/mockDefaultPluginSettings.ts

@@ -0,0 +1,15 @@
+import {vi} from 'vitest';
+import {type Plugin} from '@myparcel-dev/pdk-common';
+
+export const mockDefaultPluginSettings = vi.fn((): Plugin.ModelContextDynamicContext['pluginSettings'] => {
+  return {
+    account: {
+      apiKey: 'test',
+    },
+    carrier: {},
+    checkout: {},
+    customs: {},
+    label: {},
+    order: {},
+  } as Plugin.ModelContextDynamicContext['pluginSettings'];
+});

package/src/__tests__/mocks/mockDefaultPrintOptionsView.ts

@@ -0,0 +1,13 @@
+import {vi} from 'vitest';
+import {type Plugin} from '@myparcel-dev/pdk-common';
+
+export const mockDefaultPrintOptionsView = vi.fn((): Plugin.SettingsView => {
+  return {
+    id: 'print-options',
+    children: [],
+    description: 'Print options',
+    elements: [],
+    subtext: 'Print options',
+    title: 'Print options',
+  };
+});

package/src/__tests__/mocks/mockDefaultShop.ts

@@ -0,0 +1,20 @@
+import {vi} from 'vitest';
+import {type Account} from '@myparcel-dev/pdk-common';
+
+export const mockDefaultShop = vi.fn((): Account.ModelShop => {
+  return {
+    name: 'test',
+    id: 1,
+    platformId: 1,
+    accountId: 1,
+    generalSettings: {},
+    billing: {},
+    return: {},
+    carrierConfigurations: [],
+    carriers: [],
+    deliveryAddress: {},
+    hidden: false,
+    shipmentOptions: {},
+    trackTrace: {},
+  };
+});

package/src/__tests__/mocks/mockDefaultTranslations.ts

@@ -0,0 +1,4 @@
+import {vi} from 'vitest';
+import {type GlobalAdminContext} from '../../types';
+
+export const mockDefaultTranslations = vi.fn((): GlobalAdminContext['translations'] => ({}));

package/src/__tests__/render.spec.ts

@@ -0,0 +1,53 @@
+/* eslint-disable no-magic-numbers */
+import {defineComponent, h, inject, onMounted} from 'vue';
+import {describe, expect, it, vi} from 'vitest';
+import {mount} from '@vue/test-utils';
+import {INJECT_GLOBAL_PDK_ADMIN} from '../symbols';
+
+describe.skip('rendering app pieces', () => {
+  it('has unique context per piece', () => {
+    const spy = vi.spyOn(console, 'log');
+
+    const mockComponent2 = defineComponent({
+      name: 'MC2',
+      render: () => {
+        const instance = inject(INJECT_GLOBAL_PDK_ADMIN);
+
+        return h('div');
+      },
+    });
+
+    const mockComponent = defineComponent({
+      name: 'MockComponent',
+      render: () => {
+        const cb1 = h(
+          'div',
+          async () =>
+            new Promise((resolve) => {
+              resolve({default: mockComponent2});
+            }),
+        );
+
+        onMounted(() => {
+          /* eslint-disable @typescript-eslint/ban-ts-comment */
+          // @ts-ignore
+          cb1('#el1', {[ContextKey.OrderData]: {orderId: 1}});
+          // @ts-ignore
+          cb1('#el2', {[ContextKey.OrderData]: {orderId: 2}});
+          // @ts-ignore
+          cb1('#el3', {[ContextKey.OrderData]: {orderId: 3}});
+          /* eslint-enable @typescript-eslint/ban-ts-comment */
+        });
+
+        return h('div', {}, [h('div', {id: 'el1'}), h('div', {id: 'el2'}), h('div', {id: 'el3'})]);
+      },
+    });
+
+    const wrapper = mount(mockComponent);
+
+    expect(spy).toHaveBeenCalledTimes(3);
+    expect(spy).toHaveBeenNthCalledWith(1, 1);
+    expect(spy).toHaveBeenNthCalledWith(2, 2);
+    expect(spy).toHaveBeenNthCalledWith(3, 3);
+  });
+});

package/src/__tests__/utils/mockLinkElement.ts

@@ -0,0 +1,20 @@
+import {vi} from 'vitest';
+
+export const mockLinkElement = () => {
+  const createElementSpy = vi.spyOn(document, 'createElement');
+  const appendChildSpy = vi.spyOn(document.body, 'appendChild');
+
+  const mockElement = document.createElement('a');
+
+  mockElement.setAttribute = vi.fn();
+  mockElement.click = vi.fn();
+  mockElement.remove = vi.fn();
+
+  createElementSpy.mockReturnValue(mockElement);
+
+  return {
+    createElementSpy,
+    appendChildSpy,
+    mockElement,
+  };
+};

package/src/actions/composables/index.ts

@@ -0,0 +1,2 @@
+export * from './mutations';
+export * from './queries';

package/src/actions/composables/mutations/account/index.ts

@@ -0,0 +1,2 @@
+export * from './useDeleteAccountMutation';
+export * from './useUpdateAccountMutation';

package/src/actions/composables/mutations/account/useDeleteAccountMutation.ts

@@ -0,0 +1,30 @@
+import {useQueryClient} from '@tanstack/vue-query';
+import {AdminContextKey, BackendEndpoint} from '@myparcel-dev/pdk-common';
+import {usePdkMutation} from '../usePdkMutation';
+import {type ResolvedQuery} from '../../../../stores';
+import {usePdkAdminApi} from '../../../../sdk';
+
+export const useDeleteAccountMutation = (): ResolvedQuery<BackendEndpoint.DeleteAccount> => {
+  const queryClient = useQueryClient();
+
+  return usePdkMutation(
+    BackendEndpoint.DeleteAccount,
+    async () => {
+      const pdk = usePdkAdminApi();
+
+      const context = await pdk.deleteAccount();
+
+      return context[0];
+    },
+    {
+      ...queryClient.defaultMutationOptions(),
+
+      onSuccess(data) {
+        queryClient.setQueryData(
+          [BackendEndpoint.FetchContext, AdminContextKey.Dynamic],
+          data[AdminContextKey.Dynamic],
+        );
+      },
+    },
+  );
+};