@uipath/packager-tool-datafabric 1.201.0-preview.140 → 1.201.0-preview.142

package/dist/init.js

@@ -20651,7 +20651,7 @@ function querystringSingleKey(key, value, keyPrefix = "") {
 var package_default = {
   name: "@uipath/solution-sdk",
   license: "MIT",
-  version: "1.202.0-preview.140",
+  version: "1.202.0-preview.142",
   repository: {
     type: "git",
     url: "https://github.com/UiPath/cli.git",
@@ -24488,4 +24488,4 @@ export {
   entityInitAsync
 };
 
-//# debugId=038D2B0F72059B7064756E2164756E21
+//# debugId=C23089524159D74064756E2164756E21

package/package.json

@@ -1,17 +1,11 @@
 {
     "name": "@uipath/packager-tool-datafabric",
-    "version": "1.201.0-preview.140",
+    "version": "1.201.0-preview.142",
     "description": "UiPath Data Fabric entity schema, validation and packaging library",
     "type": "module",
     "exports": {
-        ".": {
-            "source": "./src/index.ts",
-            "default": "./dist/index.js"
-        },
-        "./init": {
-            "source": "./src/init.ts",
-            "default": "./dist/init.js"
-        }
+        ".": "./dist/index.js",
+        "./init": "./dist/init.js"
     },
     "repository": {
         "type": "git",
@@ -23,13 +17,12 @@
     },
     "types": "./dist/index.d.ts",
     "files": [
-        "dist",
-        "src"
+        "dist"
     ],
     "author": "",
     "license": "ISC",
     "peerDependencies": {
         "@uipath/solutionpackager-tool-core": "1.202.0"
     },
-    "gitHead": "1861498d8a158a710a718c04614523ba59c93781"
+    "gitHead": "2f7204440851d62ecc9f2d2e202c863293821d90"
 }

package/src/index.ts

@@ -1,53 +0,0 @@
-// Data Fabric entity library for the solution packager and its hosts: the CLI
-// via @uipath/data-fabric-tool, the Maestro VS Code extension directly.
-// Side-effect-free: importing this package registers nothing and touches
-// neither disk nor network.
-
-export type { EntityPackDiagnostic } from "./pack/entity-project-tool.js";
-export {
-    ENTITY_VALIDATION_FAILED,
-    EntityProjectTool,
-} from "./pack/entity-project-tool.js";
-export { EntityToolFactory } from "./pack/entity-tool-factory.js";
-export type {
-    PairFailure,
-    PairFailureCode,
-    PairResult,
-} from "./pack/verify-pair.js";
-export { findSolutionRoot, verifyPair } from "./pack/verify-pair.js";
-export type { ResourceParseFailure } from "./resource/resource-io.js";
-export {
-    EntityResourceError,
-    serialize,
-    serializeEntityJson,
-    unwrapResource,
-    updateResourceSchema,
-    wrapEntityJson,
-} from "./resource/resource-io.js";
-export type {
-    ResourceFolderRef,
-    ResourceSpec,
-    SolutionResource,
-    UnifiedResourceFile,
-} from "./resource/unified-resource-file.js";
-export {
-    ENTITY_RESOURCE_API_VERSION,
-    ENTITY_RESOURCE_DOC_VERSION,
-    ENTITY_RESOURCE_KIND,
-    ENTITY_RESOURCE_TYPE,
-    entityResourcePath,
-    SOLUTION_FOLDER,
-} from "./resource/unified-resource-file.js";
-export {
-    createEntitySkeleton,
-    SYSTEM_FIELD_TEMPLATES,
-} from "./schema/create-entity-skeleton.js";
-export type {
-    DiagnosticCode,
-    EntityDiagnostic,
-    ValidateEntityContext,
-} from "./schema/validate-entity.js";
-export { DIAGNOSTIC_CODES, validateEntity } from "./schema/validate-entity.js";
-// `entityInitAsync` is deliberately NOT exported here: it needs the filesystem
-// and solution-sdk, so it lives on the node-only `./init` entry and this module
-// stays browser-safe.

package/src/init/entity-init-service.ts

@@ -1,354 +0,0 @@
-import { catchError, logger } from "@uipath/common";
-import { NAME_PATTERN } from "@uipath/entity-modeler/schema";
-import { getFileSystem } from "@uipath/filesystem";
-import {
-    type AutoCreatedSolution,
-    prepareProjectLocation,
-    readSolutionManifest,
-    tryRegisterProjectInParentSolution,
-    type UipxProject,
-} from "@uipath/solution-sdk";
-import { ENTITY_EXTENSION_CONST as ENTITY_EXTENSION } from "../pack/constants.js";
-import { serialize, wrapEntityJson } from "../resource/resource-io.js";
-import { entityResourcePath } from "../resource/unified-resource-file.js";
-import { createEntitySkeleton } from "../schema/create-entity-skeleton.js";
-
-export type { AutoCreatedSolution };
-
-/** Same rule `maestro-sdk` applies to project names, inlined so the root
- *  module stays free of the SDK. */
-const VALID_PROJECT_NAME_REGEX = /^[a-zA-Z0-9_-]+$/;
-
-export interface EntityInitOptions {
-    /** Initialize even if the target directory exists and is not empty. */
-    force?: boolean;
-    /**
-     * Base dir the bare project `name` resolves against, and what a relative
-     * `uipxPath` resolves against. Required unless `uipxPath` is absolute.
-     */
-    cwd?: string;
-    /**
-     * Path to the parent solution's `.uipx` FILE. Give this when the caller
-     * already knows the manifest — an editor host does — so placement and
-     * registration stop depending on where the process happens to be.
-     *
-     * The project is created at `<dirname(uipxPath)>/<name>`, which is also the
-     * directory registration searches first — so the named manifest is the one
-     * that gets the `Projects[]` entry. Passing it suppresses the auto-scaffold:
-     * a named manifest that does not exist is an error, not a cue to create a
-     * solution.
-     *
-     * Not yet honored when that directory holds more than one `.uipx` — the
-     * SDK's discovery refuses the ambiguity, and the run fails with that reason.
-     *
-     * Omit it to keep the previous behavior: place under `cwd` and take
-     * whichever `.uipx` the upward search finds.
-     */
-    uipxPath?: string;
-    /** The first entity's own Name. */
-    firstEntityName: string;
-}
-
-/**
- * Outcome of registering the project in the parent `.uipx`. Structural mirror of
- * solution-sdk's envelope, so the published `.d.ts` stays free of the private
- * SDK type.
- *
- * Only `Status` is guaranteed: the SDK always returns a status — "Registered",
- * "AlreadyRegistered", "NotInSolution", "OptedOut", "Skipped" or "Failed" — but
- * the rest describe a registration that actually happened, so they are absent
- * when it did not. `Solution` and `ProjectId` are present for the two statuses
- * this service accepts; every other status makes it throw.
- */
-export interface EntityProjectRegistration {
-    Status: string;
-    Message?: string;
-    Instructions?: string;
-    /** Absolute path to the parent `.uipx`. */
-    Solution?: string;
-    /** Solution-relative path to the project file. */
-    Project?: string;
-    /** GUID written into the `.uipx` `Projects[]` entry. */
-    ProjectId?: string;
-}
-
-export interface EntityInitResult {
-    projectName: string;
-    /** Absolute path to the created project directory. */
-    projectDir: string;
-    /** Absolute path to the written `<EntityName>.entity` stub. */
-    entityFile: string;
-    /** Absolute path to the written entity definition resource. */
-    resourceFile: string;
-    registration: EntityProjectRegistration;
-    /** Present when the SDK auto-created the parent solution. */
-    autoCreatedSolution?: AutoCreatedSolution;
-}
-
-/**
- * Scaffolds an Entity project: `project.uiproj`, the `.entity` pointer stub, a
- * `{ Type: "Entity" }` entry in the parent `.uipx` (auto-creating the solution
- * when outside one, like `flowInitAsync`), and the entity definition resource
- * under the solution root.
- *
- * Throws on failure and rolls back what it created. The resource lives outside
- * the project dir, so an Entity project cannot exist without a solution.
- */
-export async function entityInitAsync(
-    name: string,
-    options: EntityInitOptions,
-): Promise<EntityInitResult> {
-    if (!VALID_PROJECT_NAME_REGEX.test(name)) {
-        throw new Error(
-            `Invalid project name "${name}". Name can only contain letters, numbers, underscores (_), and hyphens (-).`,
-        );
-    }
-    const entityName = options.firstEntityName;
-    if (!NAME_PATTERN.test(entityName)) {
-        throw new Error(
-            `Invalid entity name "${entityName}". Entity names start with a letter and contain 3-100 letters or digits.`,
-        );
-    }
-
-    const fs = getFileSystem();
-    const solutionFile = await resolveSolutionFileAsync(options);
-
-    // With a named manifest the location is already decided, so skip
-    // `prepareProjectLocation` entirely — its job is discovery plus the
-    // auto-scaffold fallback, and both are wrong once the caller has told us
-    // which solution to join.
-    const { projectDir, autoCreatedSolution } = solutionFile
-        ? { projectDir: fs.path.join(fs.path.dirname(solutionFile), name) }
-        : await prepareProjectLocation(
-              fs,
-              fs.path.resolve(requireCwd(options), name),
-              name,
-              {},
-          );
-
-    // `stat` resolves to null for a missing path, so the null check — not the
-    // error — is what marks the dir as new. An error here is real I/O failure.
-    const [statError, stat] = await catchError(fs.stat(projectDir));
-    if (statError && !isMissingPathError(statError)) {
-        throw statError;
-    }
-    const projectDirExisted = !statError && stat !== null;
-
-    if (projectDirExisted && !options.force) {
-        const existingEntries = await fs.readdir(projectDir);
-        if (existingEntries.length > 0) {
-            throw new Error(
-                `Directory "${name}" already exists and is not empty. Use --force to overwrite.`,
-            );
-        }
-    }
-
-    /** Undo only what THIS run created: never a pre-existing dir, and never a
-     *  `.uipx` entry that was already there. */
-    let registered: { solutionFile: string; projectId: string } | undefined;
-    const rollback = async (): Promise<void> => {
-        if (registered) {
-            await unregisterProject(registered);
-        }
-        if (!projectDirExisted) {
-            await catchError(fs.rm(projectDir));
-        }
-    };
-
-    try {
-        await fs.mkdir(projectDir);
-
-        await fs.writeFile(
-            fs.path.join(projectDir, "project.uiproj"),
-            serialize({ Name: name, ProjectType: "Entity" }),
-        );
-
-        const relativeResourcePath = entityResourcePath(entityName);
-        const entityFile = fs.path.join(
-            projectDir,
-            `${entityName}${ENTITY_EXTENSION}`,
-        );
-        await fs.writeFile(
-            entityFile,
-            serialize({ name: entityName, resourcePath: relativeResourcePath }),
-        );
-
-        const registration = (await tryRegisterProjectInParentSolution(
-            fs,
-            projectDir,
-            {},
-        )) as EntityProjectRegistration;
-
-        if (
-            registration.Status === "Registered" &&
-            registration.Solution &&
-            registration.ProjectId
-        ) {
-            registered = {
-                solutionFile: registration.Solution,
-                projectId: registration.ProjectId,
-            };
-        }
-
-        if (
-            (registration.Status !== "Registered" &&
-                registration.Status !== "AlreadyRegistered") ||
-            !registration.Solution
-        ) {
-            // No solution → the stub's pointer can never resolve. Fail instead
-            // of scaffolding a broken pair; the catch below rolls back.
-            if (solutionFile && registration.Status === "Skipped") {
-                // Known limit: registration discovers the manifest by walking up,
-                // and it refuses a directory holding more than one `.uipx` — so a
-                // named manifest cannot be honored there yet. Say that plainly
-                // instead of reporting a missing parent solution.
-                throw new Error(
-                    `Entity project "${name}" could not be registered in '${solutionFile}': ` +
-                        `${registration.Instructions ?? registration.Message ?? "registration was skipped"}. ` +
-                        "A solution folder containing more than one .uipx is not supported yet — " +
-                        "register the project with 'uip solution projects add' instead.",
-                );
-            }
-            throw new Error(
-                `Entity project "${name}" requires a parent solution (registration status: ${registration.Status}). ` +
-                    "Run inside a solution directory, or create one first with 'uip solution init'.",
-            );
-        }
-
-        const solutionDir = fs.path.dirname(registration.Solution);
-        const resourceFile = fs.path.join(
-            solutionDir,
-            ...relativeResourcePath.split("/"),
-        );
-        await fs.mkdir(fs.path.dirname(resourceFile));
-        await fs.writeFile(
-            resourceFile,
-            serialize(wrapEntityJson(createEntitySkeleton(entityName))),
-        );
-
-        // No `uip solution project add`-equivalent artifact step here, unlike the
-        // other init paths. The resource engine has no mapping for `Entity`, so
-        // it falls back to its default and writes a `package/` plus a
-        // `process/process/` resource — a process package that will never exist,
-        // since an Entity project emits none: its definition resource above IS
-        // the deployable payload. Pack only needs the `.uipx` Projects[] entry
-        // that registration just wrote.
-
-        return {
-            projectName: name,
-            projectDir,
-            entityFile,
-            resourceFile,
-            registration,
-            autoCreatedSolution,
-        };
-    } catch (error) {
-        await rollback();
-        throw error;
-    }
-}
-
-/**
- * The caller's `cwd`, or a clear error. Only reached on the discovery path —
- * `uipxPath` supplies the base dir itself.
- */
-function requireCwd(options: EntityInitOptions): string {
-    if (!options.cwd) {
-        throw new Error(
-            "Either 'cwd' or 'uipxPath' is required: without one there is no base " +
-                "directory to create the project in.",
-        );
-    }
-    return options.cwd;
-}
-
-/**
- * Resolve `uipxPath` to an absolute, existing `.uipx` file, or `undefined` when
- * the caller did not name one (keep discovering as before).
- *
- * Validated before anything is written, so a bad path fails with a useful
- * message instead of scaffolding a project that cannot be registered.
- */
-async function resolveSolutionFileAsync(
-    options: EntityInitOptions,
-): Promise<string | undefined> {
-    if (!options.uipxPath) {
-        return undefined;
-    }
-
-    const fs = getFileSystem();
-    let resolved: string;
-    if (fs.path.isAbsolute(options.uipxPath)) {
-        resolved = options.uipxPath;
-    } else if (options.cwd) {
-        resolved = fs.path.resolve(options.cwd, options.uipxPath);
-    } else {
-        // Not the same failure as "neither was given": uipxPath IS set, it just
-        // has nothing to resolve against.
-        throw new Error(
-            `uipxPath '${options.uipxPath}' is relative and no 'cwd' was given to resolve it against. ` +
-                "Pass an absolute path, or set 'cwd'.",
-        );
-    }
-
-    if (!resolved.endsWith(".uipx")) {
-        throw new Error(
-            `uipxPath must point at a .uipx file, got '${resolved}'. Pass the manifest itself, not its directory.`,
-        );
-    }
-
-    const [statError, stat] = await catchError(fs.stat(resolved));
-    if (statError || stat === null) {
-        throw new Error(
-            `Solution manifest not found: '${resolved}'. Create the solution first, or omit uipxPath to search for one.`,
-        );
-    }
-    if (stat.isDirectory()) {
-        throw new Error(
-            `uipxPath must point at a .uipx file, but '${resolved}' is a directory.`,
-        );
-    }
-
-    return resolved;
-}
-
-function isMissingPathError(error: Error): boolean {
-    return (
-        "code" in error &&
-        (error.code === "ENOENT" || error.code === "PathNotFound")
-    );
-}
-
-/**
- * Drop the `Projects[]` entry this run added to the parent `.uipx`. Best-effort:
- * rollback runs while another error is already heading to the caller, so a
- * failure here is logged rather than thrown.
- */
-async function unregisterProject(registered: {
-    solutionFile: string;
-    projectId: string;
-}): Promise<void> {
-    const { solutionFile, projectId } = registered;
-    const fs = getFileSystem();
-    const [readError, solution] = await readSolutionManifest(fs, solutionFile);
-    if (readError) {
-        logger.warn(
-            `Could not undo the solution registration for project id ${projectId} in '${solutionFile}': ${readError.message}. ` +
-                "Remove the stale entry with 'uip solution project remove'.",
-        );
-        return;
-    }
-
-    solution.content.Projects = solution.projects.filter(
-        (project: UipxProject) => project.Id !== projectId,
-    );
-    const [writeError] = await catchError(
-        fs.writeFile(solutionFile, serialize(solution.content)),
-    );
-    if (writeError) {
-        logger.warn(
-            `Could not undo the solution registration for project id ${projectId} in '${solutionFile}': ${writeError.message}. ` +
-                "Remove the stale entry with 'uip solution project remove'.",
-        );
-    }
-}

package/src/init.ts

@@ -1,13 +0,0 @@
-/**
- * Entity project scaffolding. A separate entry (like `@uipath/flow-tool/init`)
- * because it needs the filesystem and solution-sdk — node-only machinery the
- * root module must not pull into browser bundles.
- */
-
-export type {
-    AutoCreatedSolution,
-    EntityInitOptions,
-    EntityInitResult,
-    EntityProjectRegistration,
-} from "./init/entity-init-service.js";
-export { entityInitAsync } from "./init/entity-init-service.js";

package/src/pack/constants.ts

@@ -1,20 +0,0 @@
-/** The entity stub extension. Its own module so every caller shares one
- *  literal. */
-export const ENTITY_EXTENSION_CONST = ".entity";
-
-/** Error code on the `ToolResult` when entity validation fails. */
-export const ENTITY_VALIDATION_FAILED = "ENTITY_VALIDATION_FAILED";
-
-/**
- * Diagnostic codes pack raises about the PROJECT rather than a single entity.
- * The per-entity codes live with the checks that raise them: pair failures in
- * `verify-pair.ts` (`PairFailureCode`) and schema failures in
- * `validate-entity.ts` (`DIAGNOSTIC_CODES`).
- */
-export const PACK_DIAGNOSTIC_CODES = {
-    /** A main file belonging to another project type sits in an Entity project. */
-    misplacedMainFile: "MISPLACED_MAIN_FILE",
-    /** The project has entities but no parent solution, so their
-     *  solution-relative resource pointers cannot resolve. */
-    noParentSolution: "NO_PARENT_SOLUTION",
-} as const;