fiftyone.pipeline.core 4.4.98 → 4.4.100

package/types/pipelineBuilder.d.ts

@@ -22,19 +22,20 @@ declare class PipelineBuilder {
      * @param {boolean} settings.useSetHeaderProperties Whether to
      * automatically add the SetHeadersElement needed to request additional
      * HTTP headers from the client side. This is true by default.
-     * @param {typeof import('./javascriptbuilder').prototype.settings}
-     * settings.javascriptBuilderSettings The settings
-     * to pass to the JavaScriptBuilder. See JavaScriptBuilder class for details.
+     * @param {typeof import('./javascriptbuilder').prototype.settings} settings.javascriptBuilderSettings
+     * The settings to pass to the JavaScriptBuilder.
+     * See JavaScriptBuilder class for details.
      */
     constructor(settings?: {
         addJavaScriptBuilder: boolean;
         useSetHeaderProperties: boolean;
-        javascriptBuilderSettings: typeof import('./javascriptbuilder').prototype.settings;
+        javascriptBuilderSettings: typeof import("./javascriptbuilder").prototype.settings;
     });
     /**
      * @type {FlowElement[]}
      */
     flowElements: FlowElement[];
+    dataFileUpdateService: any;
     addJavaScriptBuilder: boolean;
     javascriptBuilderSettings: {
         objName: string;
@@ -60,6 +61,13 @@ declare class PipelineBuilder {
      * @returns {Pipeline} the constructed pipeline
      */
     buildFromConfiguration(config: object): Pipeline;
+    /**
+     * Add required elements to an existing FlowElement array
+     *
+     * @param {FlowElement[]} flowElements array of elements to add to
+     * @returns {FlowElement[]} resulting array with required elements
+     */
+    addRequiredElements(flowElements: FlowElement[]): FlowElement[];
     /**
      * Internal function used to first check if the
      * JavaScript elements should be added to the pipeline
@@ -104,5 +112,5 @@ declare class PipelineBuilder {
 declare namespace PipelineBuilder {
     export { FlowElement };
 }
-type FlowElement = import('./flowElement');
 import Pipeline = require("./pipeline");
+type FlowElement = import("./flowElement");

package/types/sequenceElement.d.ts

@@ -1,4 +1,7 @@
 export = SequenceElement;
+/**
+ * @typedef {import('./flowData')} FlowData
+ */
 /**
  * The SequenceElement stores session data regarding requests
  * for client side JavaScript from the JavaScript created by a
@@ -8,5 +11,20 @@ export = SequenceElement;
  **/
 declare class SequenceElement extends FlowElement {
     constructor(...args: any[]);
+    evidenceKeyFilter: BasicListEvidenceKeyFilter;
+    /**
+     * Internal process function for the sequence element
+     * Checks if there is a session id and sequence number set
+     * if there is it increments the sequence number for that session
+     * if not it initialises both
+     *
+     * @param {FlowData} flowData flowData with the evidence in it
+     */
+    processInternal(flowData: FlowData): void;
+}
+declare namespace SequenceElement {
+    export { FlowData };
 }
 import FlowElement = require("./flowElement.js");
+import BasicListEvidenceKeyFilter = require("./basicListEvidenceKeyFilter");
+type FlowData = import("./flowData");

package/types/setHeadersElement.d.ts

@@ -10,11 +10,18 @@ export = SetHeadersElement;
  */
 declare class SetHeadersElement extends FlowElement {
     constructor(...args: any[]);
+    properties: {
+        responseheadersdictionary: {
+            name: string;
+            type: string;
+        };
+    };
     headers: object;
     /**
      * Get the name of the header which the property relates to.
-     * @param {string} propertyName: To get the header name from.
-     * @return {string} Header name.
+     *
+     * @param {string} propertyName To get the header name from.
+     * @returns {string} Header name.
      */
     getHeaderName(propertyName: string): string;
     /**
@@ -27,15 +34,23 @@ declare class SetHeadersElement extends FlowElement {
      *         [ 'device.SetHeaderBrowserAccept-CH',
      *           'device.SetHeaderPlatformAccept-CH',
      *           'device.SetHeaderHardwareAccept-CH' ] } }
-     * @param {Pipeline} pipeline: The pipeline instance to get the properties from.
-     * @return {object} Collection of headers which can be set in the response.
+     *
+     * @param {Pipeline} pipeline The pipeline instance to get the properties from.
+     * @returns {object} Collection of headers which can be set in the response.
      */
     constructHeaders(pipeline: Pipeline): object;
+    /**
+     * Add the response header dictionary to the FlowData.
+     *
+     * @param {FlowData} flowData the FlowData being processed
+     */
+    processInternal(flowData: FlowData): void;
     /**
      * Get response headers (e.g. Accept-CH)
-     * @param {FlowData} flowData: A processed FlowData instance to get the response header values
+     *
+     * @param {FlowData} flowData A processed FlowData instance to get the response header values
      * from.
-     * @return {object} A dictionary of response header names with their values if they are not
+     * @returns {object} A dictionary of response header names with their values if they are not
      * null
      */
     getResponseHeaders(flowData: FlowData): object;
@@ -43,10 +58,11 @@ declare class SetHeadersElement extends FlowElement {
      * Try to get the value for the given element and property.
      * If the value cannot be found or is null/unknown, then undefined
      * is returned.
-     * @param {FlowData} flowData: A processed FlowData instance to get the value from.
-     * @param {string} elementKey: Key for the element data to get the value from.
-     * @param {string} propertyKey: Name of the property to get the value for.
-     * @return {string | undefined} value string or undefined.
+     *
+     * @param {FlowData} flowData A processed FlowData instance to get the value from.
+     * @param {string} elementKey Key for the element data to get the value from.
+     * @param {string} propertyKey Name of the property to get the value for.
+     * @returns {string | undefined} value string or undefined.
      */
     tryGetValue(flowData: FlowData, elementKey: string, propertyKey: string): string | undefined;
 }
@@ -54,5 +70,5 @@ declare namespace SetHeadersElement {
     export { Pipeline, FlowData };
 }
 import FlowElement = require("./flowElement.js");
-type Pipeline = import('./pipeline');
-type FlowData = import('./flowData');
+type Pipeline = import("./pipeline");
+type FlowData = import("./flowData");