typo3-typescript-sources 13.4.20

package/form/backend/form-manager.ts

@@ -0,0 +1,180 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * Module: @typo3/form/backend/form-manager
+ */
+
+type ViewModel = typeof import('@typo3/form/backend/form-manager/view-model');
+
+export interface LabelValuePair {
+  label: string;
+  value: string;
+}
+
+export type FormManagerConfiguration = {
+  selectablePrototypesConfiguration?: Array<{
+    label: string;
+    identifier: string;
+    newFormTemplates: Array<{
+      label: string;
+      templatePath: string;
+    }>;
+  }>,
+  accessibleFormStorageFolders?: LabelValuePair[],
+  endpoints?: {
+    [key: string]: string;
+  },
+};
+
+export function assert(test: boolean|(() => boolean), message: string, messageCode: number): void {
+  if (typeof test === 'function') {
+    test = (test() !== false);
+  }
+  if (!test) {
+    message = message || 'Assertion failed';
+    if (messageCode) {
+      message = message + ' (' + messageCode + ')';
+    }
+    if ('undefined' !== typeof Error) {
+      throw new Error(message);
+    }
+    throw message;
+  }
+}
+
+export class FormManager {
+  private isRunning: boolean = false;
+  private configuration: FormManagerConfiguration;
+  private readonly viewModel: ViewModel;
+
+  public constructor(
+    configuration: FormManagerConfiguration,
+    viewModel: ViewModel
+  ) {
+    this.configuration = configuration;
+    this.viewModel = viewModel;
+  }
+
+  /**
+   * @todo deprecate, use exported `assert()` method instead
+   */
+  public assert(test: boolean|(() => boolean), message: string, messageCode: number): void {
+    assert(test, message, messageCode);
+  }
+
+  public getPrototypes(): LabelValuePair[] {
+    if (!Array.isArray(this.configuration.selectablePrototypesConfiguration)) {
+      return [];
+    }
+
+    return this.configuration.selectablePrototypesConfiguration.map((selectablePrototype): LabelValuePair => {
+      return {
+        label: selectablePrototype.label,
+        value: selectablePrototype.identifier,
+      };
+    });
+  }
+
+  public getTemplatesForPrototype(prototypeName: string): LabelValuePair[] {
+    assert('string' === typeof prototypeName, 'Invalid parameter "prototypeName"', 1475945286);
+    if (!Array.isArray(this.configuration.selectablePrototypesConfiguration)) {
+      return [];
+    }
+
+    const templates: LabelValuePair[] = [];
+    this.configuration.selectablePrototypesConfiguration.forEach((selectablePrototype): void => {
+      if (!Array.isArray(selectablePrototype.newFormTemplates)) {
+        return;
+      }
+
+      if (selectablePrototype.identifier !== prototypeName) {
+        return;
+      }
+      selectablePrototype.newFormTemplates.forEach((newFormTemplate): void => {
+        templates.push({
+          label: newFormTemplate.label,
+          value: newFormTemplate.templatePath,
+        });
+      });
+    });
+
+    return templates;
+  }
+
+  public getAccessibleFormStorageFolders(): LabelValuePair[] {
+    if (!Array.isArray(this.configuration.accessibleFormStorageFolders)) {
+      return [];
+    }
+
+    return this.configuration.accessibleFormStorageFolders.map((folder): LabelValuePair => {
+      return {
+        label: folder.label,
+        value: folder.value,
+      };
+    });
+  }
+
+  /**
+   * @throws 1477506508
+   */
+  public getAjaxEndpoint(endpointName: string): string {
+    assert(typeof this.configuration.endpoints[endpointName] !== 'undefined', 'Endpoint ' + endpointName + ' does not exist', 1477506508);
+
+    return this.configuration.endpoints[endpointName];
+  }
+
+  /**
+   * @throws 1475942618
+   */
+  public run(): FormManager {
+    if (this.isRunning) {
+      throw 'You can not run the app twice (1475942618)';
+    }
+
+    this.bootstrap();
+    this.isRunning = true;
+    return this;
+  }
+
+  /**
+   * @throws 1475942906
+   */
+  private viewSetup(): void {
+    assert('function' === typeof this.viewModel.bootstrap, 'The view model does not implement the method "bootstrap"', 1475942906);
+    this.viewModel.bootstrap(this);
+  }
+
+  /**
+   * @throws 1477506504
+   */
+  private bootstrap(): void {
+    this.configuration = this.configuration || {};
+    assert('object' === typeof this.configuration.endpoints, 'Invalid parameter "endpoints"', 1477506504);
+    this.viewSetup();
+  }
+}
+
+let formManagerInstance: FormManager = null;
+/**
+ * Return a singleton instance of a "FormManager" object.
+ */
+export function getInstance(
+  configuration: FormManagerConfiguration,
+  viewModel: ViewModel
+): FormManager {
+  if (formManagerInstance === null) {
+    formManagerInstance = new FormManager(configuration, viewModel);
+  }
+  return formManagerInstance;
+}

