tyfigo 0.0.0 → 0.1.0-next.398bcc7.0

package/README.md

@@ -1,21 +1,21 @@
 <div align="center">
 
-# tyfig
+# tyfigo
 
 **Import YAML, TOML, JSON5, INI and .env files into TypeScript with full type inference.**
 
-[![GitHub](https://img.shields.io/github/license/imranbarbhuiya/tyfig)](https://github.com/imranbarbhuiya/tyfig/blob/main/LICENSE)
-[![npm](https://img.shields.io/npm/v/tyfig?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/tyfig)
+[![GitHub](https://img.shields.io/github/license/imranbarbhuiya/tyfigo)](https://github.com/imranbarbhuiya/tyfigo/blob/main/LICENSE)
+[![npm](https://img.shields.io/npm/v/tyfigo?color=crimson&logo=npm&style=flat-square)](https://www.npmjs.com/package/tyfigo)
 
 </div>
 
 > [!WARNING]
-> tyfig is in early development and not usable yet.
+> tyfigo is in early development and not usable yet.
 
 ## Install
 
 ```bash
-npm i tyfig
+npm i tyfigo
 ```
 
 ## Buy me some doughnuts
@@ -30,6 +30,6 @@ If you want to support me by donating, you can do so by using any of the followi
 
 Thanks goes to these wonderful people:
 
-<a href="https://github.com/imranbarbhuiya/tyfig/graphs/contributors">
-    <img src="https://contrib.rocks/image?repo=imranbarbhuiya/tyfig" />
+<a href="https://github.com/imranbarbhuiya/tyfigo/graphs/contributors">
+    <img src="https://contrib.rocks/image?repo=imranbarbhuiya/tyfigo" />
 </a>

package/dist/effect.d.mts

@@ -1,13 +1,2 @@
-import { Effect } from "effect";
-declare const EmptyNameError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
-  readonly _tag: "EmptyNameError";
-} & Readonly<A>;
-export declare class EmptyNameError extends EmptyNameError_base {}
-/**
- * Greets someone by name.
- *
- * Fails with {@link EmptyNameError} when the name is blank
- */
-export declare const greet: (name: string) => Effect.Effect<string, EmptyNameError, never>;
-export {};
-//# sourceMappingURL=effect.d.mts.map
+import { a as Problem, c as Span, i as LocatedSpan, n as ResolvedConfig, o as ProblemCode, r as ResolvedLayer, s as Path, t as ResolveOptions } from "./index-_5Tr2XH2.mjs";
+export type { LocatedSpan, Path, Problem, ProblemCode, ResolveOptions, ResolvedConfig, ResolvedLayer, Span };

package/dist/effect.mjs

@@ -1,16 +1 @@
-import { Data, Effect } from "effect";
-// src/effect.ts
-var EmptyNameError = class extends Data.TaggedError("EmptyNameError") {};
-/**
-* Greets someone by name.
-*
-* Fails with {@link EmptyNameError} when the name is blank
-*/
-const greet = Effect.fn("greet")(function* (name) {
-	const trimmed = name.trim();
-	if (trimmed === "") return yield* new EmptyNameError();
-	return `Hello, ${trimmed}!`;
-});
-export { EmptyNameError, greet };
-
-//# sourceMappingURL=effect.mjs.map
+export {};

package/dist/index-_5Tr2XH2.d.mts

@@ -0,0 +1,106 @@
+import { Effect } from "effect";
+/**
+ * A key path into a config value. Strings are object keys and numbers are array indices.
+ */
+type Path = readonly (string | number)[];
+/**
+ * Where a key and its value sit in the source, in UTF-8 byte offsets.
+ *
+ * Array elements have no key, so their key span is the same as their value span. The root (`[]`) spans the whole document value.
+ */
+interface Span {
+  readonly path: Path;
+  readonly keyStart: number;
+  readonly keyLength: number;
+  readonly valueStart: number;
+  readonly valueLength: number;
+}
+/**
+ * Spans keyed by {@link pathKey}.
+ */
+type PositionMap = ReadonlyMap<string, Span>;
+type ProblemCode = 'parse-error' | 'duplicate-key' | 'file-not-found' | 'read-error' | 'unsupported-file' | 'missing-variable' | 'invalid-placeholder' | 'browser-placeholder' | 'unknown-key' | 'type-mismatch';
+/**
+ * Something wrong with a config file. `start` and `length` are UTF-8 byte offsets, `line` and `column` are 1-based and
+ * `column` counts UTF-16 code units.
+ */
+interface Problem {
+  readonly file: string;
+  readonly start: number;
+  readonly length: number;
+  readonly line: number;
+  readonly column: number;
+  readonly message: string;
+  readonly code: ProblemCode;
+}
+type EnvVariables = Readonly<Record<string, string | undefined>>;
+type FormatName = 'yaml' | 'toml' | 'jsonc' | 'json5';
+/**
+ * A parsed config file. `value` is `undefined` when the file could not be parsed at all. An empty file is `{}`.
+ */
+interface ParseResult {
+  readonly value: unknown;
+  readonly positions: PositionMap;
+  readonly problems: readonly Problem[];
+}
+interface Format {
+  readonly name: FormatName;
+  readonly parse: (text: string, file?: string) => ParseResult;
+  /**
+   * Reads the text a whole-value placeholder resolved to with the format's scalar rules. Returns the text itself when it is not a
+   * number, boolean or null.
+   */
+  readonly parseScalar: (text: string) => unknown;
+}
+type LayerKind = 'base' | 'environment' | 'local' | 'environment-local';
+/**
+ * A {@link Span} together with the file it is in.
+ */
+interface LocatedSpan extends Span {
+  readonly file: string;
+}
+interface ResolveOptions {
+  /**
+   * The real environment variables, which win over every `.env` file. Defaults to a copy of the current ones.
+   */
+  readonly env?: EnvVariables | undefined;
+  /**
+   * The environment name that picks `app.<environment>.config.yaml` and `.env.<environment>`. Defaults to `env.NODE_ENV`.
+   */
+  readonly environment?: string | undefined;
+  /**
+   * The layer kinds to read. Defaults to all of them.
+   */
+  readonly layers?: readonly LayerKind[] | undefined;
+}
+interface ResolvedLayer {
+  readonly file: string;
+  readonly kind: LayerKind;
+  readonly text: string;
+  /**
+   * The parsed value with placeholders resolved, or `undefined` when the file could not be parsed.
+   */
+  readonly value: unknown;
+  readonly positions: PositionMap;
+}
+interface ResolvedConfig {
+  /**
+   * The base file, resolved to an absolute path.
+   */
+  readonly file: string;
+  readonly format: Format | undefined;
+  readonly environment: string | undefined;
+  /**
+   * The merged value, or `undefined` when the base file is missing or could not be parsed.
+   */
+  readonly value: unknown;
+  readonly layers: readonly ResolvedLayer[];
+  readonly envFiles: readonly string[];
+  /**
+   * Where each key path of `value` came from, keyed by `pathKey`.
+   */
+  readonly positions: ReadonlyMap<string, LocatedSpan>;
+  readonly problems: readonly Problem[];
+}
+export { Problem as a, Span as c, LocatedSpan as i, ResolvedConfig as n, ProblemCode as o, ResolvedLayer as r, Path as s, ResolveOptions as t };
+//# sourceMappingURL=index-_5Tr2XH2.d.mts.map

package/dist/index.d.mts

@@ -1,10 +1,2 @@
-import { EmptyNameError } from "./effect.mjs";
-/**
- * Greets someone by name.
- *
- * @param name - The name to greet
- * @returns The greeting, or rejects with {@link EmptyNameError} when the name is blank
- */
-export declare const greet: (name: string) => Promise<string>;
-export { EmptyNameError };
-//# sourceMappingURL=index.d.mts.map
+import { a as Problem, c as Span, i as LocatedSpan, n as ResolvedConfig, o as ProblemCode, r as ResolvedLayer, s as Path, t as ResolveOptions } from "./index-_5Tr2XH2.mjs";
+export type { LocatedSpan, Path, Problem, ProblemCode, ResolveOptions, ResolvedConfig, ResolvedLayer, Span };

package/dist/index.mjs

@@ -1,13 +1 @@
-import { EmptyNameError, greet as greet$1 } from "./effect.mjs";
-import { Effect } from "effect";
-// src/index.ts
-/**
-* Greets someone by name.
-*
-* @param name - The name to greet
-* @returns The greeting, or rejects with {@link EmptyNameError} when the name is blank
-*/
-const greet = (name) => Effect.runPromise(greet$1(name));
-export { EmptyNameError, greet };
-
-//# sourceMappingURL=index.mjs.map
+export {};

package/dist/runtime/index.d.mts

@@ -0,0 +1,93 @@
+import { a as Problem, s as Path } from "../index-_5Tr2XH2.mjs";
+import { Effect } from "effect";
+export type LoadTarget = 'server' | 'browser';
+export interface LoadOptions {
+  /**
+   * `server` resolves the config when the module runs. `browser` inlines the base and environment files at build time and
+   * reports every placeholder as a problem.
+   */
+  readonly target: LoadTarget;
+  /**
+   * The environment name, such as the bundler's mode. Defaults to `NODE_ENV`, read when the server module runs and when
+   * `load` runs for the browser.
+   */
+  readonly environment?: string | undefined;
+  /**
+   * The specifier the server module imports the runtime from. Defaults to `tyfigo/runtime`.
+   */
+  readonly runtime?: string | undefined;
+}
+export interface LoadResult {
+  /**
+   * The JavaScript module, with the config as its default export.
+   */
+  readonly code: string;
+  /**
+   * Every file whose creation, change or removal changes the module, whether or not it exists now.
+   */
+  readonly watchFiles: readonly string[];
+  readonly problems: readonly Problem[];
+}
+/**
+ * Generates the JavaScript module for a config file import. Loaders fail the import or build when `problems` is not empty.
+ */
+export declare const loadModule: (path: string, options: LoadOptions) => Effect.Effect<{
+  code: string;
+  watchFiles: string[];
+  problems: Problem[];
+}, never, never>;
+/**
+ * {@link loadModule} for synchronous callers such as Node `registerHooks` load hooks.
+ */
+export declare const load: (path: string, options: LoadOptions) => LoadResult;
+/**
+ * The key of the non-enumerable {@link ConfigSource} on a config object exported by a generated server module.
+ */
+export declare const configSource: unique symbol;
+export interface SourcePosition {
+  readonly file: string;
+  readonly line: number;
+  readonly column: number;
+}
+export interface ConfigSource {
+  /**
+   * The base config file, as an absolute path.
+   */
+  readonly file: string;
+  readonly environment: string | undefined;
+  /**
+   * The layer files that were merged, in the order they apply.
+   */
+  readonly layers: readonly string[];
+  /**
+   * The `.env` files that were read, in the order they apply.
+   */
+  readonly envFiles: readonly string[];
+  /**
+   * Where the value at `path` was set. A path the config does not have resolves to its nearest ancestor that it does have.
+   */
+  readonly position: (path: Path) => SourcePosition | undefined;
+}
+declare const ConfigModuleError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+  readonly _tag: "ConfigModuleError";
+} & Readonly<A>;
+export declare class ConfigModuleError extends ConfigModuleError_base<{
+  readonly message: string;
+  readonly file: string;
+  readonly problems: readonly Problem[];
+}> {}
+export interface ConfigModuleOptions {
+  /**
+   * The environment name that picks `app.<environment>.config.yaml` and `.env.<environment>`. Defaults to `NODE_ENV`.
+   */
+  readonly environment?: string | undefined;
+}
+export declare const deepFreeze: <T>(value: T) => T;
+export declare const getConfigSource: (value: unknown) => ConfigSource | undefined;
+/**
+ * Resolves a config file with its layers, `.env` files and placeholders, and returns the deep-frozen value. This is what a
+ * generated server module calls when it is evaluated. Throws a {@link ConfigModuleError} listing every problem.
+ */
+export declare const resolveConfigModule: (file: string, options?: ConfigModuleOptions) => unknown;
+export {};
+//# sourceMappingURL=index.d.mts.map