@where-org/where-bridge 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present, Masafumi Sasahara and contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,7 @@
+# where-bridge
+Bridge to where-server / where-socket.
+
+Usage
+```sh
+npm create where-bridge@latest [where-bridge-name]
+```

package/bin/where-bridge.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+
+import path from 'node:path';
+import * as where from '../index.js';
+
+const resolve = (module) => {
+  return module.indexOf('#module') === -1 ? import.meta.resolve(module) : module;
+};
+
+// main
+const main = async (dir) => {
+
+  // config
+  const bridgeConfig = await where.loadConfig(dir);
+
+  const bridgeAppConfig = Object.entries(bridgeConfig.app).reduce((o, [k, v]) => (
+    { ...o, [k]: { ...v, importPath: resolve(v.app.module) } }
+  ), {});
+
+  const bridgeAppMergedConfig = await where.mergeSpec(bridgeAppConfig, bridgeConfig.spec);
+
+  // bridge
+  const bridge = await where.createBridge({ ...bridgeConfig, app: bridgeAppMergedConfig });
+  await bridge.listen();
+
+}
+
+const [, , dir] = process.argv;
+main(path.resolve(...(dir ? [dir] : [import.meta.dirname, '../config'])));

package/config/bridge-app.yaml

@@ -0,0 +1,93 @@
+  #ts:
+  #app:
+    #module: '/Users/sasahara/Documents/devel/node/@where-org/module/bridge/where-bridge-app-typescript/src/index.ts'
+
+  #credential: {}
+
+#midi0:
+  #app:
+    #module: '@where-org/where-bridge-app-midi/socket'
+
+    #credential:
+      #port : 0
+      #url  : ws://localhost:5570/where/general/midi/p0
+      #style: osc # || midi
+      #hex  : false
+      #normarize: false
+
+#midi1:
+  #app:
+    #module: '@where-org/where-bridge-app-midi/socket'
+
+    #credential:
+      #port : 1
+      #url  : ws://localhost:5570/where/general/a/p0
+      #style: osc # || midi
+      #hex  : false
+      #normarize: false
+
+
+    #p1:
+      #port : 1
+      #url  : ws://localhost:5570/where/general/a/p1
+      #style: osc # || midi
+      #hex  : false
+      #normarize: true
+
+#mcp-http:
+  #app:
+    #module: '@where-org/where-bridge-app-mcp/http'
+
+    #meta:
+      #credential: example
+
+    #example:
+      #url: http://localhost:5570/where/ex/server
+      #readOnly: true
+      #port: 5600
+
+mcp-bridge:
+  app:
+    module: '@where-org/where-bridge-app-mcp/stdio'
+
+    meta:
+      credential: example
+
+    example:
+      url: http://localhost:5570/where/ex/server
+      readOnly: true
+
+#osc9000:
+  #app:
+    #module: '@where-org/where-bridge-app-osc/socket'
+
+    #meta:
+      #credential: example
+
+    #example:
+      #bind: 0.0.0.0
+      #port: 9000
+      #url : ws://localhost:5570/where/general/g/osc-server-9000
+      #style: osc
+      #type: emitter
+
+#osc9001:
+  #app:
+    #module: '@where-org/where-bridge-app-osc/socket'
+
+    #credential:
+      #bind: 0.0.0.0
+      #port: 9001
+      #url : ws://localhost:5570/where/general/a/osc-server-9001
+      #type: sender
+
+#osc9002:
+  #app:
+    #module: '@where-org/where-bridge-app-osc/server'
+
+    #credential:
+      #bind : 0.0.0.0
+      #port : 9002
+      #url  : http://localhost:5570/where/v2/osc-sender
+      #scope: send1
+      #type : sender

package/index.d.ts