package/form/backend/helper.ts

@@ -0,0 +1,60 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+import { loadModule, type JavaScriptItemPayload } from '@typo3/core/java-script-item-processor';
+import DocumentService from '@typo3/core/document-service';
+
+interface ModuleRequirements {
+  app: JavaScriptItemPayload;
+  viewModel: JavaScriptItemPayload;
+  mediator?: JavaScriptItemPayload;
+}
+
+/**
+ * @exports @typo3/form/backend/helper
+ */
+export class Helper {
+  public static dispatchFormEditor(requirements: ModuleRequirements, options: any): void {
+    DocumentService.ready().then((): void => {
+      Promise.all([
+        loadModule(requirements.app),
+        loadModule(requirements.mediator),
+        loadModule(requirements.viewModel),
+      ]).then((modules: [any, any, any]) =>
+        ((
+          app: typeof import('@typo3/form/backend/form-editor'),
+          mediator: typeof import('@typo3/form/backend/form-editor/mediator'),
+          viewModel: typeof import('@typo3/form/backend/form-editor/view-model')
+        ) => {
+          window.TYPO3.FORMEDITOR_APP = app.getInstance(options, mediator, viewModel).run();
+        })(...modules)
+      );
+    });
+  }
+
+  public static dispatchFormManager(requirements: ModuleRequirements, options: any): void {
+    DocumentService.ready().then((): void => {
+      Promise.all([
+        loadModule(requirements.app),
+        loadModule(requirements.viewModel)
+      ]).then((modules: [any, any]) =>
+        ((
+          formManager: typeof import('@typo3/form/backend/form-manager'),
+          viewModel: typeof import('@typo3/form/backend/form-manager/view-model')
+        ) => {
+          window.TYPO3.FORMMANAGER_APP = formManager.getInstance(options, viewModel).run();
+        })(...modules)
+      );
+    });
+  }
+}

package/form/frontend/date-picker.ts

@@ -0,0 +1,38 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * DatePicker initialization used by DatePickerViewHelper.
+ *
+ * Note: Requires jQuery UI to be included on the page.
+ *
+ * Scope: frontend
+ */
+interface JQuery { // eslint-disable-line @typescript-eslint/no-unused-vars
+  datepicker(optionsOrInstruction: object | string, value?: string): JQuery;
+}
+if (typeof $ !== 'undefined') { // eslint-disable-line no-restricted-globals
+  $(function(jQuery: JQueryStatic) { // eslint-disable-line no-restricted-globals
+    jQuery('input[data-t3-form-datepicker]').each(function (this: HTMLInputElement) {
+      jQuery(this).datepicker({
+        dateFormat: jQuery(this).data('format')
+      }).on('keydown', function(this: HTMLInputElement, e: JQueryEventObject) {
+        // By using "backspace" or "delete", you can clear the datepicker again.
+        if (e.keyCode === 8 || e.keyCode === 46) {
+          e.preventDefault();
+          jQuery(this).datepicker('setDate', '');
+        }
+      });
+    });
+  });
+}

package/frontend/default_frontend.ts

