@farm.js/core 0.1.0-beta.0

package/dist/types-C9N-nk5R.d.mts

@@ -0,0 +1,53 @@
+import { DocsConfig } from '@farming-labs/docs';
+
+interface FarmDocsSidebarItem {
+    label?: string;
+    title?: string;
+    slug?: string;
+    href?: string;
+    icon?: string;
+    children?: FarmDocsSidebarItem[];
+    items?: FarmDocsSidebarItem[];
+}
+interface FarmDocsNavigationConfig {
+    sidebar?: FarmDocsSidebarItem[];
+}
+type FarmDocsRuntimeConfig = Partial<DocsConfig> & {
+    /**
+     * Public favicon URL used by the standalone docs renderer.
+     * Set this explicitly when docs should share the host application's icon.
+     */
+    favicon?: string;
+    /**
+     * Optional serializable navigation tree used by Farm's docs runtime.
+     * Icon values reference keys from `icons`.
+     */
+    navigation?: FarmDocsNavigationConfig;
+};
+type FarmDocsConfigInput = FarmDocsRuntimeConfig & {
+    /**
+     * Farm public route for docs, e.g. "/docs". When passed through
+     * `config`, this is converted to the docs package's folder-style `entry`.
+     */
+    entry?: string;
+    /** Explicit public route prefix. Defaults to `entry`. */
+    docsPath?: string;
+    /** Source content directory, relative to the project root. */
+    contentDir?: string;
+    /** Set to false to opt out even when a docs config file exists. */
+    enabled?: boolean;
+    /** Inline @farming-labs/docs config object. */
+    config?: FarmDocsRuntimeConfig;
+    /** Path to docs.config.* or docs.json. */
+    configPath?: string;
+};
+type FarmDocsUserConfig = boolean | FarmDocsConfigInput;
+interface FarmDocsResolvedConfig {
+    enabled: boolean;
+    entry: string;
+    contentDir?: string;
+    configPath?: string;
+    config: FarmDocsRuntimeConfig & Pick<DocsConfig, "entry">;
+}
+
+export type { FarmDocsResolvedConfig as F, FarmDocsUserConfig as a, FarmDocsConfigInput as b, FarmDocsNavigationConfig as c, FarmDocsSidebarItem as d };

package/dist/types-C9N-nk5R.d.ts

@@ -0,0 +1,53 @@
+import { DocsConfig } from '@farming-labs/docs';
+
+interface FarmDocsSidebarItem {
+    label?: string;
+    title?: string;
+    slug?: string;
+    href?: string;
+    icon?: string;
+    children?: FarmDocsSidebarItem[];
+    items?: FarmDocsSidebarItem[];
+}
+interface FarmDocsNavigationConfig {
+    sidebar?: FarmDocsSidebarItem[];
+}
+type FarmDocsRuntimeConfig = Partial<DocsConfig> & {
+    /**
+     * Public favicon URL used by the standalone docs renderer.
+     * Set this explicitly when docs should share the host application's icon.
+     */
+    favicon?: string;
+    /**
+     * Optional serializable navigation tree used by Farm's docs runtime.
+     * Icon values reference keys from `icons`.
+     */
+    navigation?: FarmDocsNavigationConfig;
+};
+type FarmDocsConfigInput = FarmDocsRuntimeConfig & {
+    /**
+     * Farm public route for docs, e.g. "/docs". When passed through
+     * `config`, this is converted to the docs package's folder-style `entry`.
+     */
+    entry?: string;
+    /** Explicit public route prefix. Defaults to `entry`. */
+    docsPath?: string;
+    /** Source content directory, relative to the project root. */
+    contentDir?: string;
+    /** Set to false to opt out even when a docs config file exists. */
+    enabled?: boolean;
+    /** Inline @farming-labs/docs config object. */
+    config?: FarmDocsRuntimeConfig;
+    /** Path to docs.config.* or docs.json. */
+    configPath?: string;
+};
+type FarmDocsUserConfig = boolean | FarmDocsConfigInput;
+interface FarmDocsResolvedConfig {
+    enabled: boolean;
+    entry: string;
+    contentDir?: string;
+    configPath?: string;
+    config: FarmDocsRuntimeConfig & Pick<DocsConfig, "entry">;
+}
+
+export type { FarmDocsResolvedConfig as F, FarmDocsUserConfig as a, FarmDocsConfigInput as b, FarmDocsNavigationConfig as c, FarmDocsSidebarItem as d };