@@ -0,0 +1,69 @@
+export * from './lib/types/module.js';
+export * from './lib/types/bridge.js';
+
+// common
+
+export {
+
+  // CommonFile
+  CommonFile, CommonFileRead, CommonFileReadJson, CommonFileReadYaml,
+
+  // CommonInitLog
+  Log, 
+
+  // CommonUtil
+  CommonUtil,
+
+  // CommonUtilCast
+  CommonUtilCast,
+
+  // CommonUtilDate
+  CommonUtilDate, CommonUtilDateIso8601, CommonUtilDateIsIsoString, CommonUtilDateIsString, CommonUtilDateIsDate, CommonUtilDateString,
+
+  // CommonUtilFormat
+  CommonUtilFormat,
+
+  // CommonUtilFormatPascal
+  CommonUtilFormatPascal,CommonUtilFormatPascalToCamel, CommonUtilFormatPascalToSnake, CommonUtilFormatPascalToKebab, CommonUtilFormatPascalKeys,
+
+  // CommonUtilFormatCamel
+  CommonUtilFormatCamel, CommonUtilFormatCamelToPascal, CommonUtilFormatCamelToSnake, CommonUtilFormatCamelToKebab, CommonUtilFormatCamelKeys,
+
+  // CommonUtilFormatSnake
+  CommonUtilFormatSnake, CommonUtilFormatSnakeToPascal, CommonUtilFormatSnakeToCamel, CommonUtilFormatSnakeToKebab, CommonUtilFormatSnakeKeys,
+
+  // CommonUtilFormatKebab
+  CommonUtilFormatKebab, CommonUtilFormatKebabToPascal, CommonUtilFormatKebabToCamel, CommonUtilFormatKebabToSnake, CommonUtilFormatKebabKeys,
+
+  // CommonUtilUrl
+  CommonUtilUrl, CommonUtilUrlSocket, CommonUtilUrlSocketParse, CommonUtilUrlSocketString, CommonUtilUrlSocketEither,
+
+  // SocketUrl
+  SocketUrlString, SocketUrlConfig, SocketUrlPreObject, SocketUrlObject,
+
+  // Cq
+  ConditionQuery, ConditionObject, ConditionString, Condition, ConditionSelect, CqParse, CqString, 
+
+  // Da
+  DataObject, DataArrayBase, DataArray, DaFilter,
+
+} from '@where-org/where-common';
+
+// client
+
+export {
+
+  // Client
+  Client, Server, Socket,
+
+  // ServerClient
+  ServerClient, ServerClientInit, ServerClientConfig, ServerClientToken, ServerClientScope, ServerClientFile, ServerClientFiles,
+
+  // SocketClient
+  SocketClient, SocketClientInit, SocketClientConfig, SocketClientAttribute,
+
+  // SocketEmitter
+  SocketEmitter, SocketEmitterInit,
+
+} from '@where-org/where-client';
+

package/index.js

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

package/lib/bridge/index.js

@@ -0,0 +1 @@
+export { init } from './init.js';

package/lib/bridge/init.js

@@ -0,0 +1,49 @@
+import path from 'node:path';
+
+const init = async (name, c, w) => {
+
+  // where
+  const { init, ...common } = w.common;
+
+  const log = init.log({ module: 'bridge-app', app: name }),
+        where = { ...w, log, common };
+
+  // config
+  const config = c.app[name];
+
+  // app
+  const { module: appModule } = config.app;
+
+  const appConfig = { ...config.app, ...await init.credential(config.app) },
+        args = [appConfig, where];
+
+  const appImport = await import(appModule).catch(async err => {
+
+    ;;; where.log({ error: err.stack });
+
+    return await import(path.resolve(process.cwd(), 'node_modules', appModule, 'index.js')).catch(err => {
+
+      ;;; where.log({ error: err.stack });
+      return false;
+
+    });
+
+  });
+
+  return (!appImport) ? appImport : await appImport[(appImport.app) ? 'app' : 'default'](...args);
+
+}
+
+//wrapper
+const wrapper = async (config, where) => {
+
+  return await Object.entries(config.app).reduce(async (o, [k, v]) => {
+
+    const app = await init(k, config, where);
+    return (app) ? { ...await o, [k]: app } : await o;
+
+  }, {});
+
+}
+
+export { wrapper as init };

package/lib/bridge.js