@@ -0,0 +1,82 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+(function() {
+  function decryptCharcode(charCode: number, start: number, end: number, offset: number): string {
+    charCode = charCode + offset;
+    if (offset > 0 && charCode > end) {
+      charCode = start + (charCode - end - 1);
+    } else if (offset < 0 && charCode < start) {
+      charCode = end - (start - charCode - 1);
+    }
+    return String.fromCharCode(charCode);
+  }
+
+  function decryptString(value: string, offset: number): string {
+    let result = '';
+    for (let i = 0; i < value.length; i++) {
+      const charCode = value.charCodeAt(i);
+      if (charCode >= 0x2B && charCode <= 0x3A) {
+        result += decryptCharcode(charCode,0x2B,0x3A,offset);	/* 0-9 . , - + / : */
+      } else if (charCode >= 0x40 && charCode <= 0x5A) {
+        result += decryptCharcode(charCode,0x40,0x5A,offset);	/* A-Z @ */
+      } else if (charCode >= 0x61 && charCode <= 0x7A) {
+        result += decryptCharcode(charCode,0x61,0x7A,offset);	/* a-z */
+      } else {
+        result += value.charAt(i);
+      }
+    }
+    return result;
+  }
+
+  function windowOpen(url: string, target: string | null, features: string | null): Window {
+    const windowRef = window.open(url, target, features);
+    if (windowRef) {
+      windowRef.focus();
+    }
+    return windowRef;
+  }
+
+  function delegateEvent(
+    event: string,
+    selector: string,
+    callback: (evt: Event, targetElement: HTMLElement) => void
+  ): void {
+    document.addEventListener(event, function(evt: Event) {
+      for (let node = evt.target as Node; node; node = node.parentNode !== document ? node.parentNode : null) {
+        if ('matches' in node) {
+          const targetElement = node as HTMLElement;
+          if (targetElement.matches(selector)) {
+            callback(evt, targetElement);
+          }
+        }
+      }
+    });
+  }
+
+  delegateEvent('click', 'a[data-mailto-token][data-mailto-vector]', function(evt: Event, evtTarget: HTMLElement) {
+    evt.preventDefault();
+    const dataset = evtTarget.dataset;
+    const value = dataset.mailtoToken;
+    const offset = parseInt(dataset.mailtoVector, 10) * -1;
+    document.location.href = decryptString(value, offset);
+  });
+
+  delegateEvent('click', 'a[data-window-url]', function(evt: Event, evtTarget: HTMLElement) {
+    evt.preventDefault();
+    const dataset = evtTarget.dataset;
+    const url = dataset.windowUrl;
+    const target = dataset.windowTarget || null;
+    const features = dataset.windowFeatures || null;
+    windowOpen(url, target, features);
+  });
+})();

package/impexp/context-menu-actions.ts

@@ -0,0 +1,50 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+/**
+ * Module: @typo3/impexp/context-menu-actions
+ *
+ * JavaScript to handle import/export actions from context menu
+ * @exports @typo3/impexp/context-menu-actions
+ */
+class ContextMenuActions {
+
+  public exportT3d(table: string, uid: number, dataset: DOMStringMap): void {
+    const actionUrl: string = dataset.actionUrl;
+    if (table === 'pages') {
+      top.TYPO3.Backend.ContentContainer.setUrl(
+        actionUrl +
+        '&id=' + uid +
+        '&tx_impexp[pagetree][id]=' + uid +
+        '&tx_impexp[pagetree][levels]=0' +
+        '&tx_impexp[pagetree][tables][]=_ALL',
+      );
+    } else {
+      top.TYPO3.Backend.ContentContainer.setUrl(
+        actionUrl +
+        '&tx_impexp[record][]=' + table + ':' + uid +
+        '&tx_impexp[external_ref][tables][]=_ALL',
+      );
+    }
+  }
+
+  public importT3d(table: string, uid: number, dataset: DOMStringMap): void {
+    const actionUrl: string = dataset.actionUrl;
+    top.TYPO3.Backend.ContentContainer.setUrl(
+      actionUrl + '&id=' + uid + '&table=' + table,
+    );
+  }
+}
+
+
+export default new ContextMenuActions();

package/impexp/import-export.ts

