typo3-typescript-sources 13.4.20

package/backend/enum/icon-types.ts

@@ -0,0 +1,31 @@
+/*
+ * 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!
+ */
+
+export enum Sizes {
+  default = 'default',
+  small = 'small',
+  medium = 'medium',
+  large = 'large',
+  mega = 'mega',
+  overlay = 'overlay',
+}
+
+export enum States {
+  default = 'default',
+  disabled = 'disabled',
+}
+
+export enum MarkupIdentifiers {
+  default = 'default',
+  inline = 'inline',
+}

package/backend/enum/key-types.ts

@@ -0,0 +1,27 @@
+/*
+ * 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!
+ */
+
+export enum KeyTypesEnum {
+  TAB = 'Tab',
+  ENTER = 'Enter',
+  ESCAPE = 'Escape',
+  SPACE = ' ',
+  END = 'End',
+  HOME = 'Home',
+  LEFT = 'ArrowLeft',
+  UP = 'ArrowUp',
+  RIGHT = 'ArrowRight',
+  DOWN = 'ArrowDown',
+  PAGE_UP = 'PageUp',
+  PAGE_DOWN = 'PageDown',
+}

package/backend/enum/severity.ts

@@ -0,0 +1,20 @@
+/*
+ * 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!
+ */
+
+export enum SeverityEnum {
+  notice = -2,
+  info = -1,
+  ok = 0,
+  warning = 1,
+  error = 2,
+}

package/backend/enum/viewport/scaffold-identifier.ts

@@ -0,0 +1,24 @@
+/*
+ * 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!
+ */
+
+export enum ScaffoldIdentifierEnum {
+  scaffold = '.t3js-scaffold',
+  header = '.t3js-scaffold-header',
+  moduleMenu = '.t3js-scaffold-modulemenu',
+  content = '.t3js-scaffold-content',
+  contentModule = '.t3js-scaffold-content-module',
+  contentModuleRouter = 'typo3-backend-module-router',
+  contentModuleIframe = '.t3js-scaffold-content-module-iframe',
+  contentNavigation = '.t3js-scaffold-content-navigation',
+  contentNavigationDataComponent = '.t3js-scaffold-content-navigation [data-component]',
+}

package/backend/event/client-request.ts

@@ -0,0 +1,25 @@
+/*
+ * 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 InteractionRequest from './interaction-request';
+
+class ClientRequest extends InteractionRequest {
+  public readonly clientEvent: any;
+
+  constructor(type: string, clientEvent: Event = null) {
+    super(type);
+    this.clientEvent = clientEvent;
+  }
+}
+
+export default ClientRequest;

package/backend/event/consumable.ts

@@ -0,0 +1,18 @@
+/*
+ * 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 type InteractionRequest from './interaction-request';
+
+export interface Consumable {
+  consume(interactionRequest: InteractionRequest): Promise<void> | null;
+}

package/backend/event/consumer-scope.ts

@@ -0,0 +1,54 @@
+/*
+ * 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 type InteractionRequest from './interaction-request';
+import type { Consumable } from './consumable';
+
+class ConsumerScope {
+  private consumers: Consumable[] = [];
+
+  public getConsumers(): Consumable[] {
+    return this.consumers;
+  }
+
+  public hasConsumer(consumer: Consumable): boolean {
+    return this.consumers.includes(consumer);
+  }
+
+  public attach(consumer: Consumable): void {
+    if (!this.hasConsumer(consumer)) {
+      this.consumers.push(consumer);
+    }
+  }
+
+  public detach(consumer: Consumable): void {
+    this.consumers = this.consumers.filter(
+      (currentConsumer: Consumable) => currentConsumer !== consumer,
+    );
+  }
+
+  public async invoke(request: InteractionRequest): Promise<void> {
+    const promises: Promise<void>[] = [];
+    this.consumers.forEach(
+      (consumer: Consumable) => {
+        const promise: Promise<void> = consumer.consume.call(consumer, request);
+        if (promise) {
+          promises.push(promise);
+        }
+      },
+    );
+    await Promise.all(promises);
+  }
+}
+
+export default new ConsumerScope();

package/backend/event/event-dispatcher.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!
+ */
+
+/**
+ * Module: @typo3/backend/event/event-dispatcher
+ */
+export class EventDispatcher {
+  static dispatchCustomEvent(name: string, detail: any = null, useTop: boolean = false): void {
+    const event = new CustomEvent(name, { detail: detail });
+    if (!useTop) {
+      document.dispatchEvent(event);
+    } else if (typeof top !== 'undefined') {
+      top.document.dispatchEvent(event);
+    }
+  }
+}

package/backend/event/interaction-request-assignment.ts