package/dist/types-D1A6-XvH.d.mts

@@ -0,0 +1,73 @@
+import { ConnectorOptions } from 'db0';
+import { BuiltinDriverOptions, BuiltinDriverName, Driver, Storage } from 'unstorage';
+
+type ObjectShape<T> = T extends object ? T : Record<string, never>;
+type FarmStorageBuiltinDriverWithoutDB0 = Exclude<Extract<BuiltinDriverName, keyof BuiltinDriverOptions>, "db0">;
+type FarmStorageBuiltinDriverConfigMap = {
+    [K in FarmStorageBuiltinDriverWithoutDB0]: {
+        driver: K;
+        options?: BuiltinDriverOptions[K];
+    } & Partial<ObjectShape<BuiltinDriverOptions[K]>>;
+};
+type FarmStorageDatabaseDriverMap = {
+    sqlite: "node-sqlite";
+    "node-sqlite": "node-sqlite";
+    sqlite3: "sqlite3";
+    "better-sqlite3": "better-sqlite3";
+    postgres: "postgresql";
+    postgresql: "postgresql";
+    pg: "postgresql";
+    mysql: "mysql2";
+    mysql2: "mysql2";
+    pglite: "pglite";
+    planetscale: "planetscale";
+    libsql: "libsql";
+    "libsql-node": "libsql-node";
+    "libsql-http": "libsql-http";
+};
+type FarmStorageDatabaseDriverName = keyof FarmStorageDatabaseDriverMap;
+type FarmStorageDatabaseConfigMap = {
+    [K in FarmStorageDatabaseDriverName]: {
+        driver: K;
+        options?: ConnectorOptions[FarmStorageDatabaseDriverMap[K]];
+        tableName?: string;
+    } & Partial<ObjectShape<ConnectorOptions[FarmStorageDatabaseDriverMap[K]]>>;
+};
+type FarmStorageMemoryDriverConfig = {
+    driver?: "memory";
+};
+type FarmStorageLocalDriverConfig = {
+    driver: "local";
+    options?: BuiltinDriverOptions["fs-lite"];
+} & Partial<ObjectShape<BuiltinDriverOptions["fs-lite"]>>;
+type FarmStorageDB0DriverConfig = {
+    driver: "db0";
+    options: BuiltinDriverOptions["db0"];
+};
+type FarmStorageBuiltinDriverConfig = FarmStorageMemoryDriverConfig | FarmStorageLocalDriverConfig | FarmStorageDB0DriverConfig | FarmStorageBuiltinDriverConfigMap[FarmStorageBuiltinDriverWithoutDB0];
+interface FarmStorageClient extends Storage {
+    readonly kind: "farm-storage-client";
+    ready(): Promise<Storage>;
+    createStorage(): Promise<Storage>;
+    resolveDriver(): Promise<Driver>;
+}
+type FarmStorageRuntimeClient = object | (() => unknown | Promise<unknown>);
+interface FarmStorageCustomDriverConfig {
+    driver: Driver | (() => Driver | Promise<Driver>);
+}
+type FarmStorageDatabaseConfig = FarmStorageDatabaseConfigMap[FarmStorageDatabaseDriverName];
+type FarmStorageClientConfig = FarmStorageBuiltinDriverConfig | FarmStorageDatabaseConfig | FarmStorageCustomDriverConfig;
+type FarmStorageMountConfig = FarmStorageClientConfig | FarmStorageClient;
+type FarmStorageMounts = Record<string, FarmStorageMountConfig>;
+type FarmStorageConfigObject = FarmStorageClientConfig & {
+    /**
+     * Existing FarmStorageClient instances still drive Farm's key/value storage.
+     * Other objects/functions are treated as application runtime clients for
+     * schema-backed integration persistence via @farming-labs/orm.
+     */
+    client?: FarmStorageClient | FarmStorageRuntimeClient;
+    mounts?: FarmStorageMounts;
+};
+type FarmStorageUserConfig = FarmStorageConfigObject | FarmStorageClient;
+
+export type { FarmStorageBuiltinDriverConfig as F, FarmStorageClient as a, FarmStorageClientConfig as b, FarmStorageConfigObject as c, FarmStorageCustomDriverConfig as d, FarmStorageDatabaseConfig as e, FarmStorageDatabaseDriverName as f, FarmStorageLocalDriverConfig as g, FarmStorageRuntimeClient as h, FarmStorageMountConfig as i, FarmStorageMounts as j, FarmStorageUserConfig as k };