@@ -0,0 +1,62 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+import Modal from '@typo3/backend/modal';
+import RegularEvent from '@typo3/core/event/regular-event';
+import DocumentService from '@typo3/core/document-service';
+
+/**
+ * Module: @typo3/impexp/import-export
+ * JavaScript to handle confirm windows in the Import/Export module
+ * @exports @typo3/impexp/import-export
+ */
+class ImportExport {
+  constructor() {
+    DocumentService.ready().then((): void => this.registerEvents());
+  }
+
+  private registerEvents(): void {
+    new RegularEvent('click', this.triggerConfirmation).delegateTo(document, '.t3js-confirm-trigger');
+
+    const toggleDisabledControl = document.querySelector('.t3js-impexp-toggledisabled');
+    if (toggleDisabledControl !== null) {
+      new RegularEvent('click', this.toggleDisabled).bindTo(toggleDisabledControl);
+    }
+  }
+
+  private triggerConfirmation(this: HTMLButtonElement): void {
+    const modal = Modal.confirm(this.dataset.title, this.dataset.message);
+    modal.addEventListener('confirm.button.ok', (): void => {
+      const submitTrigger: HTMLInputElement = document.getElementById('t3js-submit-field') as HTMLInputElement;
+      submitTrigger.name = this.name;
+      submitTrigger.closest('form').submit();
+
+      modal.hideModal();
+    });
+    modal.addEventListener('confirm.button.cancel', (): void => {
+      modal.hideModal();
+    });
+  }
+
+  private toggleDisabled() {
+    const checkboxes: NodeListOf<HTMLInputElement> = document.querySelectorAll('table.t3js-impexp-preview tr[data-active="hidden"] input.t3js-exclude-checkbox');
+    if (checkboxes.length > 0) {
+      const firstCheckbox = checkboxes.item(0);
+      checkboxes.forEach((element: HTMLInputElement): void => {
+        element.checked = !firstCheckbox.checked;
+      });
+    }
+  }
+}
+
+export default new ImportExport();

package/indexed-search/pagination.ts

@@ -0,0 +1,26 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+(function() {
+  document.addEventListener('click', (evt: MouseEvent) => {
+    const target = evt.target as HTMLElement|null;
+    if (!target.classList.contains('tx-indexedsearch-page-selector')) {
+      return;
+    }
+    evt.preventDefault();
+
+    const data = target.dataset;
+    (document.getElementById(data.prefix + '_pointer') as HTMLInputElement).value = data.pointer;
+    (document.getElementById(data.prefix + '_freeIndexUid') as HTMLInputElement).value = data.freeIndexUid;
+    document.forms.namedItem(data.prefix).submit();
+  });
+})();

package/indexed-search/statistics.ts

@@ -0,0 +1,50 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+import SortableTable from '@typo3/backend/sortable-table';
+
+/**
+ * Module: @typo3/indexed-search/statistics
+ *
+ * Functionality for the indexed search statistics module
+ *
+ * @example
+ * <typo3-indexed-search-statistics>
+ *   ...
+ * </typo3-indexed-search-statistics>
+ *
+ * This is based on W3C custom elements ("web components") specification, see
+ * https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements
+ */
+class IndexedSearchStatistics extends HTMLElement {
+  constructor() {
+    super();
+    const slot: HTMLSlotElement = document.createElement('slot');
+    slot.addEventListener('slotchange', () => this.initializeWordList(slot));
+    this.attachShadow({ mode: 'open' }).append(slot);
+  }
+
+  public connectedCallback(): void {
+    this.initializeWordList(this.shadowRoot.querySelector('slot'));
+  }
+
+  private initializeWordList(slot: HTMLSlotElement): void {
+    const wordList: HTMLTableElement = (slot.assignedElements()[0].children[0] ?? null) as HTMLTableElement|null;
+    if (wordList === null || wordList.tagName.toLowerCase() !== 'table') {
+      throw new Error(`Sortable table could not be initialized. Expected <table> child name, but found: ${wordList}`);
+    }
+    new SortableTable(wordList);
+  }
+}
+
+window.customElements.define('typo3-indexed-search-statistics', IndexedSearchStatistics);

package/info/translation-status.ts

