@dxos/config 0.8.3 → 0.8.4-main.1068cf700f

package/package.json

@@ -1,15 +1,49 @@
 {
   "name": "@dxos/config",
-  "version": "0.8.3",
+  "version": "0.8.4-main.1068cf700f",
   "description": "Config utilities",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
   "license": "MIT",
   "author": "DXOS.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
+  "imports": {
+    "#loaders": {
+      "source": {
+        "browser": "./src/loaders/browser.ts",
+        "default": "./src/loaders/index.ts"
+      },
+      "types": "./dist/types/src/loaders/index.d.ts",
+      "browser": "./dist/lib/browser/loaders/browser.mjs",
+      "default": "./dist/lib/node-esm/loaders/index.mjs"
+    },
+    "#savers": {
+      "source": {
+        "browser": "./src/savers/browser.ts",
+        "default": "./src/savers/index.ts"
+      },
+      "types": "./dist/types/src/savers/index.d.ts",
+      "browser": "./dist/lib/browser/savers/browser.mjs",
+      "default": "./dist/lib/node-esm/savers/index.mjs"
+    },
+    "#plugin": {
+      "source": {
+        "browser": "./src/plugin/browser.ts",
+        "default": "./src/plugin/index.ts"
+      },
+      "types": "./dist/types/src/plugin/index.d.ts",
+      "browser": "./dist/lib/browser/plugin/browser.mjs",
+      "default": "./dist/lib/node-esm/plugin/index.mjs"
+    }
+  },
   "exports": {
     ".": {
+      "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
       "browser": "./dist/lib/browser/index.mjs",
       "node": {
@@ -18,28 +52,25 @@
       }
     },
     "./esbuild-plugin": {
+      "source": "./src/esbuild-plugin/index.ts",
       "types": "./dist/types/src/esbuild-plugin/index.d.ts",
       "import": "./dist/plugin/node-esm/esbuild-plugin.mjs",
       "require": "./dist/plugin/node/esbuild-plugin.cjs"
     },
     "./rollup-plugin": {
+      "source": "./src/rollup-plugin/index.ts",
       "types": "./dist/types/src/rollup-plugin/index.d.ts",
       "import": "./dist/plugin/node-esm/rollup-plugin.mjs",
       "require": "./dist/plugin/node/rollup-plugin.cjs"
     },
     "./vite-plugin": {
+      "source": "./src/vite-plugin/index.ts",
       "types": "./dist/types/src/vite-plugin/index.d.ts",
       "import": "./dist/plugin/node-esm/vite-plugin.mjs",
       "require": "./dist/plugin/node/vite-plugin.cjs"
     }
   },
   "main": "dist/lib/node/index.cjs",
-  "browser": {
-    "./src/loaders/index.ts": "./src/loaders/browser.js",
-    "./src/savers/index.ts": "./src/savers/browser.js",
-    "./src/plugin/index.ts": false,
-    "./dist/lib/node/index.cjs": "./dist/lib/browser/index.mjs"
-  },
   "types": "dist/types/src/index.d.ts",
   "typesVersions": {
     "*": {
@@ -59,20 +90,23 @@
     "src"
   ],
   "dependencies": {
+    "@effect/platform": "0.94.4",
     "boolean": "^3.0.1",
-    "js-yaml": "^4.1.0",
+    "effect": "3.19.16",
     "localforage": "^1.10.0",
     "lodash.defaultsdeep": "^4.6.1",
     "lodash.ismatch": "^4.4.0",
     "pkg-up": "^3.1.0",
-    "@dxos/log": "0.8.3",
-    "@dxos/node-std": "0.8.3",
-    "@dxos/protocols": "0.8.3",
-    "@dxos/util": "0.8.3",
-    "@dxos/tracing": "0.8.3"
+    "yaml": "^2.7.0",
+    "@dxos/client-protocol": "0.8.4-main.1068cf700f",
+    "@dxos/invariant": "0.8.4-main.1068cf700f",
+    "@dxos/log": "0.8.4-main.1068cf700f",
+    "@dxos/tracing": "0.8.4-main.1068cf700f",
+    "@dxos/protocols": "0.8.4-main.1068cf700f",
+    "@dxos/util": "0.8.4-main.1068cf700f",
+    "@dxos/node-std": "0.8.4-main.1068cf700f"
   },
   "devDependencies": {
-    "@types/js-yaml": "^4.0.5",
     "@types/lodash.defaultsdeep": "^4.6.6",
     "@types/lodash.ismatch": "^4.4.9",
     "webpack": "^5.88.2"

package/src/config-service.ts

@@ -0,0 +1,118 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import { dirname } from 'node:path';
+
+import * as FileSystem from '@effect/platform/FileSystem';
+import * as Context from 'effect/Context';
+import * as Effect from 'effect/Effect';
+import * as Layer from 'effect/Layer';
+import * as Option from 'effect/Option';
+import * as Yaml from 'yaml';
+
+import { DX_CONFIG, DX_DATA } from '@dxos/client-protocol';
+import { getProfilePath } from '@dxos/client-protocol';
+import { invariant } from '@dxos/invariant';
+
+import { Config } from './config';
+
+export const memoryConfig = new Config({
+  runtime: {
+    client: {
+      edgeFeatures: {
+        echoReplicator: true,
+        feedReplicator: true,
+        signaling: true,
+        agents: true,
+      },
+    },
+  },
+});
+
+export const defaultConfig = new Config({
+  runtime: {
+    client: {
+      edgeFeatures: {
+        echoReplicator: true,
+        feedReplicator: true,
+        signaling: true,
+        agents: true,
+      },
+      storage: {
+        persistent: true,
+      },
+    },
+    services: {
+      edge: {
+        url: 'wss://edge-production.dxos.workers.dev/',
+      },
+      iceProviders: [
+        {
+          urls: 'https://edge-production.dxos.workers.dev/ice',
+        },
+      ],
+      ai: {
+        server: 'https://ai-service.dxos.workers.dev',
+      },
+      ipfs: {
+        server: 'https://api.ipfs.dxos.network/api/v0',
+        gateway: 'https://gateway.ipfs.dxos.network/ipfs',
+      },
+    },
+  },
+});
+
+export class ConfigService extends Context.Tag('ConfigService')<ConfigService, Config>() {
+  static layerMemory = Layer.effect(ConfigService, Effect.succeed(memoryConfig));
+
+  static fromConfig = (config: Config) => Layer.succeed(ConfigService, config);
+
+  static load = (args: { config: Option.Option<string>; profile: string }) => {
+    const defaultConfigPath = `${getProfilePath(DX_CONFIG, args.profile)}.yml`;
+    return Effect.gen(function* () {
+      const fs = yield* FileSystem.FileSystem;
+      const configPath = Option.getOrElse(args.config, () => defaultConfigPath);
+      const configContent = yield* fs.readFileString(configPath);
+      const configValues = Yaml.parse(configContent);
+      return ConfigService.of(new Config(configValues, profileBuiltinDefaults(args.profile).values));
+    }).pipe(
+      // If the config file doesn't exist, create it.
+      Effect.catchTag('SystemError', () =>
+        Effect.gen(function* () {
+          const configValues = defaultConfig.values;
+          const fs = yield* FileSystem.FileSystem;
+          yield* fs.makeDirectory(dirname(defaultConfigPath), { recursive: true });
+          yield* fs.writeFileString(defaultConfigPath, Yaml.stringify(configValues));
+
+          return ConfigService.of(new Config(configValues));
+        }),
+      ),
+    );
+  };
+}
+
+/**
+ * Default config for a profile.
+ * Always merged with the default config.
+ */
+const profileBuiltinDefaults = (profile: string) => {
+  invariant(!profile.endsWith('.yml'));
+
+  return new Config({
+    runtime: {
+      client: {
+        edgeFeatures: {
+          echoReplicator: true,
+          feedReplicator: true,
+          signaling: true,
+          agents: true,
+        },
+        storage: {
+          persistent: true,
+          dataRoot: getProfilePath(DX_DATA, profile),
+        },
+      },
+    },
+  });
+};

package/src/config.ts

@@ -19,7 +19,6 @@ const configRootType = schema.getCodecForType('dxos.config.Config');
 
 /**
  * Maps the given objects onto a flattened set of (key x values).
- *
  * Expects parsed yaml content of the form:
  *
  * ```
@@ -36,7 +35,6 @@ export const mapFromKeyValues = (spec: MappingSpec, values: Record<string, any>)
 
   for (const [key, { path, type }] of Object.entries(spec)) {
     let value = values[key];
-
     if (value !== undefined) {
       if (type) {
         switch (type) {
@@ -101,16 +99,16 @@ export const mapToKeyValues = (spec: MappingSpec, values: any) => {
  */
 export const validateConfig = (config: ConfigProto): ConfigProto => {
   if (!('version' in config)) {
-    throw new InvalidConfigError('Version not specified');
+    throw new InvalidConfigError({ message: 'Version not specified' });
   }
 
   if (config?.version !== 1) {
-    throw new InvalidConfigError(`Invalid config version: ${config.version}`);
+    throw new InvalidConfigError({ message: `Invalid config version: ${config.version}` });
   }
 
   const error = configRootType.protoType.verify(config);
   if (error) {
-    throw new InvalidConfigError(error);
+    throw new InvalidConfigError({ message: String(error) });
   }
 
   return config;

package/src/index.ts

@@ -8,7 +8,9 @@ export * as defs from '@dxos/protocols/proto/dxos/config';
 export { type Config as ConfigProto } from '@dxos/protocols/proto/dxos/config';
 
 export * from './config';
-export * from './loaders';
-export * from './savers';
-export * from './plugin';
+export * from './config-service';
+export * from '#loaders';
+export * from '#savers';
+export * from '#plugin';
 export * from './types';
+export * from './preset';

package/src/loaders/{browser.js → browser.ts}

@@ -4,19 +4,25 @@
 
 /* THIS FILE WILL BE LOADED BY CONTEXT REPLACEMENT PLUGIN IN BROWSER ENVS. */
 
-/* global __DXOS_CONFIG__ __CONFIG_ENVS__ __CONFIG_DEFAULTS__ __CONFIG_LOCAL__ */
-
 import localforage from 'localforage';
 
 import { log } from '@dxos/log';
+import { type Config as ConfigProto } from '@dxos/protocols/proto/dxos/config';
+
+declare const __DXOS_CONFIG__: { publicUrl?: string; dynamic?: boolean };
+declare const __CONFIG_ENVS__: Partial<ConfigProto> | undefined;
+declare const __CONFIG_DEFAULTS__: Partial<ConfigProto> | undefined;
+declare const __CONFIG_LOCAL__: Partial<ConfigProto> | undefined;
 
 const CONFIG_ENDPOINT = '/.well-known/dx/config';
 
-export const Local = () => {
+export const Profile = (_profile = 'default'): Partial<ConfigProto> => ({});
+
+export const Local = (): Partial<ConfigProto> => {
   return typeof __CONFIG_LOCAL__ !== 'undefined' ? __CONFIG_LOCAL__ : {};
 };
 
-export const Dynamics = async () => {
+export const Dynamics = async (): Promise<Partial<ConfigProto>> => {
   const { publicUrl = '', dynamic } = __DXOS_CONFIG__;
   if (!dynamic) {
     log('dynamics disabled');
@@ -32,20 +38,20 @@ export const Dynamics = async () => {
     });
 };
 
-export const Envs = () => {
+export const Envs = (_basePath?: string): Partial<ConfigProto> => {
   return typeof __CONFIG_ENVS__ !== 'undefined' ? __CONFIG_ENVS__ : {};
 };
 
-export const Defaults = () => {
+export const Defaults = (_basePath?: string): Partial<ConfigProto> => {
   return typeof __CONFIG_DEFAULTS__ !== 'undefined' ? __CONFIG_DEFAULTS__ : {};
 };
 
 /**
  * Settings config from browser storage.
  */
-export const Storage = async () => {
+export const Storage = async (): Promise<Partial<ConfigProto>> => {
   try {
-    const config = await localforage.getItem('dxos.org/settings/config');
+    const config = await localforage.getItem<Partial<ConfigProto>>('dxos.org/settings/config');
     if (config) {
       return config;
     }
@@ -55,7 +61,7 @@ export const Storage = async () => {
   return {};
 };
 
-export const Remote = (target, authenticationToken) => {
+export const Remote = (target: string | undefined, authenticationToken?: string): Partial<ConfigProto> => {
   if (!target) {
     return {};
   }

package/src/loaders/index.ts

@@ -2,10 +2,11 @@
 // Copyright 2021 DXOS.org
 //
 
-import yaml from 'js-yaml';
 import fs from 'node:fs';
 import path from 'node:path';
 
+import { parse } from 'yaml';
+
 import { log } from '@dxos/log';
 import { type Config as ConfigProto } from '@dxos/protocols/proto/dxos/config';
 
@@ -18,7 +19,7 @@ const DEFAULT_BASE_PATH = path.resolve(process.cwd(), 'config');
 
 const maybeLoadFile = (file: string): any => {
   try {
-    return yaml.load(fs.readFileSync(file, { encoding: 'utf8' }));
+    return parse(fs.readFileSync(file, { encoding: 'utf8' }));
   } catch (err: any) {
     // Ignored.
   }

package/src/plugin/browser.ts

@@ -0,0 +1,11 @@
+//
+// Copyright 2022 DXOS.org
+//
+
+// Browser stub for plugin module - plugins are build-time only.
+
+export type * from './types';
+
+export const definitions = (): Record<string, unknown> => {
+  throw new Error('Config plugin definitions are not available in the browser');
+};

package/src/plugin/definitions.ts

@@ -2,18 +2,21 @@
 // Copyright 2022 DXOS.org
 //
 
-import yaml from 'js-yaml';
 import { execSync } from 'node:child_process';
 import { readFileSync } from 'node:fs';
 import { resolve } from 'node:path';
+
 import pkgUp from 'pkg-up';
+import { parse } from 'yaml';
 
+import { invariant } from '@dxos/invariant';
 import { log } from '@dxos/log';
 import { setDeep } from '@dxos/util';
 
-import { type ConfigPluginOpts } from './types';
 import { mapFromKeyValues } from '../config';
 
+import { type ConfigPluginOpts } from './types';
+
 const CWD = process.cwd();
 
 export const definitions = ({
@@ -28,17 +31,16 @@ export const definitions = ({
     __CONFIG_DEFAULTS__: configPath?.length ? configPath : resolve(CWD, 'dx.yml'),
     __CONFIG_ENVS__: envPath?.length ? envPath : resolve(CWD, 'dx-env.yml'),
   } as { [key: string]: string };
-
   if (mode !== 'production') {
     KEYS_TO_FILE.__CONFIG_LOCAL__ = devPath ?? resolve(CWD, 'dx-local.yml');
   }
 
   return Object.entries(KEYS_TO_FILE).reduce(
     (prev, [key, value]) => {
+      invariant(key);
       let content = {};
-
       try {
-        content = yaml.load(readFileSync(value, 'utf-8')) as any;
+        content = parse(readFileSync(value, 'utf-8')) as any;
 
         // Map environment variables to config values.
         if (key === '__CONFIG_ENVS__') {
@@ -85,10 +87,10 @@ export const definitions = ({
       };
     },
     {
-      __DXOS_CONFIG__: { dynamic: mode === 'production', publicUrl },
       __CONFIG_DEFAULTS__: {},
       __CONFIG_ENVS__: {},
       __CONFIG_LOCAL__: {},
+      __DXOS_CONFIG__: { dynamic: mode === 'production', publicUrl },
     },
   );
 };

package/src/plugin/index.ts

@@ -3,4 +3,4 @@
 //
 
 export * from './definitions';
-export * from './types';
+export type * from './types';

package/src/plugin/types.ts

@@ -3,6 +3,11 @@
 //
 
 export interface ConfigPluginOpts {
+  /**
+   * Root directory of the project.
+   */
+  root?: string;
+
   /**
    * Path to the DX config files, defaults to current working directory.
    */

package/src/plugin/vite-plugin.ts

@@ -3,17 +3,21 @@
 //
 
 import { resolve } from 'node:path';
-import type { Plugin } from 'vite';
+
+import { type Plugin } from 'vite';
 
 import { definitions } from './definitions';
 import { type ConfigPluginOpts } from './types';
 
 export const ConfigPlugin = (options: ConfigPluginOpts = {}): Plugin => ({
   name: 'dxos-config',
-  config: ({ root }) => {
-    const configPath = root && resolve(root, options.configPath ?? 'dx.yml');
-    const envPath = root && resolve(root, options.envPath ?? 'dx-env.yml');
-    const devPath = root && resolve(root, options.devPath ?? 'dx-local.yml');
+  config: () => {
+    // Update paths.
+    const configPath = options.root && resolve(options.root, options.configPath ?? 'dx.yml');
+    const envPath = options.root && resolve(options.root, options.envPath ?? 'dx-env.yml');
+    // TODO(burdon): Change to dx-dev.yml?
+    const devPath = options.root && resolve(options.root, options.devPath ?? 'dx-local.yml');
+
     const define = Object.entries(definitions({ ...options, configPath, envPath, devPath })).reduce(
       (define, [key, value]) => {
         define[key] = JSON.stringify(value);

package/src/preset.ts

@@ -0,0 +1,40 @@
+//
+// Copyright 2025 DXOS.org
+//
+
+import * as Match from 'effect/Match';
+
+import { Config } from './config';
+
+export type ConfigPresetOptions = {
+  /**
+   * Edge service.
+   * @default main
+   */
+  edge?: 'local' | 'dev' | 'main' | 'production';
+};
+
+export const configPreset = ({ edge = 'main' }: ConfigPresetOptions = {}) =>
+  new Config({
+    version: 1,
+    runtime: {
+      client: {
+        edgeFeatures: {
+          signaling: true,
+          echoReplicator: true,
+          feedReplicator: true,
+        },
+      },
+      services: {
+        edge: {
+          url: Match.value(edge).pipe(
+            Match.when('local', () => 'http://localhost:8787'),
+            Match.when('dev', () => 'https://edge.dxos.workers.dev'),
+            Match.when('main', () => 'https://edge-main.dxos.workers.dev'),
+            Match.when('production', () => 'https://edge-production.dxos.workers.dev'),
+            Match.exhaustive,
+          ),
+        },
+      },
+    },
+  });

package/src/savers/{browser.js → browser.ts}

@@ -7,10 +7,11 @@
 import localforage from 'localforage';
 
 import { log } from '@dxos/log';
+import { type Config as ConfigProto } from '@dxos/protocols/proto/dxos/config';
 
 let PERFORMING_CONFIG_SAVE = false;
 
-export const SaveConfig = async (config) => {
+export const SaveConfig = async (config: ConfigProto): Promise<void> => {
   if (PERFORMING_CONFIG_SAVE) {
     log.warn('Already performing config save');
     return;
@@ -21,7 +22,6 @@ export const SaveConfig = async (config) => {
     await localforage.setItem('dxos.org/settings/config', config);
   } catch (err) {
     log.warn('Failed to save config', { err });
-    return {};
   } finally {
     PERFORMING_CONFIG_SAVE = false;
   }

package/src/testing/build.js

@@ -17,5 +17,5 @@ void build({
   outdir: join(__dirname, '../../out'),
   write: true,
   bundle: true,
-  plugins: [ConfigPlugin()],
+  plugins: [ConfigPlugin({ root: __dirname })],
 });

package/README.yml

@@ -1 +0,0 @@
-apiReferenceUrl: https://docs.dxos.org/api/@dxos/config