package/dist/types-D1A6-XvH.d.ts

@@ -0,0 +1,73 @@
+import { ConnectorOptions } from 'db0';
+import { BuiltinDriverOptions, BuiltinDriverName, Driver, Storage } from 'unstorage';
+
+type ObjectShape<T> = T extends object ? T : Record<string, never>;
+type FarmStorageBuiltinDriverWithoutDB0 = Exclude<Extract<BuiltinDriverName, keyof BuiltinDriverOptions>, "db0">;
+type FarmStorageBuiltinDriverConfigMap = {
+    [K in FarmStorageBuiltinDriverWithoutDB0]: {
+        driver: K;
+        options?: BuiltinDriverOptions[K];
+    } & Partial<ObjectShape<BuiltinDriverOptions[K]>>;
+};
+type FarmStorageDatabaseDriverMap = {
+    sqlite: "node-sqlite";
+    "node-sqlite": "node-sqlite";
+    sqlite3: "sqlite3";
+    "better-sqlite3": "better-sqlite3";
+    postgres: "postgresql";
+    postgresql: "postgresql";
+    pg: "postgresql";
+    mysql: "mysql2";
+    mysql2: "mysql2";
+    pglite: "pglite";
+    planetscale: "planetscale";
+    libsql: "libsql";
+    "libsql-node": "libsql-node";
+    "libsql-http": "libsql-http";
+};
+type FarmStorageDatabaseDriverName = keyof FarmStorageDatabaseDriverMap;
+type FarmStorageDatabaseConfigMap = {
+    [K in FarmStorageDatabaseDriverName]: {
+        driver: K;
+        options?: ConnectorOptions[FarmStorageDatabaseDriverMap[K]];
+        tableName?: string;
+    } & Partial<ObjectShape<ConnectorOptions[FarmStorageDatabaseDriverMap[K]]>>;
+};
+type FarmStorageMemoryDriverConfig = {
+    driver?: "memory";
+};
+type FarmStorageLocalDriverConfig = {
+    driver: "local";
+    options?: BuiltinDriverOptions["fs-lite"];
+} & Partial<ObjectShape<BuiltinDriverOptions["fs-lite"]>>;
+type FarmStorageDB0DriverConfig = {
+    driver: "db0";
+    options: BuiltinDriverOptions["db0"];
+};
+type FarmStorageBuiltinDriverConfig = FarmStorageMemoryDriverConfig | FarmStorageLocalDriverConfig | FarmStorageDB0DriverConfig | FarmStorageBuiltinDriverConfigMap[FarmStorageBuiltinDriverWithoutDB0];
+interface FarmStorageClient extends Storage {
+    readonly kind: "farm-storage-client";
+    ready(): Promise<Storage>;
+    createStorage(): Promise<Storage>;
+    resolveDriver(): Promise<Driver>;
+}
+type FarmStorageRuntimeClient = object | (() => unknown | Promise<unknown>);
+interface FarmStorageCustomDriverConfig {
+    driver: Driver | (() => Driver | Promise<Driver>);
+}
+type FarmStorageDatabaseConfig = FarmStorageDatabaseConfigMap[FarmStorageDatabaseDriverName];
+type FarmStorageClientConfig = FarmStorageBuiltinDriverConfig | FarmStorageDatabaseConfig | FarmStorageCustomDriverConfig;
+type FarmStorageMountConfig = FarmStorageClientConfig | FarmStorageClient;
+type FarmStorageMounts = Record<string, FarmStorageMountConfig>;
+type FarmStorageConfigObject = FarmStorageClientConfig & {
+    /**
+     * Existing FarmStorageClient instances still drive Farm's key/value storage.
+     * Other objects/functions are treated as application runtime clients for
+     * schema-backed integration persistence via @farming-labs/orm.
+     */
+    client?: FarmStorageClient | FarmStorageRuntimeClient;
+    mounts?: FarmStorageMounts;
+};
+type FarmStorageUserConfig = FarmStorageConfigObject | FarmStorageClient;
+
+export type { FarmStorageBuiltinDriverConfig as F, FarmStorageClient as a, FarmStorageClientConfig as b, FarmStorageConfigObject as c, FarmStorageCustomDriverConfig as d, FarmStorageDatabaseConfig as e, FarmStorageDatabaseDriverName as f, FarmStorageLocalDriverConfig as g, FarmStorageRuntimeClient as h, FarmStorageMountConfig as i, FarmStorageMounts as j, FarmStorageUserConfig as k };