@@ -0,0 +1,24 @@
+/*
+ * 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 type InteractionRequest from './interaction-request';
+
+export interface PromiseControls<T> {
+  resolve: (v?: T) => void;
+  reject: (e?: unknown) => void;
+}
+
+export interface InteractionRequestAssignment {
+  request: InteractionRequest;
+  deferreds: PromiseControls<unknown>[];
+}

package/backend/event/interaction-request-map.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 type InteractionRequest from './interaction-request';
+import type { InteractionRequestAssignment, PromiseControls } from './interaction-request-assignment';
+
+class InteractionRequestMap {
+  private assignments: InteractionRequestAssignment[] = [];
+
+  public attachFor(request: InteractionRequest, deferred: PromiseControls<unknown>): void {
+    let targetAssignment: InteractionRequestAssignment = this.getFor(request);
+    if (targetAssignment === null) {
+      targetAssignment = { request, deferreds: [] };
+      this.assignments.push(targetAssignment);
+    }
+    targetAssignment.deferreds.push(deferred);
+  }
+
+  public detachFor(request: InteractionRequest): void {
+    const targetAssignment = this.getFor(request);
+    this.assignments = this.assignments.filter(
+      (assignment: InteractionRequestAssignment) => assignment === targetAssignment,
+    );
+  }
+
+  public getFor(triggerEvent: InteractionRequest): InteractionRequestAssignment | null {
+    let targetAssignment: InteractionRequestAssignment = null;
+    this.assignments.some(
+      (assignment: InteractionRequestAssignment) => {
+        if (assignment.request === triggerEvent) {
+          targetAssignment = assignment;
+          return true;
+        }
+        return false;
+      },
+    );
+    return targetAssignment;
+  }
+
+  public resolveFor(triggerEvent: InteractionRequest): boolean {
+    const targetAssignment = this.getFor(triggerEvent);
+    if (targetAssignment === null) {
+      return false;
+    }
+    targetAssignment.deferreds.forEach(
+      deferred => deferred.resolve(),
+    );
+    this.detachFor(triggerEvent);
+    return true;
+  }
+
+  public rejectFor(triggerEvent: InteractionRequest): boolean {
+    const targetAssignment = this.getFor(triggerEvent);
+    if (targetAssignment === null) {
+      return false;
+    }
+    targetAssignment.deferreds.forEach(
+      deferred => deferred.reject(),
+    );
+    this.detachFor(triggerEvent);
+    return true;
+  }
+}
+
+export default new InteractionRequestMap();

package/backend/event/interaction-request.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!
+ */
+
+class InteractionRequest {
+  public readonly type: string;
+  public readonly parentRequest: InteractionRequest;
+  protected processed: boolean = false;
+  protected processedData: any = null;
+
+  constructor(type: string, parentRequest: InteractionRequest = null) {
+    this.type = type;
+    this.parentRequest = parentRequest;
+  }
+
+  public get outerMostRequest(): InteractionRequest {
+    // eslint-disable-next-line @typescript-eslint/no-this-alias
+    let request: InteractionRequest = this;
+    while (request.parentRequest instanceof InteractionRequest) {
+      request = request.parentRequest;
+    }
+    return request;
+  }
+
+  public isProcessed(): boolean {
+    return this.processed;
+  }
+
+  public getProcessedData(): any {
+    return this.processedData;
+  }
+
+  public setProcessedData(processedData: any = null): void {
+    this.processed = true;
+    this.processedData = processedData;
+  }
+}
+
+export default InteractionRequest;

package/backend/event/trigger-request.ts

@@ -0,0 +1,56 @@
+/*
+ * 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 InteractionRequest from './interaction-request';
+
+class TriggerRequest extends InteractionRequest {
+  constructor(type: string, parentRequest: InteractionRequest = null) {
+    super(type, parentRequest);
+  }
+
+  public concerns(ancestorRequest: InteractionRequest): boolean {
+    if (this === ancestorRequest) {
+      return true;
+    }
+    for (
+      let parentRequest = this.parentRequest;
+      parentRequest instanceof InteractionRequest;
+      parentRequest = parentRequest.parentRequest
+    ) {
+      if (parentRequest === ancestorRequest) {
+        return true;
+      }
+    }
+    return false;
+  }
+
+  public concernsTypes(types: string[]): boolean {
+    if (types.includes(this.type)) {
+      return true;
+    }
+
+    for (
+      let parentRequest = this.parentRequest;
+      parentRequest instanceof InteractionRequest;
+      parentRequest = parentRequest.parentRequest
+    ) {
+      if (types.includes(parentRequest.type)) {
+        return true;
+      }
+    }
+
+    return false;
+  }
+}
+
+export default TriggerRequest;

package/backend/form/submit-interceptor.ts

@@ -0,0 +1,66 @@
+/*
+ * 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 Icons from '@typo3/backend/icons';
+
+export type PreSubmitCallback = (e: Event) => boolean;
+
+/**
+ * Module: @typo3/backend/form/submit-interceptor
+ */
+export default class SubmitInterceptor {
+  private isSubmitting: boolean = false;
+  private readonly preSubmitCallbacks: PreSubmitCallback[] = [];
+
+  constructor(form: HTMLFormElement) {
+    form.addEventListener('submit', this.submitHandler.bind(this));
+  }
+
+  public addPreSubmitCallback(callback: PreSubmitCallback): SubmitInterceptor {
+    if (typeof callback !== 'function') {
+      throw 'callback must be a function.';
+    }
+
+    this.preSubmitCallbacks.push(callback);
+
+    return this;
+  }
+
+  private submitHandler(e: SubmitEvent): void {
+    if (this.isSubmitting) {
+      return;
+    }
+
+    for (const callback of this.preSubmitCallbacks) {
+      const callbackResult = callback(e);
+      if (!callbackResult) {
+        e.preventDefault();
+        return;
+      }
+    }
+
+    this.isSubmitting = true;
+
+    if (e.submitter !== null) {
+      if (e.submitter instanceof HTMLInputElement || e.submitter instanceof HTMLButtonElement) {
+        e.submitter.disabled = true;
+      }
+      Icons.getIcon('spinner-circle', Icons.sizes.small).then((markup: string): void => {
+        e.submitter.replaceChild(document.createRange().createContextualFragment(markup), e.submitter.querySelector('.t3js-icon'));
+      }).catch(() => {
+        // Catch error in case the promise was not resolved
+        // e.g. loading a new page
+      });
+    }
+  }
+}