@types/gorilla-engine 1.0.0 → 1.1.0

gorilla-engine/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for Gorilla Engine (https://gorilla-engin
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gorilla-engine.
 
 ### Additional Details
- * Last updated: Mon, 16 Jan 2023 13:32:40 GMT
+ * Last updated: Mon, 08 May 2023 09:02:51 GMT
  * Dependencies: none
  * Global values: `GorillaEngine`
 

gorilla-engine/components/ComboBox.d.ts

@@ -16,6 +16,7 @@ declare namespace GorillaEngine.UI {
         cornerRadius: number;
         padding: ComboBoxPadding | number;
         checkmarkPadding: ComboBoxPadding;
+        textAlign: string;
     }
 
     interface ComboBoxProps extends Common, Bounds, Background, Clickable, Font {

gorilla-engine/components/Knob.d.ts

@@ -4,6 +4,7 @@ declare namespace GorillaEngine.UI {
         min: number;
         max: number;
         value: number;
+        stepSize: number;
     }
 
     interface Knob extends KnobProps {}

gorilla-engine/components/Label.d.ts

@@ -2,6 +2,7 @@ declare namespace GorillaEngine.UI {
     interface LabelProps extends Common, Bounds, Background, Font, Clickable {
         text: string | number;
         format: string;
+        multiLine: boolean;
     }
 
     /**

gorilla-engine/components/SliceEditor.d.ts

@@ -1,70 +1,104 @@
 declare namespace GorillaEngine.UI {
-    interface SliceStyle {
-        y: number;
+  interface SliceStyle {
+    y: number;
+    width: number;
+    height: number;
+    color: string;
+    image: string;
+  }
+
+  interface Modulation {
+    legacyCompatibility?: boolean;
+    color?: string;
+    visible?: boolean;
+    active?: boolean;
+    resolution?: any;
+    tooltip: {
+      enabled?: boolean;
+      text?: string;
+      font?: {
+        size?: number;
+        color: string;
+      }
+      color: string;
+      border: {
         width: number;
-        height: number;
         color: string;
-        image: string;
-    }
+        radius: number;
+      }
+    };
+    centerLine?: {
+      width?: number;
+      backgroundColor?: string;
+      visible?: boolean;
+    };
+    values: any;
+    centerValue: {
+      value?: number;
+      backgroundColor?: string;
+      visible?: boolean;
+    };
+    indication?: {
+      enabled?: boolean;
+      backgroundColor?: string;
+    };
+    setValues: (values: any) => void;
+  }
+  interface GridMeasure {
+    fractionOfBar: number;
+    showLabels?: boolean;
+    tickHeight: number;
+    font?: { size: number };
+  }
 
-    interface Modulation {
+  interface SliceEditorProps extends Common, Bounds, Background, Clickable {
+    slices: any;
+    audioLengthInSamples: number;
+    audioLengthInBeats: number;
+    minSliceSpacing: number;
+    canChangeSlices: boolean;
+    canAddSlices: boolean;
+    canRemoveSlices: boolean;
+    snapSlicesToGrid: boolean;
+    zoom: { start: number; end: number };
+    addModulation(modulation: Partial<Modulation>): Modulation;
+    grid: Partial<{
+      position: string;
+      height: number;
+      minTickSpacing: number;
+      minLabelSpacing: number;
+      enabled: boolean;
+      backgroundColor: string;
+      backgroundImage: string;
+      measures: GridMeasure[];
+      addMeasure(measure: GridMeasure): void;
+    }>;
+    sliceStyles: Partial<{
+      normal: Partial<SliceStyle>;
+      hover: Partial<SliceStyle>;
+      selected: Partial<SliceStyle>;
+    }>;
+    selectionAreaStyle: Partial<{
+      backgroundColor: string;
+      border: Partial<{
+        width: number;
+        radius: number;
         color: string;
-        tooltip: string;
-        centerLine: any;
-        values: any;
-        centerValue: number;
-    }
-    interface GridMeasure {
-        fractionOfBar: number;
-        showLabels: boolean;
-        tickHeight: number;
-        font: string;
-    }
-
-    interface SliceEditorProps extends Common, Bounds, Background, Clickable {
-        slices: any;
-        audioLengthInSamples: number;
-        audioLengthInBeats: number;
-        canChangeSlices: boolean;
-        canAddSlices: boolean;
-        canRemoveSlices: boolean;
-        snapSlicesToGrid: boolean;
-        zoom: { start: number; end: number };
-        addModulation(modulation: Partial<Modulation>): void;
-        grid: Partial<{
-            position: string;
-            height: number;
-            minTickSpacing: number;
-            enabled: boolean;
-            backgroundColor: string;
-            backgroundImage: string;
-            measures: GridMeasure[];
-            addMeasure(measure: GridMeasure): void;
-        }>;
-        sliceStyles: Partial<{
-            normal: Partial<SliceStyle>;
-            hover: Partial<SliceStyle>;
-            selected: Partial<SliceStyle>;
-        }>;
-        selectionAreaStyle: Partial<{
-            backgroundColor: string;
-            border: Partial<{
-                width: number;
-                radius: number;
-                color: string;
-            }>;
-        }>;
-        addMarker(marker: any): void;
-        addSlice(slice: any): void;
-        clearSlices(): void;
-        setZoom: (start: number, end: number) => void;
-        mappedSampleChanged(): void;
-        modulations: Modulation[];
-    }
+      }>;
+    }>;
+    addMarker(marker: any): void;
+    addSlice(slice: any): void;
+    removeSlice(slice: any): void;
+    getSlicesForZoneModule(): any[];
+    clearSlices(): void;
+    setZoom: (start: number, end: number) => void;
+    mappedSampleChanged(): void;
+    modulations: Modulation[];
+  }
 
-    interface SliceEditor extends SliceEditorProps {}
+  interface SliceEditor extends SliceEditorProps { }
 
-    class SliceEditor extends Component {
-        constructor(options: Partial<SliceEditorProps>);
-    }
+  class SliceEditor extends Component {
+    constructor(options: Partial<SliceEditorProps>);
+  }
 }

gorilla-engine/components/TextBox.d.ts

@@ -6,7 +6,7 @@ declare namespace GorillaEngine.UI {
         placeHolderColor: string;
         highlightTextColor: string;
         highlightColor: string;
-        cartColor: string;
+        caretColor: string;
         maxLength: number;
         passwordCharacter: string;
         multiLine: boolean;
@@ -16,7 +16,9 @@ declare namespace GorillaEngine.UI {
         maxValue: number;
     }
 
-    interface TextBox extends TextBoxProps {}
+    interface TextBox extends TextBoxProps {
+      grabKeyboardFocus(): void;
+    }
 
     class TextBox extends Component {
         constructor(props: Partial<TextBoxProps>);

gorilla-engine/components/Waveform.d.ts

@@ -1,48 +1,58 @@
 declare namespace GorillaEngine.UI {
-    interface WaveformDragZone {
-        x: number;
-        y: number;
-        x2: number;
-        y2: number;
-        leftHandleImage: number;
-        rightHandleImage: number;
-        backgroundColor: string;
-        overlayColor: string;
-        leftHandleWidth: number;
-        rightHandleWidth: number;
-        rightHandleHeight: number;
-        canResize: boolean;
-        canPan: boolean;
-        enabled: boolean;
-        markers: Partial<{
-            leftHandleImage: number;
-            rightHandleImage: number;
-            backgroundColor: string;
-            leftHandleWidth: number;
-            leftHandleHeight: number;
-            rightHandleWidth: number;
-            rightHandleHeight: number;
-            canResize: boolean;
-        }>;
-    }
+  interface WaveformDragZone {
+    x: number;
+    y: number;
+    x2: number;
+    y2: number;
+    leftHandleImage: string;
+    rightHandleImage: string;
+    backgroundColor: string;
+    overlayColor: string;
+    leftHandleWidth: number;
+    leftHandleHeight: number;
+    rightHandleWidth: number;
+    rightHandleHeight: number;
+    canResize: boolean;
+    canPan: boolean;
+    enabled: boolean;
+    bindings: any;
+  }
 
-    interface WaveformProps extends Common, Bounds, Background, Font, Clickable {
-        waveformColor: string;
-        gradientCenterColor: string;
-        gradientEndColor: string;
-        horizontalAxisColor: string;
-        waveformUnavailableText: string;
-        waveWidth: number;
-        waveHorizontalSapcing: number;
-        verticalPadding: number;
-        fitHeight: boolean;
-        paintCenterLine: boolean;
-        value: number;
-        dragzone: Partial<WaveformDragZone>;
-    }
+  interface WaveformMarker {
+    enabled: boolean;
+    x: number;
+    y: number;
+    x2: number;
+    y2: number;
+    leftHandleImage: string;
+    rightHandleImage: string;
+    backgroundColor: string;
+    leftHandleWidth: number;
+    leftHandleHeight: number;
+    rightHandleWidth: number;
+    rightHandleHeight: number;
+    canResize: boolean;
+  }
 
-    interface Waveform extends WaveformProps {}
-    class Waveform extends Component {
-        constructor(options: Partial<WaveformProps>);
-    }
+  interface WaveformProps extends Common, Bounds, Background, Font, Clickable {
+    waveformColor: string;
+    gradientCenterColor: string;
+    gradientEndColor: string;
+    horizontalAxisColor: string;
+    waveformUnavailableText: string;
+    waveWidth: number;
+    initialXOffset: number;
+    waveHorizontalSapcing: number;
+    verticalPadding: number;
+    fitHeight: boolean;
+    paintCenterLine: boolean;
+    value: number;
+    dragzone: Partial<WaveformDragZone>;
+    markers: Partial<WaveformMarker>;
+  }
+
+  interface Waveform extends WaveformProps { }
+  class Waveform extends Component {
+    constructor(options: Partial<WaveformProps>);
+  }
 }

gorilla-engine/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for Gorilla Engine 1.0
+// Type definitions for Gorilla Engine 1.1
 // Project: https://gorilla-engine.com
 // Definitions by: Julian Woodward <https://github.com/jhwoodward>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -36,66 +36,287 @@
 /// <reference path = "components/Waveform.d.ts" />
 
 declare namespace GorillaEngine {
+  /**
+   * Instrument parameter session persistence
+   */
+  interface InstrumentPropertyPersistence {
     /**
-     * Instrument parameter session persistence
-     */
-    interface InstrumentPropertyPersistence {
-        private: boolean;
-        showInHost: boolean;
-        saveInSession: boolean;
-        saveInPreset: boolean;
-    }
-    /**
-     * Instrument property
-     */
-    interface InstrumentProperty {
-        normValue: number;
-        value: number;
-        normValueAsync: number;
-        valueAsync: number;
-        defaultValue: number;
-        minValue: number;
-        maxValue: number;
-        resolution: number;
-        numSteps: number;
-        key: string;
-        name: string;
-        category: string;
-        label: string;
-        text: string;
-        unit: string;
-        steps: string[];
-        persistence: InstrumentPropertyPersistence;
-    }
-
-    /**
-     * Instrument
-     */
-    interface Instrument {
-        on(propName: string, handler: (normValue: number) => void): void;
-    }
-
-    /**
-     * Blob
-     */
-    interface Blob {
-        loadInstrument(name: string): Instrument;
-        getInstrumentNames(): string[];
-    }
-
-    function registerUncaughtUIExceptionCallback(handler: (err: Error) => void): void;
-    function getResourcePath(): string;
-    function getPluginName(): string;
-    function getManufacturerName(): string;
-    function loadBlob(blobPath: string): Blob;
-    function disposeInstrument(instrument: Instrument): void;
-    function setActiveInstrument(instrument: Instrument): void;
-    function setSessionSaveCallback(callback: any, instance: any): void;
-    function setSessionLoadCallback(callback: any, instance: any): void;
-    function getBuildInformation(): any;
-
-    namespace UI {
-        function loadUIfromYAML(ymlPath: string): void;
-        function getControlById(id: string): Component;
-    }
+     * Indicates that the parameter is not exposed to the host DAW, should not saved in a preset and should not be saved in the session.
+     */
+    private: boolean;
+    /**
+     * Indicates the the parameter is exposed to the host DAW.
+     */
+    showInHost: boolean;
+    /**
+     * Indicates that the parameter should be saved in the session.
+     */
+    saveInSession: boolean;
+    /**
+     * Indicates that the parameter should be saved into a preset.
+     */
+    saveInPreset: boolean;
+  }
+  /**
+   * Instrument property
+   */
+  interface InstrumentProperty {
+    /**
+     * A normalised representation of its value.
+     */
+    normValue: number;
+    /**
+     * Its actual value.
+     */
+    value: number;
+    normValueAsync: number;
+    valueAsync: number;
+    readonly defaultValue: number;
+    readonly minValue: number;
+    readonly maxValue: number;
+    readonly resolution: number;
+    /**
+     *  The number of its steps if it's a stepped parameter
+     */
+    readonly numSteps: number;
+    readonly key: string;
+    readonly name: string;
+    readonly category: string;
+    readonly label: string;
+    readonly text: string;
+    readonly unit: string;
+    /**
+     * Its steps if it's a stepped paramter
+     */
+    readonly steps: string[];
+    readonly persistence: InstrumentPropertyPersistence;
+  }
+
+  /**
+   * Instrument
+   */
+  interface Instrument {
+    on(propName: string, handler: (normValue: number) => void): void;
+    /**
+     * Method used to retrieve a serialised module from the Gorilla Engine.
+     *
+     * @param path The path to the module that should be retrieved.
+     * @returns The serialised module found at the given `path` or `false` if nothing was found.
+     */
+    getModuleAtPath(path: string): string | boolean;
+    /**
+     * Method used to determine if a value from the Gorilla Engine is a module.
+     *
+     * @param path The path to the value that should be determined.
+     * @returns `true` if the value found at the given `path` is a module or `false` if it's not or nothing was found.
+     */
+    isModuleAtPath(path: string): boolean;
+    /**
+     * Method used to retrieve a value from the Gorilla Engine.
+     *
+     * @param path The path to the value that should be retrieved.
+     * @returns The value found at the given `path` or `false` if nothing was found.
+     */
+    getValueAtPath(path: string): string | object | number | Int32Array | Float64Array | boolean;
+
+    /**
+     * Method used to set a string at a certain path in the engine.
+     * This method could for example be used to set a user sample to a certain Zone in the Gorilla Engine.
+     *
+     * @param path The path to the string that should be set.
+     * @param value The string that should be set at the given `path`.
+     * @returns `true` if the value has been set succcessfully or `false` otherwise.
+     */
+    setStringAtPath(path: string, value: string): boolean;
+
+    /**
+     * Method used to render a section of a sample to a waveform. Commonly used to source the `value` property of the `waveform` control.
+     *
+     * @param numPoints The number of points that the waveform should be rendered into.
+     * @param zoneId The id of the zone whichs sample should be rendered to a waveform.
+     * @param start A normalised value indicating from where in the sample waveform rendering should start.
+     * @param end A normalised value indicating  where in the sample waveform rendering should end.
+     * @returns The waveform of the sample found at `zoneId`.
+     */
+    getWaveformData(numPoints: number, zoneId: number, start: number, end: number): Uint8Array;
+
+    /**
+     * Method used to retrieve an array of integers from the Gorilla Engine.
+     *
+     * @param path The path to the array that should be retrieved.
+     * @returns The array of integers found at the given `path` or `false` if nothing was found.
+     */
+    getIntArrayAtPath(path: string): Int32Array | boolean;
+
+    /**
+     * Method used to set an array of integers at a ceterain path in the Gorilla Engine.
+     *
+     * @param path The path to the integer array that should be set.
+     * @param value The integer array that should be set at the given `path`.
+     * @returns `true` if the value has been set succcessfully or `false` otherwise.
+     */
+    setIntArrayAtPath(path: string, value: Int8Array | Uint8Array | Int16Array | Uint16Array | Int32Array | Uint32Array): boolean;
+
+    /**
+     * Method used to retrieve an array of doubles from the Gorilla Engine.
+     *
+     * @param path The path to the array that should be retrieved.
+     * @returns The array of doubles found at the given `path` or `false` if nothing was found.
+     */
+    getDoubleArrayAtPath(path: string): Float64Array | boolean;
+
+    /**
+     * Method used to set an array of floats or doubles at a ceterain path in the Gorilla Engine.
+     *
+     * @param path The path to the double array that should be set.
+     * @param value The float or double array that should be set at the given `path`.
+     * @returns `true` if the value has been set succcessfully or `false` otherwise.
+     */
+    setDoubleArrayAtPath(path: string, value: Float32Array | Float64Array): boolean;
+
+    /**
+     * Method used to retrieve a double from the Gorilla Engine.
+     *
+     * @param path The path to the double should be retrieved.
+     * @returns The double found at the given `path` or `false` if nothing was found.
+     */
+    getDoubleAtPath(path: string): number | boolean;
+
+    /**
+     * Method used to set a double at a ceterain path in the Gorilla Engine.
+     *
+     * @param path The path to the double that should be set.
+     * @param value The double that should be set at the given `path`.
+     * @returns `true` if the value has been set succcessfully or `false` otherwise.
+     */
+    setDoubleAtPath(path: string, value: number): boolean;
+
+    /**
+     * Method used to set an integer at a ceterain path in the Gorilla Engine.
+     *
+     * @param path The path to the integer that should be set.
+     * @param value The integer that should be set at the given `path`.
+     * @returns `true` if the value has been set succcessfully or `false` otherwise.
+     */
+    setIntAtPath(path: string, value: number): boolean;
+
+    /**
+     * Method used to retrieve an integer from the Gorilla Engine.
+     *
+     * @param path The path to the integer should be retrieved.
+     * @returns The integer found at the given `path` or `false` if nothing was found.
+     */
+    getIntAtPath(path: string): number | boolean;
+
+    /**
+     * Method used to insert a Gorilla Engine module at a given path.
+     * Attempting to set a variable-length module array entry greater than the current length of the array
+     * will fail (for example, to set `Groups/2` the groups `0` and `1` must exist). Setting a module always inserts
+     * the module at the speficied index while other value types overwrite the value at the index.
+     * To replace a module at a `path` use {@link Instrument#removeModuleAtPath} prior to inserting the new module.
+     *
+     * @param path The path at which the module should be inserted.
+     * @param value A Gorilla Enginge module serialised to JSON that should be set at the given `path`.
+     * @returns `true` if the module has been inserted succcessfully or `false` otherwise.
+     */
+    insertModuleAtPath(path: string, value: string): boolean;
+
+    /**
+     * Method used to remove a module at a given `path`.
+     *
+     * @param path The path to the module that should be removed.
+     * @returns `true` if the module has been removed succcessfully or `false` otherwise.
+     */
+    removeModuleAtPath(path: string): boolean;
+
+    /**
+     * Method used to set a normalised double at a ceterain path in the Gorilla Engine.
+     *
+     * @param path The path to the normalised double that should be set.
+     * @param value The normalised double that should be set at the given `path`.
+     * @returns `true` if the value has been set succcessfully or `false` otherwise.
+     */
+    setNormalisedDoubleAtPath(path: string, value: number): boolean;
+
+    /**
+     * Method used to retrieve a normalised double from the Gorilla Engine.
+     *
+     * @param path The path to the normalised double should be retrieved.
+     * @returns The normalised double found at the given `path` or `false` if nothing was found.
+     */
+    getNormalisedDoubleAtPath(): number | boolean;
+
+    /**
+     * Method used to retrieve MIDI data from the first instrument script that implements `on midi_drag`
+     *
+     * @returns Array of Midi Events
+     */
+    getMidiDragData(): Array<{ status: any, data0: any, data1: any, tickAbsolute: any }>;
+
+    /**
+     * Method used to send a `note on` MIDI event to the Gorilla Engine.
+     *
+     * @param key The musical key that should be triggered. The key is expected to be between `0` and `127`.
+     * @param velocity The velocity that the key should be triggerd with. The velocity is expected to be between `0` and `127`.
+     */
+    noteOn(key: number, velocity: number): void;
+
+    /**
+     * Method used to send a `note off` MIDI event to the Gorilla Engine.
+     *
+     * @param key The musical key that should be untriggered. The key is expected to be between `0` and `127`.
+     */
+    noteOff(ke: number): void;
+
+    /**
+     * Method used to stringify a given `value` at a certain `path` in the Gorilla Engine.
+     * This is useful to get a label string for parameters in the Gorilla Engine.
+     * The value is denormalised according to the scale of the parameter found at `path` and
+     * the parameter’s unit is appended to the string accordingly.
+     *
+     * @param path The path at which the value should be stringified.
+     * @param value A value that should be stringified at the given `path`.
+     * @returns `false` if the value could not be stringified or the given `value` as a `string`.
+     */
+    valueToStringAtPath(path: string, value: number): boolean | string;
+  }
+
+  interface Blob {
+    loadInstrument(name: string): Instrument;
+    getInstrumentNames(): string[];
+  }
+
+  interface PreviewPlayer {
+    on(eventName: string, callback: any): void;
+  }
+
+  function registerUncaughtUIExceptionCallback(handler: (err: Error) => void): void;
+  function getResourcePath(): string;
+  function getPluginName(): string;
+  function getManufacturerName(): string;
+  function loadBlob(blobPath: string): Blob;
+  function disposeInstrument(instrument: Instrument): void;
+  function setActiveInstrument(instrument: Instrument): void;
+  function setSessionSaveCallback(callback: any, instance: any): void;
+  function setSessionLoadCallback(callback: any, instance: any): void;
+  function getBuildInformation(): any;
+  function openURLinBrowser(path: string): void;
+  function getPluginMM(v: boolean): void;
+  function getPluginAE(v: boolean): void;
+  function getPreviewPlayer(): PreviewPlayer;
+  function openFileChooser(config: {
+    allowMultiple?: boolean,
+    browseDirectory?: boolean,
+    saveDialog?: boolean,
+    warnOnOverwrite?: boolean,
+    hint?: string,
+    allowedExtensions?: string,
+    defaultLocation?: string,
+  }): void;
+  let sessionSaveLoadCallbackTimeoutMs: number;
+
+  namespace UI {
+    function loadUIfromYAML(ymlPath: string): void;
+    function getControlById(id: string): Component;
+  }
 }

gorilla-engine/interfaces/Background.d.ts

@@ -4,9 +4,9 @@ declare namespace GorillaEngine.UI {
         backgroundColor: string;
         cornerRadius: number;
         border: {
-            width: number;
-            color: string;
-            focusColor: string;
+            width?: number;
+            color?: string;
+            focusColor?: string;
         };
     }
 }

gorilla-engine/interfaces/Skinnable.d.ts

@@ -3,7 +3,7 @@ declare namespace GorillaEngine.UI {
         filmstrip: {
             path: string;
             count: number;
-            direction: string;
+            direction?: string;
         };
         animation: LottieAnimation;
     }

gorilla-engine/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/gorilla-engine",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "TypeScript definitions for Gorilla Engine",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gorilla-engine",
     "license": "MIT",
@@ -20,6 +20,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "e54ee785bb3ed2374e79e767dd76f29c6effd5a33a81e05f15ff8b4bef5ce68f",
-    "typeScriptVersion": "4.2"
+    "typesPublisherContentHash": "12bdeb156f83ff2066403c0052eb859a376fa08c8ddca01cc957304ab133e2a7",
+    "typeScriptVersion": "4.3"
 }