package/dist/utils-DA1yo54_.d.ts

@@ -0,0 +1,23 @@
+import { x as ParsedRoute, w as RouteSegment } from './client-plugins-BZnpeTGA.js';
+
+declare function parseRoutePath(filePath: string): ParsedRoute;
+declare function segmentsToPattern(segments: RouteSegment[]): string;
+declare function matchRoute(url: string, segments: RouteSegment[]): {
+    params: Record<string, string>;
+    matches: boolean;
+};
+declare function resolveAppPath(root: string, ...paths: string[]): string;
+declare function toViteModuleId(filePath: string, root: string): string;
+declare function fileExists(filePath: string): Promise<boolean>;
+declare function globFiles(pattern: string, cwd: string): Promise<string[]>;
+declare function parseSearchParams(searchParams: URLSearchParams): Record<string, string | string[]>;
+declare const logger: {
+    info: (message: string) => void;
+    success: (message: string) => void;
+    warn: (message: string) => void;
+    error: (message: string) => void;
+    ready: (message: string) => void;
+    event: (message: string) => void;
+};
+
+export { parseSearchParams as a, fileExists as f, globFiles as g, logger as l, matchRoute as m, parseRoutePath as p, resolveAppPath as r, segmentsToPattern as s, toViteModuleId as t };

package/dist/utils-DOXXivjL.d.mts

@@ -0,0 +1,23 @@
+import { x as ParsedRoute, w as RouteSegment } from './client-plugins-g4bzuCmo.mjs';
+
+declare function parseRoutePath(filePath: string): ParsedRoute;
+declare function segmentsToPattern(segments: RouteSegment[]): string;
+declare function matchRoute(url: string, segments: RouteSegment[]): {
+    params: Record<string, string>;
+    matches: boolean;
+};
+declare function resolveAppPath(root: string, ...paths: string[]): string;
+declare function toViteModuleId(filePath: string, root: string): string;
+declare function fileExists(filePath: string): Promise<boolean>;
+declare function globFiles(pattern: string, cwd: string): Promise<string[]>;
+declare function parseSearchParams(searchParams: URLSearchParams): Record<string, string | string[]>;
+declare const logger: {
+    info: (message: string) => void;
+    success: (message: string) => void;
+    warn: (message: string) => void;
+    error: (message: string) => void;
+    ready: (message: string) => void;
+    event: (message: string) => void;
+};
+
+export { parseSearchParams as a, fileExists as f, globFiles as g, logger as l, matchRoute as m, parseRoutePath as p, resolveAppPath as r, segmentsToPattern as s, toViteModuleId as t };