@interopio/gateway-server 0.5.2-beta → 0.6.0-beta

package/dist/metrics/publisher/rest.cjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/gateway/metrics/rest.ts"],
-  "sourcesContent": ["import * as rest from '@interopio/gateway/metrics/publisher/rest';\nimport {IOGateway} from '@interopio/gateway';\nimport {CookieAgent} from 'http-cookie-agent/undici/v6';\nimport {CookieJar} from 'tough-cookie';\n\nexport const fetchWithCookies = (existing?: typeof fetch): typeof fetch => {\n    const fetchFn = existing ?? globalThis.fetch;\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const jar: any = new CookieJar();\n    const dispatcher = new CookieAgent({cookies: {jar}});\n    return async (input: RequestInfo | URL, request?: RequestInit) => {\n        const requestWithDispatcher = {...request, dispatcher};\n        return await fetchFn(input, requestWithDispatcher);\n    }\n}\nexport const name = rest.name;\n\nexport function create(cfg: rest.RestPublisherConfig, logger: IOGateway.Logging.Logger) {\n    return rest.create({...cfg, fetch: fetchWithCookies(cfg.fetch)}, logger);\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,gBAAAA;AAAA,EAAA;AAAA,cAAAC;AAAA;AAAA;AAAA,WAAsB;AAEtB,gBAA0B;AAC1B,0BAAwB;AAEjB,IAAM,mBAAmB,CAAC,aAA0C;AACvE,QAAM,UAAU,YAAY,WAAW;AAEvC,QAAM,MAAW,IAAI,8BAAU;AAC/B,QAAM,aAAa,IAAI,sBAAY,EAAC,SAAS,EAAC,IAAG,EAAC,CAAC;AACnD,SAAO,OAAO,OAA0B,YAA0B;AAC9D,UAAM,wBAAwB,EAAC,GAAG,SAAS,WAAU;AACrD,WAAO,MAAM,QAAQ,OAAO,qBAAqB;AAAA,EACrD;AACJ;AACO,IAAMA,QAAY;AAElB,SAASD,QAAO,KAA+B,QAAkC;AACpF,SAAY,YAAO,EAAC,GAAG,KAAK,OAAO,iBAAiB,IAAI,KAAK,EAAC,GAAG,MAAM;AAC3E;",
+  "sourcesContent": ["import * as rest from '@interopio/gateway/metrics/publisher/rest';\nimport {IOGateway} from '@interopio/gateway';\nimport {CookieAgent} from 'http-cookie-agent/undici/v6';\nimport {CookieJar} from 'tough-cookie';\n\nexport const fetchWithCookies = (existing?: typeof fetch): typeof fetch => {\n    const fetchFn = existing ?? globalThis.fetch;\n    const jar = new CookieJar();\n    const dispatcher = new CookieAgent({cookies: {jar}});\n    return async (input: RequestInfo | URL, request?: RequestInit) => {\n        const requestWithDispatcher = {...request, dispatcher};\n        return await fetchFn(input, requestWithDispatcher);\n    }\n}\nexport const name = rest.name;\n\nexport function create(cfg: rest.RestPublisherConfig, logger: IOGateway.Logging.Logger) {\n    return rest.create({...cfg, fetch: fetchWithCookies(cfg.fetch)}, logger);\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA,gBAAAA;AAAA,EAAA;AAAA,cAAAC;AAAA;AAAA;AAAA,WAAsB;AAEtB,gBAA0B;AAC1B,0BAAwB;AAEjB,IAAM,mBAAmB,CAAC,aAA0C;AACvE,QAAM,UAAU,YAAY,WAAW;AACvC,QAAM,MAAM,IAAI,8BAAU;AAC1B,QAAM,aAAa,IAAI,sBAAY,EAAC,SAAS,EAAC,IAAG,EAAC,CAAC;AACnD,SAAO,OAAO,OAA0B,YAA0B;AAC9D,UAAM,wBAAwB,EAAC,GAAG,SAAS,WAAU;AACrD,WAAO,MAAM,QAAQ,OAAO,qBAAqB;AAAA,EACrD;AACJ;AACO,IAAMA,QAAY;AAElB,SAASD,QAAO,KAA+B,QAAkC;AACpF,SAAY,YAAO,EAAC,GAAG,KAAK,OAAO,iBAAiB,IAAI,KAAK,EAAC,GAAG,MAAM;AAC3E;",
   "names": ["create", "name"]
 }

package/dist/metrics/publisher/rest.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../../src/gateway/metrics/rest.ts"],
-  "sourcesContent": ["import * as rest from '@interopio/gateway/metrics/publisher/rest';\nimport {IOGateway} from '@interopio/gateway';\nimport {CookieAgent} from 'http-cookie-agent/undici/v6';\nimport {CookieJar} from 'tough-cookie';\n\nexport const fetchWithCookies = (existing?: typeof fetch): typeof fetch => {\n    const fetchFn = existing ?? globalThis.fetch;\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    const jar: any = new CookieJar();\n    const dispatcher = new CookieAgent({cookies: {jar}});\n    return async (input: RequestInfo | URL, request?: RequestInit) => {\n        const requestWithDispatcher = {...request, dispatcher};\n        return await fetchFn(input, requestWithDispatcher);\n    }\n}\nexport const name = rest.name;\n\nexport function create(cfg: rest.RestPublisherConfig, logger: IOGateway.Logging.Logger) {\n    return rest.create({...cfg, fetch: fetchWithCookies(cfg.fetch)}, logger);\n}\n"],
-  "mappings": ";AAAA,YAAY,UAAU;AAEtB,SAAQ,mBAAkB;AAC1B,SAAQ,iBAAgB;AAEjB,IAAM,mBAAmB,CAAC,aAA0C;AACvE,QAAM,UAAU,YAAY,WAAW;AAEvC,QAAM,MAAW,IAAI,UAAU;AAC/B,QAAM,aAAa,IAAI,YAAY,EAAC,SAAS,EAAC,IAAG,EAAC,CAAC;AACnD,SAAO,OAAO,OAA0B,YAA0B;AAC9D,UAAM,wBAAwB,EAAC,GAAG,SAAS,WAAU;AACrD,WAAO,MAAM,QAAQ,OAAO,qBAAqB;AAAA,EACrD;AACJ;AACO,IAAMA,QAAY;AAElB,SAASC,QAAO,KAA+B,QAAkC;AACpF,SAAY,YAAO,EAAC,GAAG,KAAK,OAAO,iBAAiB,IAAI,KAAK,EAAC,GAAG,MAAM;AAC3E;",
+  "sourcesContent": ["import * as rest from '@interopio/gateway/metrics/publisher/rest';\nimport {IOGateway} from '@interopio/gateway';\nimport {CookieAgent} from 'http-cookie-agent/undici/v6';\nimport {CookieJar} from 'tough-cookie';\n\nexport const fetchWithCookies = (existing?: typeof fetch): typeof fetch => {\n    const fetchFn = existing ?? globalThis.fetch;\n    const jar = new CookieJar();\n    const dispatcher = new CookieAgent({cookies: {jar}});\n    return async (input: RequestInfo | URL, request?: RequestInit) => {\n        const requestWithDispatcher = {...request, dispatcher};\n        return await fetchFn(input, requestWithDispatcher);\n    }\n}\nexport const name = rest.name;\n\nexport function create(cfg: rest.RestPublisherConfig, logger: IOGateway.Logging.Logger) {\n    return rest.create({...cfg, fetch: fetchWithCookies(cfg.fetch)}, logger);\n}\n"],
+  "mappings": ";AAAA,YAAY,UAAU;AAEtB,SAAQ,mBAAkB;AAC1B,SAAQ,iBAAgB;AAEjB,IAAM,mBAAmB,CAAC,aAA0C;AACvE,QAAM,UAAU,YAAY,WAAW;AACvC,QAAM,MAAM,IAAI,UAAU;AAC1B,QAAM,aAAa,IAAI,YAAY,EAAC,SAAS,EAAC,IAAG,EAAC,CAAC;AACnD,SAAO,OAAO,OAA0B,YAA0B;AAC9D,UAAM,wBAAwB,EAAC,GAAG,SAAS,WAAU;AACrD,WAAO,MAAM,QAAQ,OAAO,qBAAqB;AAAA,EACrD;AACJ;AACO,IAAMA,QAAY;AAElB,SAASC,QAAO,KAA+B,QAAkC;AACpF,SAAY,YAAO,EAAC,GAAG,KAAK,OAAO,iBAAiB,IAAI,KAAK,EAAC,GAAG,MAAM;AAC3E;",
   "names": ["name", "create"]
 }

