@elaraai/east-web-std 1.0.85

package/dist/src/path.d.ts

@@ -0,0 +1,243 @@
+/**
+ * Copyright (c) 2025 Elara AI Pty Ltd
+ * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
+ */
+import { StringType, ArrayType } from "@elaraai/east";
+import type { PlatformFunction } from "@elaraai/east/internal";
+/**
+ * Joins path segments into a single path.
+ *
+ * Combines an array of path segments with a forward-slash (`/`) separator on every platform.
+ * Normalizes the resulting path by resolving `.` and `..` segments. Empty segments
+ * are ignored.
+ *
+ * This is a platform function for the East language, enabling path joining
+ * in East programs running in a browser.
+ *
+ * @param segments - Array of path segments to join (e.g., ["dir", "subdir", "file.txt"])
+ * @returns The joined path, using forward slashes (`/`) on every platform
+ *
+ * @example
+ * ```ts
+ * const buildPath = East.function([], StringType, $ => {
+ *     const segments = $.let(["home", "user", "documents", "file.txt"], ArrayType(StringType));
+ *     return Path.join(segments);
+ *     // Returns: "home/user/documents/file.txt" on every platform
+ * });
+ * ```
+ */
+export declare const path_join: import("@elaraai/east").PlatformDefinition<[ArrayType<StringType>], StringType>;
+/**
+ * Resolves a path to an absolute path.
+ *
+ * Converts a relative path to an absolute path by resolving it against the current
+ * working directory. If the path is already absolute, it is normalized and returned.
+ * Resolves `.` and `..` segments to their actual locations.
+ *
+ * This is a platform function for the East language, enabling path resolution
+ * in East programs running in a browser. A browser has no working directory,
+ * so a relative path resolves against the root, `/`.
+ *
+ * @param path - The path to resolve (relative or absolute)
+ * @returns The absolute path
+ *
+ * @example
+ * ```ts
+ * const getAbsolutePath = East.function([], StringType, $ => {
+ *     return Path.resolve("documents/../file.txt");
+ *     // Returns: "/file.txt"
+ * });
+ * ```
+ */
+export declare const path_resolve: import("@elaraai/east").PlatformDefinition<[StringType], StringType>;
+/**
+ * Gets the directory name from a path.
+ *
+ * Extracts the directory portion of a path by removing the last segment (file name).
+ * Similar to the Unix `dirname` command. Trailing path separators are ignored.
+ *
+ * This is a platform function for the East language, enabling directory extraction
+ * in East programs running in a browser.
+ *
+ * @param path - The file path to extract directory from
+ * @returns The directory portion of the path
+ *
+ * @example
+ * ```ts
+ * const getDir = East.function([], StringType, $ => {
+ *     return Path.dirname("/home/user/documents/file.txt");
+ *     // Returns: "/home/user/documents"
+ * });
+ * ```
+ */
+export declare const path_dirname: import("@elaraai/east").PlatformDefinition<[StringType], StringType>;
+/**
+ * Gets the base name (file name) from a path.
+ *
+ * Extracts the last segment of a path, typically the file name. Similar to the Unix
+ * `basename` command. Trailing path separators are ignored.
+ *
+ * This is a platform function for the East language, enabling filename extraction
+ * in East programs running in a browser.
+ *
+ * @param path - The file path to extract filename from
+ * @returns The file name portion of the path (including extension)
+ *
+ * @example
+ * ```ts
+ * const getFilename = East.function([], StringType, $ => {
+ *     return Path.basename("/home/user/documents/file.txt");
+ *     // Returns: "file.txt"
+ * });
+ * ```
+ */
+export declare const path_basename: import("@elaraai/east").PlatformDefinition<[StringType], StringType>;
+/**
+ * Gets the file extension from a path.
+ *
+ * Extracts the file extension from a path, including the leading dot. If the path
+ * has no extension or ends with a dot, returns an empty string. Only returns the
+ * last extension if multiple dots are present.
+ *
+ * This is a platform function for the East language, enabling extension extraction
+ * in East programs running in a browser.
+ *
+ * @param path - The file path to extract extension from
+ * @returns The file extension including the dot (e.g., ".txt"), or empty string if none
+ *
+ * @example
+ * ```ts
+ * const getExtension = East.function([], StringType, $ => {
+ *     return Path.extname("/home/user/documents/file.txt");
+ *     // Returns: ".txt"
+ * });
+ * ```
+ */
+export declare const path_extname: import("@elaraai/east").PlatformDefinition<[StringType], StringType>;
+/**
+ * Browser implementation of path platform functions.
+ *
+ * Pass this array to {@link East.compile} to enable path operations.
+ */
+declare const PathImpl: PlatformFunction[];
+/**
+ * Grouped path manipulation platform functions.
+ *
+ * Provides path utilities for East programs.
+ *
+ * @example
+ * ```ts
+ * import { East, StringType, ArrayType } from "@elaraai/east";
+ * import { Path } from "@elaraai/east-web-std";
+ *
+ * const buildPath = East.function([], StringType, $ => {
+ *     const segments = $.let(["dir", "subdir", "file.txt"], ArrayType(StringType));
+ *     const fullPath = $.let(Path.join(segments));
+ *     const ext = $.let(Path.extname(fullPath));
+ *     return fullPath;
+ * });
+ *
+ * const compiled = East.compile(buildPath, Path.Implementation);
+ * compiled();  // Returns: "dir/subdir/file.txt"
+ * ```
+ */
+export declare const Path: {
+    /**
+     * Joins path segments into a single path.
+     *
+     * Combines an array of path segments with a forward-slash (`/`) separator on every platform.
+     * Normalizes the resulting path and ignores empty segments.
+     *
+     * @param segments - Array of path segments to join
+     * @returns The joined path, using forward slashes (`/`) on every platform
+     *
+     * @example
+     * ```ts
+     * const buildPath = East.function([], StringType, $ => {
+     *     const segments = $.let(["home", "user", "file.txt"], ArrayType(StringType));
+     *     return Path.join(segments);
+     * });
+     * ```
+     */
+    readonly join: import("@elaraai/east").PlatformDefinition<[ArrayType<StringType>], StringType>;
+    /**
+     * Resolves a path to an absolute path.
+     *
+     * Converts a relative path to an absolute path by resolving it against the
+     * working directory, which in a browser is the root, `/`. Normalizes the
+     * path and resolves `.` and `..` segments.
+     *
+     * @param path - The path to resolve (relative or absolute)
+     * @returns The absolute path
+     *
+     * @example
+     * ```ts
+     * const getAbsolutePath = East.function([], StringType, $ => {
+     *     return Path.resolve("documents/../file.txt");  // "/file.txt"
+     * });
+     * ```
+     */
+    readonly resolve: import("@elaraai/east").PlatformDefinition<[StringType], StringType>;
+    /**
+     * Gets the directory name from a path.
+     *
+     * Extracts the directory portion of a path by removing the last segment (file name).
+     * Trailing path separators are ignored.
+     *
+     * @param path - The file path to extract directory from
+     * @returns The directory portion of the path
+     *
+     * @example
+     * ```ts
+     * const getDir = East.function([], StringType, $ => {
+     *     return Path.dirname("/home/user/documents/file.txt");
+     * });
+     * ```
+     */
+    readonly dirname: import("@elaraai/east").PlatformDefinition<[StringType], StringType>;
+    /**
+     * Gets the base name (file name) from a path.
+     *
+     * Extracts the last segment of a path, typically the file name.
+     * Trailing path separators are ignored.
+     *
+     * @param path - The file path to extract filename from
+     * @returns The file name portion of the path (including extension)
+     *
+     * @example
+     * ```ts
+     * const getFilename = East.function([], StringType, $ => {
+     *     return Path.basename("/home/user/documents/file.txt");
+     * });
+     * ```
+     */
+    readonly basename: import("@elaraai/east").PlatformDefinition<[StringType], StringType>;
+    /**
+     * Gets the file extension from a path.
+     *
+     * Extracts the file extension from a path, including the leading dot.
+     * Returns empty string if no extension exists.
+     *
+     * @param path - The file path to extract extension from
+     * @returns The file extension including the dot (e.g., ".txt"), or empty string
+     *
+     * @example
+     * ```ts
+     * const getExtension = East.function([], StringType, $ => {
+     *     return Path.extname("file.txt");
+     * });
+     *
+     * const compiled = East.compile(getExtension, Path.Implementation);
+     * compiled();  // Returns: ".txt"
+     * ```
+     */
+    readonly extname: import("@elaraai/east").PlatformDefinition<[StringType], StringType>;
+    /**
+     * Browser implementation of path platform functions.
+     *
+     * Pass this to {@link East.compile} to enable path operations.
+     */
+    readonly Implementation: PlatformFunction[];
+};
+export { PathImpl };
+//# sourceMappingURL=path.d.ts.map

package/dist/src/path.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path.d.ts","sourceRoot":"","sources":["../../src/path.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAQ,UAAU,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAkR/D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,SAAS,iFAAkE,CAAC;AAEzF;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,YAAY,sEAA0D,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,YAAY,sEAA0D,CAAC;AAEpF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,aAAa,sEAA2D,CAAC;AAEtF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,YAAY,sEAA0D,CAAC;AAEpF;;;;GAIG;AACH,QAAA,MAAM,QAAQ,EAAE,gBAAgB,EAmD/B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,IAAI;IACb;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;;OAgBG;;IAGH;;;;;;;;;;;;;;;OAeG;;IAGH;;;;;;;;;;;;;;;OAeG;;IAGH;;;;;;;;;;;;;;;;;;OAkBG;;IAGH;;;;OAIG;;CAEG,CAAC;AAGX,OAAO,EAAE,QAAQ,EAAE,CAAC"}