@@ -0,0 +1,104 @@
+import path from 'node:path';
+
+import { common, cq, da, define } from '@where-org/where-common';
+
+const { status } = define,
+      file = { read: common.file.read };
+
+const { filter } = da;
+
+import { client, server, socket } from '@where-org/where-client';
+import { init } from './bridge/index.js';
+
+// mode
+const mode = process.env.npm_config_mode || process.env.NODE_ENV || 'development',
+      development = (mode === 'development') ? true : false;
+
+/* log */
+const log = common.init.log('bridge');
+
+/* loadConfig */
+const loadConfig = async (dir) => {
+  return await common.config.load(dir, mode, 'bridge', true);
+};
+
+/* mergeSpec */
+const mergeSpec = async (appConfig, specConfig) => {
+
+  const resolveImportPathAppConfig = Object.entries(appConfig).reduce((o, [k, v]) => (
+    { ...o, [k]: { ...v, importPath: v.importPath.indexOf('#module') === 0 ? import.meta.resolve(v.importPath) : v.importPath } }
+  ), {});
+
+  return await common.config.mergeSpec(resolveImportPathAppConfig, specConfig);
+
+};
+
+/* createBridge */
+const createBridge = async (c) => {
+
+  // config
+  //const c = await common.config.load(dir, mode, 'bridge', true);
+
+  // env
+  const { name, version } = await common.file.read.json(path.resolve(import.meta.dirname, '../package.json'));
+
+  const env = Object.entries({ name, version, mode }).reduce((o, [k, v]) => {
+
+    const key = common.util.casing.camelToSnake(k).toUpperCase();
+    return { ...o, [`BRIDGE_${key}`]: v };
+
+  }, {});
+
+  // where object
+  const where = {
+    log,
+
+    app: {
+      env, define: { status }, cq, da: { filter }, common: { ...common, file },
+      client, server, socket,
+    },
+  };
+
+  // where-bridge apps
+  const apps = await init(c, where.app);
+
+  // bridge
+  const bridge = {
+
+    listen: async () => {
+      ;;; where.log({ message: 'Hello!', mode });
+
+      await Promise.all(Object.entries(apps).map(async ([k, v]) => {
+        if ('listen' in v) {
+          await v.listen();
+        }
+      }));
+    },
+
+    end: async (code) => {
+
+      await Promise.all(Object.entries(apps).map(async ([k, v]) => {
+        if ('end' in v) {
+          await v.end();
+        }
+      }));
+
+      process.exit(code);
+
+    },
+
+  };
+
+  Object.entries({ SIGINT: 2, SIGTERM: 15 }).forEach(([k, v]) => {
+    process.on(k, async () => await bridge.end(v));
+  });
+
+  process.on('exit', async (code) => {
+    ;;; where.log('See you!');
+  });
+
+  return bridge;
+
+};
+
+export { createBridge, loadConfig, mergeSpec, log, };

package/lib/types/bridge.d.ts

@@ -0,0 +1,11 @@
+import type * as Where from '@where-org/where-common';
+
+// lib/bridge.js 
+
+export type Bridge = null;
+export type BridgeInit = (dir: string) => Promise<Bridge>;
+
+// const
+
+export declare const bridge: BridgeInit;
+export declare const log: Where.Log;

package/lib/types/module.d.ts

@@ -0,0 +1,61 @@
+import type * as Where from '@where-org/where-common';
+import type { Client, Server, Socket } from '@where-org/where-client';
+
+// where-toward-app-module
+
+// interface
+
+export interface TowardApp {
+
+  end?
+    (): Promise<void>;
+
+}
+
+// constructor parameters
+
+// TowardAppConfig
+export type TowardAppConfig = Where.Credentials;
+
+// Env - where.env
+export type Env<T = string | number> = Where.DataObject<T>;
+
+// Common - where.common
+export type Common = {
+
+  file: Where.CommonFile,
+  util: Where.CommonUtil,
+
+};
+
+// Cq - where.cq
+export type Cq = {
+
+  parse : Where.CqParse,
+  string: Where.CqString,
+
+};
+
+// Da - where.da
+export type Da = {
+  filter: Where.DaFilter,
+};
+
+// TowardAppLib
+export type TowardAppLib = {
+
+  log: Where.Log,
+  env: Env,
+
+  common: Common,
+  cq: Cq,
+  da: Da,
+
+  client: Client,
+  server: Server,
+  socket: Socket,
+
+}
+
+// shortcut
+

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@where-org/where-bridge",
+  "version": "1.0.0",
+  "description": "Bridge to where-server / where-socket",
+  "license": "MIT",
+  "author": "Masafumi Sasahara <masafumi@sashara.io> (https://github.com/masafumi-sasahara/)",
+  "homepage": "https://where-org.com/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/where-org/where-bridge.git"
+  },
+  "type": "module",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "scripts": {
+    "start": "NODE_ENV=$npm_config_mode node ./bin/where-bridge.js ./config",
+    "dev": "NODE_ENV=$npm_config_mode node --watch ./bin/where-bridge.js ./config"
+  },
+  "keywords": [
+    "where-bridge",
+    "where-client"
+  ],
+  "dependencies": {
+    "@where-org/where-client": "^2.0.0",
+    "@where-org/where-common": "^2.0.2"
+  }
+}