@effected/xdg 0.2.1 → 0.4.0

package/README.md

@@ -8,7 +8,7 @@
 XDG Base Directory resolution for Effect. `Xdg` reads the environment — `$HOME`, the four `*_HOME` variables, `$XDG_RUNTIME_DIR`, and the `$XDG_CONFIG_DIRS` / `$XDG_DATA_DIRS` search paths — once, at layer construction. `AppDirs` turns that into the config, data, cache, state and runtime directories for one application namespace, with on-demand creation. `NativeDirs` supplies the macOS and Windows conventions for applications that want them, and `XdgConfig` plugs the whole thing into [`@effected/config-file`](../config-file) as a resolver chain and a save target.
 
 > **Pre-release.** This package is part of the `@effected/*` kit, in pre-`1.0.0`
-> development against a single pinned Effect v4 beta. Packages graduate to
+> development against a single pinned Effect v4 prerelease. Packages graduate to
 > `1.0.0` once Effect `4.0.0` ships. To hold your own `effect` versions at
 > exactly the ones the kit is built and tested against, install
 > [`@effected/pnpm-plugin-effect`](https://www.npmjs.com/package/@effected/pnpm-plugin-effect).

package/index.d.ts

@@ -11,13 +11,13 @@ import { ConfigResolver } from "@effected/config-file";
  *
  * @public
  */
-declare const XdgPlatform: Schema.Literals<readonly ["aix", "android", "darwin", "freebsd", "haiku", "linux", "openbsd", "sunos", "win32", "cygwin", "netbsd"]>;
+export declare const XdgPlatform: Schema.Literals<readonly ["aix", "android", "darwin", "freebsd", "haiku", "linux", "openbsd", "sunos", "win32", "cygwin", "netbsd"]>;
 /**
  * The decoded form of {@link (XdgPlatform:variable)}.
  *
  * @public
  */
-type XdgPlatform = typeof XdgPlatform.Type;
+export type XdgPlatform = typeof XdgPlatform.Type;
 /**
  * The platform every native-directory decision is taken against.
  *
@@ -30,7 +30,7 @@ type XdgPlatform = typeof XdgPlatform.Type;
  *
  * @public
  */
-declare const CurrentPlatform: Context.Reference<XdgPlatform>;
+export declare const CurrentPlatform: Context.Reference<XdgPlatform>;
 declare const XdgEnvError_base: Schema.Class<XdgEnvError, Schema.TaggedStruct<"XdgEnvError", {
   /** The environment variable that was required and not found. */
   readonly variable: Schema.String;
@@ -47,7 +47,7 @@ declare const XdgEnvError_base: Schema.Class<XdgEnvError, Schema.TaggedStruct<"X
  *
  * @public
  */
-declare class XdgEnvError extends XdgEnvError_base {
+export declare class XdgEnvError extends XdgEnvError_base {
   get message(): string;
 }
 declare const XdgPaths_base: Schema.Class<XdgPaths, Schema.Struct<{
@@ -88,7 +88,7 @@ declare const XdgPaths_base: Schema.Class<XdgPaths, Schema.Struct<{
  *
  * @public
  */
-declare class XdgPaths extends XdgPaths_base {}
+export declare class XdgPaths extends XdgPaths_base {}
 declare const Xdg_base: Context.ServiceClass<Xdg, "@effected/xdg/Xdg", XdgPaths>;
 /**
  * XDG Base Directory environment resolution.
@@ -103,7 +103,7 @@ declare const Xdg_base: Context.ServiceClass<Xdg, "@effected/xdg/Xdg", XdgPaths>
  *
  * @public
  */
-declare class Xdg extends Xdg_base {
+export declare class Xdg extends Xdg_base {
   /**
    * Read the XDG environment through Effect's `Config`.
    *
@@ -130,13 +130,13 @@ declare class Xdg extends Xdg_base {
  *
  * @public
  */
-declare const AppDirKind: Schema.Literals<readonly ["config", "data", "cache", "state", "runtime"]>;
+export declare const AppDirKind: Schema.Literals<readonly ["config", "data", "cache", "state", "runtime"]>;
 /**
  * The decoded form of {@link (AppDirKind:variable)}.
  *
  * @public
  */
-type AppDirKind = typeof AppDirKind.Type;
+export type AppDirKind = typeof AppDirKind.Type;
 declare const AppDirsError_base: Schema.Class<AppDirsError, Schema.TaggedStruct<"AppDirsError", {
   /** Which directory kind failed. */
   readonly directory: Schema.Literals<readonly ["config", "data", "cache", "state", "runtime"]>;
@@ -158,7 +158,7 @@ declare const AppDirsError_base: Schema.Class<AppDirsError, Schema.TaggedStruct<
  *
  * @public
  */
-declare class AppDirsError extends AppDirsError_base {
+export declare class AppDirsError extends AppDirsError_base {
   get message(): string;
 }
 declare const ResolvedAppDirs_base: Schema.Class<ResolvedAppDirs, Schema.Struct<{
@@ -197,7 +197,7 @@ declare const ResolvedAppDirs_base: Schema.Class<ResolvedAppDirs, Schema.Struct<
  *
  * @public
  */
-declare class ResolvedAppDirs extends ResolvedAppDirs_base {}
+export declare class ResolvedAppDirs extends ResolvedAppDirs_base {}
 /**
  * Per-kind absolute directory overrides. Each wins outright over every other rung.
  *
@@ -306,7 +306,7 @@ declare const AppDirs_base: Context.ServiceClass<AppDirs, "@effected/xdg/AppDirs
  *
  * @public
  */
-declare class AppDirs extends AppDirs_base {
+export declare class AppDirs extends AppDirs_base {
   /**
    * Resolve the namespace's directories against the ambient {@link Xdg}
    * environment and platform.
@@ -341,7 +341,7 @@ declare const NativeDirs_base: Schema.Class<NativeDirs, Schema.Struct<{
  *
  * @public
  */
-declare class NativeDirs extends NativeDirs_base {
+export declare class NativeDirs extends NativeDirs_base {
   /**
    * Map a platform and an environment onto the native directories for a namespace.
    *
@@ -377,7 +377,7 @@ declare class NativeDirs extends NativeDirs_base {
  *
  * @public
  */
-declare class XdgConfig {
+export declare class XdgConfig {
   private constructor();
   /**
    * Search the app's XDG config search path for `filename`.
@@ -447,5 +447,5 @@ declare class XdgConfig {
   static readonly savePath: (filename: string) => Effect.Effect<string, never, AppDirs | Path.Path>;
 }
 //#endregion
-export { AppDirKind, type AppDirOverrides, AppDirs, AppDirsError, type AppDirsOptions, type AppDirsShape, CurrentPlatform, NativeDirs, ResolvedAppDirs, Xdg, XdgConfig, XdgEnvError, XdgPaths, XdgPlatform };
+export type { AppDirOverrides, AppDirsOptions, AppDirsShape };
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/xdg",
-	"version": "0.2.1",
+	"version": "0.4.0",
 	"private": false,
 	"description": "XDG Base Directory resolution for Effect: environment paths, app-namespaced directories, native OS conventions and config-file resolvers.",
 	"keywords": [
@@ -38,9 +38,9 @@
 		"./package.json": "./package.json"
 	},
 	"peerDependencies": {
-		"@effected/config-file": "^0.4.0",
-		"@effected/walker": "^0.4.0",
-		"effect": "4.0.0-beta.107"
+		"@effected/config-file": "^0.6.0",
+		"@effected/walker": "^0.6.0",
+		"effect": "4.0.0-rc.112"
 	},
 	"engines": {
 		"node": ">=24.11.0"

package/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.58.12"
+      "packageVersion": "7.59.0"
     }
   ]
 }