@comunica/actor-http-native 1.22.0 → 2.0.1-alpha.7.0

package/LICENSE.txt

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
-Copyright © 2017–2018 Ruben Taelman, Joachim Van Herwegen
-Ghent University – imec, Belgium
+Copyright © 2017–now Ruben Taelman, Joachim Van Herwegen
+Comunica Association and Ghent University – imec, Belgium
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -2,7 +2,7 @@
 
 [![npm version](https://badge.fury.io/js/%40comunica%2Factor-http-native.svg)](https://www.npmjs.com/package/@comunica/actor-http-native)
 
-**DEPRECATED: use the more flexible @comunica/actor-http-node-fetch instead without loss of performance.**
+**DEPRECATED: use the more flexible @comunica/actor-http-fetch instead without loss of performance.**
 
 An [HTTP](https://github.com/comunica/comunica/tree/master/packages/bus-http) actor that
 uses Node's request API (`XMLHttpRequest` in the browser) to perform HTTP requests.
@@ -25,14 +25,18 @@ After installing, this package can be added to your engine's configuration as fo
 {
   "@context": [
     ...
-    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-http-native/^1.0.0/components/context.jsonld"  
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-http-native/^2.0.0/components/context.jsonld"  
   ],
   "actors": [
     ...
     {
-      "@id": "config-sets:http.json#myHttpFetcher",
+      "@id": "urn:comunica:default:http/actors#native",
       "@type": "ActorHttpNative"
     }
   ]
 }
 ```
+
+### Config Parameters
+
+* `agentOptions`: The agent JSON options for the HTTP agent. _(optional)_ 

package/components/ActorHttpNative.jsonld

@@ -0,0 +1,175 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-http-native/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-http/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^2.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-http-native",
+  "components": [
+    {
+      "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative",
+      "@type": "Class",
+      "requireElement": "ActorHttpNative",
+      "extends": [
+        "cbh:components/ActorHttp.jsonld#ActorHttp"
+      ],
+      "comment": "A comunica Follow Redirects Http Actor.",
+      "parameters": [
+        {
+          "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_agentOptions",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              "rdf:JSON",
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "default": {
+            "@type": "@json",
+            "@value": {
+              "keepAlive": true,
+              "maxSockets": 5
+            }
+          },
+          "comment": "The agent options for the HTTP agent"
+        },
+        {
+          "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_bus",
+          "range": {
+            "@type": "ParameterRangeGenericComponent",
+            "component": "cc:components/Bus.jsonld#Bus",
+            "genericTypeInstances": [
+              {
+                "@type": "ParameterRangeGenericComponent",
+                "component": "cc:components/Actor.jsonld#Actor",
+                "genericTypeInstances": [
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+              }
+            ]
+          },
+          "default": {
+            "@id": "cbh:components/ActorHttp.jsonld#ActorHttp_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_beforeActors",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              {
+                "@type": "ParameterRangeArray",
+                "parameterRangeValue": {
+                  "@type": "ParameterRangeGenericComponent",
+                  "component": "cc:components/Actor.jsonld#Actor",
+                  "genericTypeInstances": [
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                    }
+                  ]
+                }
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Actor that must be registered in the bus before this actor."
+        }
+      ],
+      "memberKeys": [
+        "userAgent",
+        "requester",
+        "constructor",
+        "createUserAgent",
+        "test",
+        "run"
+      ],
+      "constructorArguments": [
+        {
+          "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "agentOptions",
+              "value": {
+                "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_agentOptions"
+              }
+            },
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_bus"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "@id": "cahn:components/ActorHttpNative.jsonld#IActorHttpNativeArgs",
+      "@type": "AbstractClass",
+      "requireElement": "IActorHttpNativeArgs",
+      "parameters": [],
+      "memberKeys": [
+        "agentOptions"
+      ],
+      "constructorArguments": []
+    }
+  ]
+}

package/components/components.jsonld

@@ -1,9 +1,11 @@
 {
-  "@context": "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-http-native/^1.0.0/components/context.jsonld",
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-http-native/^2.0.0/components/context.jsonld"
+  ],
   "@id": "npmd:@comunica/actor-http-native",
   "@type": "Module",
   "requireName": "@comunica/actor-http-native",
   "import": [
-    "files-cahn:components/Actor/Http/Native.jsonld"
+    "cahn:components/ActorHttpNative.jsonld"
   ]
-}
+}

package/components/context.jsonld

@@ -3,10 +3,44 @@
     "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld",
     {
       "npmd": "https://linkedsoftwaredependencies.org/bundles/npm/",
-      "cahn": "npmd:@comunica/actor-http-native/",
-      "files-cahn": "cahn:^1.0.0/",
-
-      "ActorHttpNative": "cahn:Actor/Http/Native"
+      "cahn": "npmd:@comunica/actor-http-native/^2.0.0/",
+      "ActorHttpNative": {
+        "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative",
+        "@prefix": true,
+        "@context": {
+          "args_agentOptions": {
+            "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_agentOptions"
+          },
+          "args_name": {
+            "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_name"
+          },
+          "args_bus": {
+            "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_bus"
+          },
+          "args_beforeActors": {
+            "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_beforeActors",
+            "@container": "@list"
+          },
+          "agentOptions": {
+            "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_agentOptions"
+          },
+          "name": {
+            "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_name"
+          },
+          "bus": {
+            "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_bus"
+          },
+          "beforeActors": {
+            "@id": "cahn:components/ActorHttpNative.jsonld#ActorHttpNative_args_beforeActors",
+            "@container": "@list"
+          }
+        }
+      },
+      "IActorHttpNativeArgs": {
+        "@id": "cahn:components/ActorHttpNative.jsonld#IActorHttpNativeArgs",
+        "@prefix": true,
+        "@context": {}
+      }
     }
   ]
-}
+}

package/lib/ActorHttpNative.d.ts

@@ -1,6 +1,5 @@
-import type { IActionHttp, IActorHttpOutput } from '@comunica/bus-http';
+import type { IActionHttp, IActorHttpOutput, IActorHttpArgs } from '@comunica/bus-http';
 import { ActorHttp } from '@comunica/bus-http';
-import type { IActorArgs } from '@comunica/core';
 import type { IMediatorTypeTime } from '@comunica/mediatortype-time';
 import 'cross-fetch/polyfill';
 /**
@@ -14,6 +13,11 @@ export declare class ActorHttpNative extends ActorHttp {
     test(action: IActionHttp): Promise<IMediatorTypeTime>;
     run(action: IActionHttp): Promise<IActorHttpOutput>;
 }
-export interface IActorHttpNativeArgs extends IActorArgs<IActionHttp, IMediatorTypeTime, IActorHttpOutput> {
-    agentOptions?: string;
+export interface IActorHttpNativeArgs extends IActorHttpArgs {
+    /**
+     * The agent options for the HTTP agent
+     * @range {json}
+     * @default {{ "keepAlive": true, "maxSockets": 5 }}
+     */
+    agentOptions?: Record<string, any>;
 }

package/lib/ActorHttpNative.js

@@ -12,7 +12,7 @@ class ActorHttpNative extends bus_http_1.ActorHttp {
     constructor(args) {
         super(args);
         this.userAgent = ActorHttpNative.createUserAgent();
-        this.requester = new Requester_1.default(args.agentOptions ? JSON.parse(args.agentOptions) : undefined);
+        this.requester = new Requester_1.default(args.agentOptions);
     }
     static createUserAgent() {
         return `Comunica/actor-http-native (${typeof global.navigator === 'undefined' ?
@@ -20,7 +20,6 @@ class ActorHttpNative extends bus_http_1.ActorHttp {
             `Browser-${global.navigator.userAgent}`})`;
     }
     async test(action) {
-        // TODO: check for unsupported fetch features
         return { time: Number.POSITIVE_INFINITY };
     }
     async run(action) {
@@ -52,10 +51,10 @@ class ActorHttpNative extends bus_http_1.ActorHttp {
             options.headers.append('user-agent', this.userAgent);
         }
         options.method = options.method || 'GET';
-        if (action.context && action.context.get(context_entries_1.KeysHttp.includeCredentials)) {
+        if (action.context.get(context_entries_1.KeysHttp.includeCredentials)) {
             options.withCredentials = true;
         }
-        if (action.context && action.context.get(context_entries_1.KeysHttp.auth)) {
+        if (action.context.get(context_entries_1.KeysHttp.auth)) {
             options.auth = action.context.get(context_entries_1.KeysHttp.auth);
         }
         this.logInfo(action.context, `Requesting ${options.url}`, () => ({
@@ -84,7 +83,7 @@ class ActorHttpNative extends bus_http_1.ActorHttp {
                             return Promise.resolve();
                         };
                         // Support abort controller
-                        if (action.init && action.init.signal) {
+                        if (action.init?.signal) {
                             if (action.init.signal.aborted) {
                                 httpResponse.destroy();
                             }

package/lib/Requester-browser.js

@@ -1,5 +1,6 @@
 "use strict";
 /* eslint-disable unicorn/filename-case */
+/* eslint-enable unicorn/filename-case */
 /* ! @license MIT ©2013-2016 Ruben Verborgh, Ghent University - imec */
 /* Single-function HTTP(S) request module for browsers */
 /* Translated from https://github.com/LinkedDataFragments/Client.js/blob/master/lib/browser/Request.js */
@@ -39,7 +40,6 @@ class Requester {
         };
         // Handle the arrival of a response
         request.onload = () => {
-            var _a, _b;
             // Convert the response into an iterator
             const response = new stream_1.Readable();
             response.push(request.responseText || '');
@@ -61,11 +61,11 @@ class Requester {
             // If the resource was time-negotiated, store its queryless URI
             // to enable the PERFORMANCE HACK explained above
             if (reqHeaders.has('accept-datetime') && resHeaders.has('memento-datetime')) {
-                const resource = this.removeQuery((_a = resHeaders.get('content-location')) !== null && _a !== void 0 ? _a : settings.url);
+                const resource = this.removeQuery(resHeaders.get('content-location') ?? settings.url);
                 if (!this.negotiatedResources[resource]) {
                     // Ensure the resource is not a timegate
-                    const links = (_b = (resHeaders.get('link') && parseLink(resHeaders.get('link')))) !== null && _b !== void 0 ? _b : undefined;
-                    const timegate = this.removeQuery(links && links.timegate && links.timegate.url);
+                    const links = (resHeaders.get('link') && parseLink(resHeaders.get('link'))) ?? undefined;
+                    const timegate = this.removeQuery(links && links.timegate?.url);
                     if (resource !== timegate) {
                         this.negotiatedResources[resource] = true;
                     }

package/lib/Requester.js

@@ -15,15 +15,15 @@ const DECODERS = { gzip: zlib.createGunzip, deflate: zlib.createInflate };
 class Requester {
     constructor(agentOptions) {
         this.agents = {
-            http: new http.Agent(agentOptions !== null && agentOptions !== void 0 ? agentOptions : {}),
-            https: new https.Agent(agentOptions !== null && agentOptions !== void 0 ? agentOptions : {}),
+            http: new http.Agent(agentOptions ?? {}),
+            https: new https.Agent(agentOptions ?? {}),
         };
     }
     // Creates an HTTP request with the given settings
     createRequest(settings) {
         // Parse the request URL
         if (settings.url) {
-            settings = Object.assign(Object.assign({}, url.parse(settings.url)), settings);
+            settings = { ...url.parse(settings.url), ...settings };
         }
         // Emit the response through a proxy
         const requestProxy = new events_1.EventEmitter();

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './ActorHttpNative';

package/{index.js → lib/index.js}

@@ -10,5 +10,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./lib/ActorHttpNative"), exports);
+__exportStar(require("./ActorHttpNative"), exports);
 //# sourceMappingURL=index.js.map

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@comunica/actor-http-native",
-  "version": "1.22.0",
+  "version": "2.0.1-alpha.7.0",
   "description": "A native http actor",
   "lsd:module": true,
-  "main": "index.js",
-  "typings": "index",
+  "main": "lib/index.js",
+  "typings": "lib/index",
   "repository": {
     "type": "git",
     "url": "https://github.com/comunica/comunica.git",
@@ -13,6 +13,7 @@
   "publishConfig": {
     "access": "public"
   },
+  "sideEffects": false,
   "keywords": [
     "comunica",
     "actor",
@@ -27,50 +28,25 @@
   "files": [
     "components",
     "lib/**/*.d.ts",
-    "lib/**/*.js",
-    "index.d.ts",
-    "index.js"
+    "lib/**/*.js"
   ],
-  "peerDependencies": {
-    "@comunica/bus-http": "^1.0.0",
-    "@comunica/core": "^1.0.0"
-  },
   "dependencies": {
-    "@comunica/context-entries": "^1.22.0",
+    "@comunica/bus-http": "2.0.1-alpha.7.0",
+    "@comunica/context-entries": "2.0.1-alpha.7.0",
+    "@comunica/core": "2.0.1-alpha.7.0",
+    "@comunica/mediatortype-time": "2.0.1-alpha.7.0",
     "@types/parse-link-header": "^1.0.0",
     "cross-fetch": "^3.0.5",
     "follow-redirects": "^1.5.1",
     "parse-link-header": "^1.0.1"
   },
-  "devDependencies": {
-    "@comunica/bus-http": "^1.22.0",
-    "@comunica/core": "^1.22.0",
-    "@comunica/mediatortype-time": "^1.22.0"
-  },
-  "jest": {
-    "globals": {
-      "ts-jest": {
-        "tsConfig": "../../tsconfig.json"
-      }
-    },
-    "transform": {
-      "^.+\\.ts$": "ts-jest"
-    },
-    "testRegex": "(/test/.*|(\\.|/)(test|spec))\\.ts$",
-    "moduleFileExtensions": [
-      "ts",
-      "js"
-    ],
-    "collectCoverage": true
-  },
   "scripts": {
-    "test": "node \"../../node_modules/jest/bin/jest.js\" ${1}",
-    "test-watch": "node \"../../node_modules/jest/bin/jest.js\" ${1} --watch",
-    "build": "node \"../../node_modules/typescript/bin/tsc\"",
-    "validate": "npm ls"
+    "build": "npm run build:ts && npm run build:components",
+    "build:ts": "node \"../../node_modules/typescript/bin/tsc\"",
+    "build:components": "componentsjs-generator"
   },
   "browser": {
     "./lib/Requester.js": "./lib/Requester-browser.js"
   },
-  "gitHead": "0a249ba341022eb2f1b9922fcf549a9564671d9f"
+  "gitHead": "4cdf341cc4d4775a21c6a65c98a72ba47e0093fc"
 }

package/components/Actor/Http/Native.jsonld

@@ -1,38 +0,0 @@
-{
-  "@context": [
-    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-http-native/^1.0.0/components/context.jsonld",
-    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-http/^1.0.0/components/context.jsonld"
-  ],
-  "@id": "npmd:@comunica/actor-http-native",
-  "components": [
-    {
-      "@id": "cahn:Actor/Http/Native",
-      "@type": "Class",
-      "extends": "cbh:Actor/Http",
-      "requireElement": "ActorHttpNative",
-      "comment": "A comunica Follow Redirects Http Actor.",
-      "parameters": [
-        {
-          "@id": "cahn:Actor/Http/Native/agentOptions",
-          "comment": "The AgentOptions for the HTTP agent as a JSON string",
-          "required": false,
-          "unique": true,
-          "default": "{ \"keepAlive\": true, \"maxSockets\": 5 }",
-          "range": "xsd:string"
-        }
-      ],
-      "constructorArguments": [
-        {
-          "@id": "cahn:Actor/Http/Native/constructorArgumentsObject",
-          "extends": "cbh:Actor/Http/constructorArgumentsObject",
-          "fields": [
-            {
-              "keyRaw": "agentOptions",
-              "value": "cahn:Actor/Http/Native/agentOptions"
-            }
-          ]
-        }
-      ]
-    }
-  ]
-}

package/index.d.ts

@@ -1 +0,0 @@
-export * from './lib/ActorHttpNative';