package/gateway-server.d.ts

@@ -4,8 +4,9 @@ import {FilePublisherConfig} from '@interopio/gateway/metrics/publisher/file';
 export default GatewayServer.Factory;
 
 export namespace GatewayServer {
-    export const Factory: (options: ServerConfig) => Promise<Server>;
-    export type SslConfig = {key?: string, cert?: string, ca?: string};
+    export const Factory: (options: ServerConfig) => Promise<Server>
+    export type SslConfig = { key?: string, cert?: string, ca?: string }
+    export type AuthorizationRule = { access: 'permitted' | 'denied' | 'authenticated' }
     export type OriginFilters = {
         non_matched?: IOGateway.Filtering.Action
         missing?: IOGateway.Filtering.Action
@@ -23,13 +24,28 @@ export namespace GatewayServer {
         whitelist?: IOGateway.Filtering.Matcher[]
     }
     export import LoggerConfig = IOGateway.Logging.LogConfig;
+    export type AuthConfig = Readonly<{
+        type: 'none' | 'basic' | 'oauth2',
+        basic?: { user?: {name: string, password?: string}, realm?: string }
+        oauth2?: { jwt: { issuerUri: string, issuer?: string, audience?: string | string[] } }
+    }>;
+    export type CorsConfig = Readonly<{
+        allowOrigin?: '*' | IOGateway.Filtering.Matcher[]
+        allowHeaders?: string[]
+        allowMethods?: string[]
+        exposeHeaders?: string[]
+        allowCredentials?: boolean
+        allowPrivateNetwork?: boolean
+        maxAge?: number
+    }>;
+
     export type ServerConfig = {
         /**
          * The port to bind for network communication.
-         * Accepts a single valuer or a range.
+         * Accepts a single value or a range.
          * If a range is specified, will bind to the first available port in the range.
          *
-         * Defaults to 0 - a random port.
+         * Default: 0 - a random port.
          */
         port?: number | string
         /**
@@ -38,6 +54,12 @@ export namespace GatewayServer {
         host?: string
         ssl?: SslConfig,
 
+        auth?: AuthConfig,
+        /**
+         * CORS configuration.
+         */
+        cors?: CorsConfig,
+
         memory?: {
             memory_limit?: number
             dump_location?: string,
@@ -53,17 +75,23 @@ export namespace GatewayServer {
             limits?: {
                 max_connections?: number
             },
+            authorize?: AuthorizationRule
         }
         mesh?: {
             timeout?: number // defaults to 60000
             ping?: number // defaults to 30000
+            authorize?: AuthorizationRule
+            origins?: OriginFilters
         }
         metrics?: {
             file: FilePublisherConfig
+            authorize?: AuthorizationRule
         }
     }
+
     export interface Server {
         readonly gateway: IOGateway.Gateway
+
         close(): Promise<void>
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@interopio/gateway-server",
-    "version": "0.5.2-beta",
+    "version": "0.6.0-beta",
     "keywords": [
         "gateway",
         "server",
@@ -53,7 +53,7 @@
         "node": ">=20"
     },
     "dependencies": {
-        "@interopio/gateway": "^0.10.0-beta",
+        "@interopio/gateway": "^0.11.0-beta",
         "ws": "^8.18.2",
         "http-cookie-agent": "^7.0.1",
         "undici": "^6.21.3",

package/readme.md

@@ -1,5 +1,42 @@
 # io.Gateway Server
 
+## Getting Started
+
+```typescript
+import GatewayServer, {type Server} from '@interopio/gateway-server';
+
+const server: Server = await GatewayServer({
+    port: 8385,
+    gateway: {
+        route: '/gw',
+        access: 'authenticated'
+    }
+});
+
+await server.close();
+```
+
+## Configure HTTPS
+
+```typescript
+import GatewayServer, {type Server} from '@interopio/gateway-server';
+
+const server: Server = await GatewayServer({
+    port: 8443,
+    ssl: {
+        cert: "glue42.crt",
+        ca: "intermediate.crt",
+        key: "glue42.key"
+    },
+    metrics: {
+        access: 'permitted'
+    }
+});
+
+await server.close();
+
+```
+
 ## `@glue42/gateway-ent` compatibility
 
 This package aims to provide compatibility with `@glue42/gateway-ent` package