@@ -0,0 +1,48 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+import RegularEvent from '@typo3/core/event/regular-event';
+import Icons from '@typo3/backend/icons';
+
+/**
+ * Module: @typo3/info/translation-status
+ */
+class TranslationStatus {
+  constructor() {
+    this.registerEvents();
+  }
+
+  private registerEvents(): void {
+    new RegularEvent('click', this.toggleNewButton).delegateTo(document, 'input[type="checkbox"][data-lang]');
+  }
+
+  private async toggleNewButton(this: HTMLInputElement): Promise<void> {
+    const relatedCreationButton = document.querySelector(`.t3js-language-new[data-lang="${this.dataset.lang}"]`) as HTMLAnchorElement;
+    const relatedCreationButtonIcon = relatedCreationButton.querySelector('.t3js-icon') as HTMLSpanElement;
+    const selectedButtons = document.querySelectorAll(`input[type="checkbox"][data-lang="${this.dataset.lang}"]:checked`);
+    const actionUrl = new URL(location.origin + relatedCreationButton.dataset.editUrl);
+    selectedButtons.forEach((element: HTMLInputElement): void => {
+      actionUrl.searchParams.set(`cmd[pages][${element.dataset.uid}][localize]`, this.dataset.lang);
+    });
+
+    const disableCreationButton = selectedButtons.length === 0;
+
+    relatedCreationButton.href = actionUrl.toString();
+    relatedCreationButton.classList.toggle('disabled', disableCreationButton);
+
+    const newIcon = await Icons.getIcon(relatedCreationButtonIcon.dataset.identifier, Icons.sizes.small, null, disableCreationButton ? Icons.states.disabled : Icons.states.default);
+    relatedCreationButtonIcon.replaceWith(document.createRange().createContextualFragment(newIcon));
+  }
+}
+
+export default new TranslationStatus();

package/install/ajax/ajax-queue.ts

@@ -0,0 +1,83 @@
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+import AjaxRequest from '@typo3/core/ajax/ajax-request';
+import type { AjaxResponse } from '@typo3/core/ajax/ajax-response';
+
+interface Payload {
+  url: string;
+  method?: string;
+  data?: { [key: string]: any},
+  onfulfilled: (value: AjaxResponse) => Promise<void>;
+  onrejected: (reason: string) => void;
+  finally?: () => void;
+}
+
+/**
+ * Module: @typo3/install/module/ajax-queue
+ */
+class AjaxQueue {
+  private requests: Array<AjaxRequest> = [];
+  private requestCount: number = 0;
+  private readonly threshold: number = 5;
+  private queue: Array<Payload> = [];
+
+  public add(payload: Payload): void {
+    this.queue.push(payload);
+    this.handleNext();
+  }
+
+  public flush(): void {
+    this.queue = [];
+    this.requests.forEach((request: AjaxRequest) => request.abort());
+    this.requests = [];
+  }
+
+  private handleNext(): void {
+    if (this.queue.length > 0 && this.requestCount < this.threshold) {
+      this.incrementRequestCount();
+      this.sendRequest(this.queue.shift()).finally((): void => {
+        this.decrementRequestCount();
+        this.handleNext();
+      });
+    }
+  }
+
+  private async sendRequest(payload: Payload): Promise<void> {
+    const request = new AjaxRequest(payload.url);
+    let response: Promise<AjaxResponse>;
+    if (typeof payload.method !== 'undefined' && payload.method.toUpperCase() === 'POST') {
+      response = request.post(payload.data);
+    } else {
+      response = request.withQueryArguments(payload.data || {}).get();
+    }
+
+    this.requests.push(request);
+    return response.then(payload.onfulfilled, payload.onrejected).then((): void => {
+      const idx = this.requests.indexOf(request);
+      this.requests.splice(idx, 1);
+    });
+  }
+
+  private incrementRequestCount(): void {
+    this.requestCount++;
+  }
+
+  private decrementRequestCount(): void {
+    if (this.requestCount > 0) {
+      this.requestCount--;
+    }
+  }
+}
+
+export default new AjaxQueue();

package/install/init-install.ts

@@ -0,0 +1,2 @@
+self.TYPO3 = <typeof TYPO3>{};
+import('@typo3/install/install');

package/install/init-installer.ts

@@ -0,0 +1,2 @@
+self.TYPO3 = <typeof TYPO3>{};
+import('@typo3/install/installer');