noflo 1.4.2 → 1.5.0

package/lib/BasePort.js

@@ -26,6 +26,8 @@ const validTypes = [
 /**
  * @typedef {Object} BaseOptions - Options for configuring all types of ports
  * @property {string} [description='']
+ * @property {boolean} [addressable=false]
+ * @property {boolean} [buffered=false]
  * @property {string} [datatype='all']
  * @property {string} [schema=null]
  * @property {string} [type=null]
@@ -70,13 +72,16 @@ function handleOptions(options) {
     });
 }
 class BasePort extends events_1.EventEmitter {
+    /**
+     * @param {BaseOptions} options
+     */
     constructor(options) {
         super();
         // Options holds all options of the current port
         this.options = handleOptions(options);
         // Sockets list contains all currently attached
         // connections to the port
-        /** @type {Array<import("./InternalSocket").InternalSocket>} */
+        /** @type {Array<import("./InternalSocket").InternalSocket|void>} */
         this.sockets = [];
         // Name of the graph node this port is in
         /** @type {string|null} */
@@ -93,11 +98,18 @@ class BasePort extends events_1.EventEmitter {
         }
         return `${this.node} ${this.name.toUpperCase()}`;
     }
-    getDataType() { return this.options.datatype; }
+    /**
+     * @returns {string}
+     */
+    getDataType() { return this.options.datatype || 'all'; }
     getSchema() { return this.options.schema || null; }
     getDescription() { return this.options.description; }
+    /**
+     * @param {import("./InternalSocket").InternalSocket} socket
+     * @param {number|null} [index]
+     */
     attach(socket, index = null) {
-        let idx = index;
+        let idx = /** @type {number} */ (index);
         if (!this.isAddressable() || (index === null)) {
             idx = this.sockets.length;
         }
@@ -109,8 +121,14 @@ class BasePort extends events_1.EventEmitter {
         }
         this.emit('attach', socket);
     }
-    // eslint-disable-next-line class-methods-use-this,no-unused-vars
-    attachSocket(socket, index = null) { }
+    /**
+     * @param {import("./InternalSocket").InternalSocket} socket
+     * @param {number|null} [index]
+     */
+    attachSocket(socket, index = null) { } // eslint-disable-line class-methods-use-this,no-unused-vars,max-len
+    /**
+     * @param {import("./InternalSocket").InternalSocket} socket
+     */
     detach(socket) {
         const index = this.sockets.indexOf(socket);
         if (index === -1) {
@@ -141,6 +159,10 @@ class BasePort extends events_1.EventEmitter {
         }
         return false;
     }
+    /**
+     * @param {number|null} socketId
+     * @returns {boolean}
+     */
     isAttached(socketId = null) {
         if (this.isAddressable() && (socketId !== null)) {
             if (this.sockets[socketId]) {
@@ -163,6 +185,10 @@ class BasePort extends events_1.EventEmitter {
         }
         return attached;
     }
+    /**
+     * @param {number|null} socketId
+     * @returns {boolean}
+     */
     isConnected(socketId = null) {
         if (this.isAddressable()) {
             if (socketId === null) {
@@ -171,7 +197,9 @@ class BasePort extends events_1.EventEmitter {
             if (!this.sockets[socketId]) {
                 throw new Error(`${this.getId()}: Socket ${socketId} not available`);
             }
-            return this.sockets[socketId].isConnected();
+            // eslint-disable-next-line max-len
+            const socket = /** @type {import("./InternalSocket").InternalSocket} */ (this.sockets[socketId]);
+            return socket.isConnected();
         }
         let connected = false;
         this.sockets.forEach((socket) => {

package/lib/Component.d.ts

@@ -212,11 +212,11 @@ export type ProcessResult = {
     __bracketClosingAfter?: BracketContext[];
 };
 import { EventEmitter } from "events";
-import { InPorts } from "./Ports";
-import { OutPorts } from "./Ports";
-import InPort from "./InPort";
-import OutPort from "./OutPort";
-import IP from "./IP";
-import ProcessInput from "./ProcessInput";
-import ProcessOutput from "./ProcessOutput";
-import ProcessContext from "./ProcessContext";
+import { InPorts } from "./Ports.js";
+import { OutPorts } from "./Ports.js";
+import InPort from "./InPort.js";
+import OutPort from "./OutPort.js";
+import IP from "./IP.js";
+import ProcessInput from "./ProcessInput.js";
+import ProcessOutput from "./ProcessOutput.js";
+import ProcessContext from "./ProcessContext.js";

package/lib/Component.js

@@ -12,14 +12,17 @@ exports.Component = void 0;
 */
 const events_1 = require("events");
 const debug_1 = require("debug");
-const Ports_1 = require("./Ports");
-const Platform_1 = require("./Platform");
-const ProcessContext_1 = require("./ProcessContext");
-const ProcessInput_1 = require("./ProcessInput");
-const ProcessOutput_1 = require("./ProcessOutput");
-const debugComponent = debug_1.default('noflo:component');
-const debugBrackets = debug_1.default('noflo:component:brackets');
-const debugSend = debug_1.default('noflo:component:send');
+const Ports_js_1 = require("./Ports.js");
+const Platform_js_1 = require("./Platform.js");
+const InPort_js_1 = require("./InPort.js"); // eslint-disable-line no-unused-vars
+const OutPort_js_1 = require("./OutPort.js"); // eslint-disable-line no-unused-vars
+const ProcessContext_js_1 = require("./ProcessContext.js");
+const ProcessInput_js_1 = require("./ProcessInput.js");
+const ProcessOutput_js_1 = require("./ProcessOutput.js");
+const IP_js_1 = require("./IP.js"); // eslint-disable-line no-unused-vars
+const debugComponent = (0, debug_1.default)('noflo:component');
+const debugBrackets = (0, debug_1.default)('noflo:component:brackets');
+const debugSend = (0, debug_1.default)('noflo:component:send');
 /**
  * @callback ProcessingFunction
  * @param {ProcessInput} input
@@ -66,11 +69,11 @@ class Component extends events_1.EventEmitter {
         if (!opts.inPorts) {
             opts.inPorts = {};
         }
-        if (opts.inPorts instanceof Ports_1.InPorts) {
+        if (opts.inPorts instanceof Ports_js_1.InPorts) {
             this.inPorts = opts.inPorts;
         }
         else {
-            this.inPorts = new Ports_1.InPorts(opts.inPorts);
+            this.inPorts = new Ports_js_1.InPorts(opts.inPorts);
         }
         // Prepare outports, if any were given in opts.
         // They can also be set up imperatively after component
@@ -79,11 +82,11 @@ class Component extends events_1.EventEmitter {
         if (!opts.outPorts) {
             opts.outPorts = {};
         }
-        if (opts.outPorts instanceof Ports_1.OutPorts) {
+        if (opts.outPorts instanceof Ports_js_1.OutPorts) {
             this.outPorts = opts.outPorts;
         }
         else {
-            this.outPorts = new Ports_1.OutPorts(opts.outPorts);
+            this.outPorts = new Ports_js_1.OutPorts(opts.outPorts);
         }
         // Set the default component icon and description
         this.icon = opts.icon ? opts.icon : '';
@@ -234,7 +237,7 @@ class Component extends events_1.EventEmitter {
             });
         }
         if (callback) {
-            Platform_1.deprecated('Providing a callback to Component.start is deprecated, use Promises');
+            (0, Platform_js_1.deprecated)('Providing a callback to Component.start is deprecated, use Promises');
             promise.then(() => {
                 callback(null);
             }, callback);
@@ -309,7 +312,7 @@ class Component extends events_1.EventEmitter {
             return Promise.resolve();
         });
         if (callback) {
-            Platform_1.deprecated('Providing a callback to Component.shutdown is deprecated, use Promises');
+            (0, Platform_js_1.deprecated)('Providing a callback to Component.shutdown is deprecated, use Promises');
             promise.then(() => {
                 callback(null);
             }, callback);
@@ -506,9 +509,9 @@ class Component extends events_1.EventEmitter {
             }
         }
         // Prepare the input/output pair
-        const context = new ProcessContext_1.default(ip, this, port, result);
-        const input = new ProcessInput_1.default(this.inPorts, context);
-        const output = new ProcessOutput_1.default(this.outPorts, context);
+        const context = new ProcessContext_js_1.default(ip, this, port, result);
+        const input = new ProcessInput_js_1.default(this.inPorts, context);
+        const output = new ProcessOutput_js_1.default(this.outPorts, context);
         try {
             // Call the processing function
             if (!this.handle) {
@@ -543,7 +546,7 @@ class Component extends events_1.EventEmitter {
      * @param {number|null} [idx]
      */
     getBracketContext(type, port, scope, idx = null) {
-        let { name, index } = Ports_1.normalizePortName(port);
+        let { name, index } = (0, Ports_js_1.normalizePortName)(port);
         if (idx != null) {
             index = `${idx}`;
         }
@@ -574,7 +577,7 @@ class Component extends events_1.EventEmitter {
     addToResult(result, port, packet, before = false) {
         const res = result;
         const ip = packet;
-        const { name, index } = Ports_1.normalizePortName(port);
+        const { name, index } = (0, Ports_js_1.normalizePortName)(port);
         const method = before ? 'unshift' : 'push';
         if (this.outPorts.ports[name].isAddressable()) {
             const idx = /** @type {number} */ (index ? parseInt(index, 10) : ip.index);
@@ -597,7 +600,7 @@ class Component extends events_1.EventEmitter {
     // pair.
     /** @private */
     getForwardableContexts(inport, outport, contexts) {
-        const { name, index } = Ports_1.normalizePortName(outport);
+        const { name, index } = (0, Ports_js_1.normalizePortName)(outport);
         const forwardable = [];
         contexts.forEach((ctx, idx) => {
             // No forwarding to this outport

package/lib/ComponentLoader.d.ts

@@ -73,13 +73,13 @@ export class ComponentLoader {
      */
     load(name: string, meta: import("fbp-graph/lib/Types").GraphNodeMetadata, cb?: any): Promise<import("./Component").Component>;
     /**
-     * @protected
+     * Creates an instance of a component.
      * @param {string} name
      * @param {ComponentDefinitionWithoutGraph} component
      * @param {import("fbp-graph/lib/Types").GraphNodeMetadata} metadata
      * @returns {Promise<import("./Component").Component>}
      */
-    protected createComponent(name: string, component: ComponentDefinitionWithoutGraph, metadata: import("fbp-graph/lib/Types").GraphNodeMetadata): Promise<import("./Component").Component>;
+    createComponent(name: string, component: ComponentDefinitionWithoutGraph, metadata: import("fbp-graph/lib/Types").GraphNodeMetadata): Promise<import("./Component").Component>;
     /**
      * @param {import("fbp-graph").Graph|object|string} cPath
      * @returns {boolean}
@@ -171,7 +171,7 @@ export type ComponentFactory = (metadata?: import("fbp-graph/lib/Types").GraphNo
 export type ModuleComponent = {
     getComponent: ComponentFactory;
 };
-export type ComponentDefinition = string | Graph | ModuleComponent | ComponentFactory;
+export type ComponentDefinition = string | ModuleComponent | ComponentFactory | import("fbp-graph").Graph;
 export type ComponentDefinitionWithoutGraph = string | ModuleComponent | ComponentFactory;
 export type ComponentList = {
     [x: string]: ComponentDefinition;
@@ -190,4 +190,3 @@ export type ComponentLoaderOptions = {
     runtimes?: string[];
     manifest?: string;
 };
-import { Graph } from "fbp-graph";

package/lib/ComponentLoader.js

@@ -11,8 +11,8 @@ exports.ComponentLoader = void 0;
     import/prefer-default-export,
 */
 const fbp_graph_1 = require("fbp-graph");
-const registerLoader = require("./loader/register");
-const Platform_1 = require("./Platform");
+const registerLoader = require("./loader/register.js");
+const Platform_js_1 = require("./Platform.js");
 /**
  * @callback ComponentFactory
  * @param {import("fbp-graph/lib/Types").GraphNodeMetadata} [metadata]
@@ -121,7 +121,7 @@ class ComponentLoader {
             this.components = {};
             this.ready = false;
             this.processing = new Promise((resolve, reject) => {
-                Platform_1.makeAsync(() => {
+                (0, Platform_js_1.makeAsync)(() => {
                     registerLoader.register(this, (err) => {
                         if (err) {
                             // We keep the failed promise here in this.processing
@@ -137,7 +137,7 @@ class ComponentLoader {
             promise = this.processing;
         }
         if (callback) {
-            Platform_1.deprecated('Providing a callback to ComponentLoader.listComponents is deprecated, use Promises');
+            (0, Platform_js_1.deprecated)('Providing a callback to ComponentLoader.listComponents is deprecated, use Promises');
             promise.then((components) => {
                 callback(null, components);
             }, callback);
@@ -206,23 +206,22 @@ class ComponentLoader {
                     inst.componentName = name;
                 }
                 if (inst.isLegacy()) {
-                    Platform_1.deprecated(`Component ${name} uses legacy NoFlo APIs. Please port to Process API`);
+                    (0, Platform_js_1.deprecated)(`Component ${name} uses legacy NoFlo APIs. Please port to Process API`);
                 }
                 this.setIcon(name, inst);
                 return inst;
             });
         });
         if (callback) {
-            Platform_1.deprecated('Providing a callback to ComponentLoader.load is deprecated, use Promises');
+            (0, Platform_js_1.deprecated)('Providing a callback to ComponentLoader.load is deprecated, use Promises');
             promise.then((instance) => {
                 callback(null, instance);
             }, callback);
         }
         return promise;
     }
-    // Creates an instance of a component.
     /**
-     * @protected
+     * Creates an instance of a component.
      * @param {string} name
      * @param {ComponentDefinitionWithoutGraph} component
      * @param {import("fbp-graph/lib/Types").GraphNodeMetadata} metadata
@@ -462,7 +461,7 @@ class ComponentLoader {
             });
         }
         if (callback) {
-            Platform_1.deprecated('Providing a callback to ComponentLoader.setSource is deprecated, use Promises');
+            (0, Platform_js_1.deprecated)('Providing a callback to ComponentLoader.setSource is deprecated, use Promises');
             promise.then(() => {
                 callback(null);
             }, callback);
@@ -502,7 +501,7 @@ class ComponentLoader {
             });
         }
         if (callback) {
-            Platform_1.deprecated('Providing a callback to ComponentLoader.getSource is deprecated, use Promises');
+            (0, Platform_js_1.deprecated)('Providing a callback to ComponentLoader.getSource is deprecated, use Promises');
             promise.then((source) => {
                 callback(null, source);
             }, callback);

package/lib/IP.d.ts

@@ -1,3 +1,6 @@
+/**
+ * @typedef {Object<string, boolean|string>} IPOptions
+ */
 export default class IP {
     /**
      * @param {any} obj
@@ -7,18 +10,16 @@ export default class IP {
     /**
      * @param {string} type
      * @param {any} data
-     * @param {Object<string, boolean|string>} [options]
+     * @param {IPOptions} [options]
      */
-    constructor(type: string, data?: any, options?: {
-        [x: string]: boolean | string;
-    });
+    constructor(type: string, data?: any, options?: IPOptions);
     type: string;
     data: any;
     isIP: boolean;
     /** @type {string|null} */
     scope: string | null;
-    /** @type {string|null} */
-    owner: string | null;
+    /** @type {import("./Component").Component|null} */
+    owner: import("./Component").Component | null;
     clonable: boolean;
     /** @type {number|null} */
     index: number | null;
@@ -30,8 +31,11 @@ export default class IP {
      */
     clone(): IP;
     /**
-     * @param {string|null} owner
+     * @param {import("./Component").Component|null} owner
      */
-    move(owner: string | null): IP;
+    move(owner: import("./Component").Component | null): IP;
     drop(): void;
 }
+export type IPOptions = {
+    [x: string]: boolean | string;
+};

package/lib/IP.js

@@ -26,6 +26,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 //   - 'data'
 //   - 'openBracket'
 //   - 'closeBracket'
+/**
+ * @typedef {Object<string, boolean|string>} IPOptions
+ */
 class IP {
     // Detects if an arbitrary value is an IP
     /**
@@ -40,7 +43,7 @@ class IP {
     /**
      * @param {string} type
      * @param {any} data
-     * @param {Object<string, boolean|string>} [options]
+     * @param {IPOptions} [options]
      */
     constructor(type, data = null, options = {}) {
         this.type = type || 'data';
@@ -48,7 +51,7 @@ class IP {
         this.isIP = true;
         /** @type {string|null} */
         this.scope = null; // sync scope id
-        /** @type {string|null} */
+        /** @type {import("./Component").Component|null} */
         this.owner = null; // packet owner process
         this.clonable = false; // cloning safety flag
         /** @type {number|null} */
@@ -59,7 +62,6 @@ class IP {
         if (typeof options === 'object') {
             Object.keys(options).forEach((key) => { this[key] = options[key]; });
         }
-        return this;
     }
     // Creates a new IP copying its contents by value not reference
     /**
@@ -86,7 +88,7 @@ class IP {
     }
     // Moves an IP to a different owner
     /**
-     * @param {string|null} owner
+     * @param {import("./Component").Component|null} owner
      */
     move(owner) {
         // no-op

package/lib/InPort.d.ts

@@ -1,7 +1,35 @@
+/**
+ * @typedef InPortOptions
+ * @property {any} [default]
+ * @property {Array<any>} [values]
+ * @property {boolean} [control]
+ * @property {boolean} [triggering]
+ */
+/**
+ * @callback HasValidationCallback
+ * @param {import("./IP").default} ip
+ * @returns {boolean}
+ */
+/**
+ * @typedef {import("./BasePort").BaseOptions & InPortOptions} PortOptions
+ */
 export default class InPort extends BasePort {
-    constructor(options?: {});
-    handleIP(packet: any, index: any): void;
-    handleSocketEvent(event: any, payload: any, id: any): boolean;
+    /**
+     * @param {PortOptions} [options]
+     */
+    constructor(options?: PortOptions);
+    options: PortOptions;
+    /**
+     * @param {import("./IP").default} packet
+     * @param {number|null} [index]
+     */
+    handleIP(packet: import("./IP").default, index?: number | null): void;
+    /**
+     * @param {string} event
+     * @param {any} payload
+     * @param {number} [id]
+     */
+    handleSocketEvent(event: string, payload: any, id?: number): boolean;
     hasDefault(): boolean;
     prepareBuffer(): void;
     /** @type {Object<string,Object<number,Array<import("./IP").default>>>} */
@@ -31,6 +59,9 @@ export default class InPort extends BasePort {
      * @returns {Array<import("./IP").default>}
      */
     prepareBufferForIP(ip: import("./IP").default): Array<import("./IP").default>;
+    /**
+     * @param {any} data
+     */
     validateData(data: any): void;
     /**
      * @param {string|null} scope
@@ -46,12 +77,52 @@ export default class InPort extends BasePort {
      * @returns {import("./IP").default|void}
      */
     getFromBuffer(scope: string | null, index: number | null, initial?: boolean): import("./IP").default | void;
-    get(scope: any, index: any): void | import("./IP").default;
-    hasIPinBuffer(scope: any, index: any, validate: any, initial?: boolean): boolean;
-    hasIIP(index: any, validate: any): boolean;
-    has(scope: any, index: any, validate: any): boolean;
-    length(scope: any, index: any): number;
-    ready(scope: any): boolean;
+    /**
+     * Fetches a packet from the port
+     * @param {string|null} scope
+     * @param {number|null} [index]
+     */
+    get(scope: string | null, index?: number | null): void | import("./IP").default;
+    /**
+     * Fetches a packet from the port
+     * @param {string|null} scope
+     * @param {number|null} index
+     * @param {HasValidationCallback} validate
+     * @param {boolean} [initial]
+     */
+    hasIPinBuffer(scope: string | null, index: number | null, validate: HasValidationCallback, initial?: boolean): boolean;
+    /**
+     * @param {number|null} index
+     * @param {HasValidationCallback} validate
+     */
+    hasIIP(index: number | null, validate: HasValidationCallback): boolean;
+    /**
+     * Returns true if port contains packet(s) matching the validator
+     * @param {string|null} scope
+     * @param {number|null|HasValidationCallback} index
+     * @param {HasValidationCallback} [validate]
+     */
+    has(scope: string | null, index: number | null | HasValidationCallback, validate?: HasValidationCallback): boolean;
+    /**
+     * Returns the number of data packets in an inport
+     * @param {string|null} scope
+     * @param {number|null} [index]
+     * @returns {number}
+     */
+    length(scope: string | null, index?: number | null): number;
+    /**
+     * Tells if buffer has packets or not
+     * @param {string|null} scope
+     */
+    ready(scope: string | null): boolean;
     clear(): void;
 }
-import BasePort from "./BasePort";
+export type InPortOptions = {
+    default?: any;
+    values?: Array<any>;
+    control?: boolean;
+    triggering?: boolean;
+};
+export type HasValidationCallback = (ip: import("./IP").default) => boolean;
+export type PortOptions = import("./BasePort").BaseOptions & InPortOptions;
+import BasePort from "./BasePort.js";