@uipath/solution-sdk 1.196.0

package/dist/scripts/generate-sdk.js

@@ -0,0 +1,176 @@
+#!/usr/bin/env bun
+// @bun
+
+// src/scripts/generate-sdk.ts
+import { execSync } from "child_process";
+import { mkdir, rm, writeFile } from "fs/promises";
+import { dirname, join } from "path";
+import { fileURLToPath } from "url";
+var SWAGGER_URL = "https://alpha.uipath.com/uipattycyrhx/abizon_1/automationsolutions_/swagger/v1.0/swagger.json";
+var __dirname2 = import.meta.dir ?? dirname(fileURLToPath(import.meta.url));
+var PKG_ROOT = join(__dirname2, "../..");
+var OUTPUT_DIR = join(PKG_ROOT, "generated");
+var TEMP_DIR = join(PKG_ROOT, "temp");
+var GENERATE_DIR = join(PKG_ROOT, "swagger");
+var IGNORED_GENERATOR_OUTPUTS = [
+  "package.json",
+  "tsconfig.json",
+  "tsconfig.esm.json",
+  ".npmignore",
+  ".gitignore"
+];
+async function downloadSwagger() {
+  console.log("Downloading swagger.json...");
+  const response = await fetch(SWAGGER_URL);
+  if (!response.ok) {
+    throw new Error(`Failed to download swagger: ${response.statusText}`);
+  }
+  return await response.json();
+}
+function filterSwaggerPaths(swagger) {
+  const filteredPaths = {};
+  const excludedPathPrefixes = [
+    "/api/blobfileaccess",
+    "/api/configurations/",
+    "/api/deployments/",
+    "/api/lookups/",
+    "/api/messagebus",
+    "/api/metadata",
+    "/api/projects/",
+    "/api/resourcecatalog/",
+    "/api/search/",
+    "/api/settings/",
+    "/api/translations",
+    "/api/users/",
+    "/api/v1/projects/",
+    "/api/v1/solutions/",
+    "/api/v2/search/",
+    "/api/v3/search/"
+  ];
+  const explicitlyIncludedPaths = [
+    "/api/deployments/{deploymentKey}",
+    "/api/deployments/deploy",
+    "/api/search/packages",
+    "/api/v3/search/deployments"
+  ];
+  for (const [path, methods] of Object.entries(swagger.paths)) {
+    const isExplicitlyIncluded = explicitlyIncludedPaths.includes(path);
+    const shouldExclude = !isExplicitlyIncluded && excludedPathPrefixes.some((prefix) => path.startsWith(prefix));
+    if (shouldExclude) {
+      console.log(` Skipping path: ${path} (problematic headers)`);
+    } else {
+      if (path === "/api/deployments/{deploymentKey}") {
+        const pathMethods = methods;
+        filteredPaths[path] = { get: pathMethods.get };
+        console.log(`Including path: GET ${path} (explicitly included)`);
+      } else {
+        filteredPaths[path] = methods;
+        console.log(`Including path: ${path}`);
+      }
+    }
+  }
+  return {
+    ...swagger,
+    paths: filteredPaths
+  };
+}
+function collectReferencedSchemas(swagger, paths) {
+  const referenced = new Set;
+  const toProcess = [];
+  for (const methods of Object.values(paths)) {
+    for (const operation of Object.values(methods)) {
+      if (typeof operation === "object" && operation !== null) {
+        toProcess.push(operation);
+      }
+    }
+  }
+  const findRefs = (obj) => {
+    if (!obj || typeof obj !== "object")
+      return;
+    if (obj.$ref && typeof obj.$ref === "string") {
+      const match = obj.$ref.match(/#\/components\/schemas\/(.+)/);
+      if (match?.[1]) {
+        const schemaName = match[1];
+        if (!referenced.has(schemaName)) {
+          referenced.add(schemaName);
+          if (swagger.components?.schemas?.[schemaName]) {
+            findRefs(swagger.components.schemas[schemaName]);
+          }
+        }
+      }
+    }
+    if (Array.isArray(obj)) {
+      obj.forEach(findRefs);
+    } else if (typeof obj === "object") {
+      Object.values(obj).forEach(findRefs);
+    }
+  };
+  toProcess.forEach(findRefs);
+  return referenced;
+}
+function filterUnusedSchemas(swagger) {
+  const referencedSchemas = collectReferencedSchemas(swagger, swagger.paths);
+  const filteredSchemas = {};
+  const totalSchemas = Object.keys(swagger.components?.schemas || {}).length;
+  console.log(`
+Found ${referencedSchemas.size} referenced schemas out of ${totalSchemas} total`);
+  for (const schemaName of referencedSchemas) {
+    if (swagger.components?.schemas?.[schemaName]) {
+      filteredSchemas[schemaName] = swagger.components.schemas[schemaName];
+    }
+  }
+  return {
+    ...swagger,
+    components: {
+      ...swagger.components,
+      schemas: filteredSchemas
+    }
+  };
+}
+async function generateClient(filteredSwagger) {
+  console.log(`
+Generating TypeScript client...`);
+  await rm(TEMP_DIR, { recursive: true, force: true });
+  await rm(OUTPUT_DIR, { recursive: true, force: true });
+  await mkdir(TEMP_DIR, { recursive: true });
+  await mkdir(OUTPUT_DIR, { recursive: true });
+  const swaggerPath = join(TEMP_DIR, "filtered-swagger.json");
+  await writeFile(swaggerPath, JSON.stringify(filteredSwagger, null, 2));
+  await writeFile(join(OUTPUT_DIR, ".openapi-generator-ignore"), `${IGNORED_GENERATOR_OUTPUTS.join(`
+`)}
+`);
+  const command = [
+    "npx @openapitools/openapi-generator-cli generate",
+    `-i ${swaggerPath}`,
+    `-g typescript-fetch`,
+    `-o ${OUTPUT_DIR}`,
+    "--skip-validate-spec",
+    "--additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=@uipath/solution-sdk"
+  ].join(" ");
+  execSync(command, { stdio: "inherit" });
+  console.log("Client generated successfully!");
+}
+async function main() {
+  try {
+    const swagger = await downloadSwagger();
+    const filteredPaths = filterSwaggerPaths(swagger);
+    const filtered = filterUnusedSchemas(filteredPaths);
+    await mkdir(GENERATE_DIR, { recursive: true });
+    await writeFile(join(GENERATE_DIR, "swagger.json"), JSON.stringify(swagger, null, 2));
+    await writeFile(join(GENERATE_DIR, "filtered-swagger.json"), JSON.stringify(filtered, null, 2));
+    await generateClient(filtered);
+    await rm(TEMP_DIR, { recursive: true, force: true });
+    console.log(`
+\u2705 Generated SDK available in: ${OUTPUT_DIR}`);
+    console.log(`\uD83D\uDCC1 Reference files saved in: ${GENERATE_DIR}`);
+  } catch (error) {
+    console.error("Error generating SDK:", error);
+    process.exit(1);
+  }
+}
+if (__require.main == __require.module) {
+  main();
+}
+export {
+  main as generateSdk
+};

package/dist/scripts/generate-sdk.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../../src/scripts/generate-sdk.ts"],
+  "sourcesContent": [
+    "#!/usr/bin/env bun\nimport { execSync } from \"node:child_process\";\nimport { mkdir, rm, writeFile } from \"node:fs/promises\";\nimport { dirname, join } from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\n\nconst SWAGGER_URL =\n    \"https://alpha.uipath.com/uipattycyrhx/abizon_1/automationsolutions_/swagger/v1.0/swagger.json\";\nconst __dirname = import.meta.dir ?? dirname(fileURLToPath(import.meta.url));\nconst PKG_ROOT = join(__dirname, \"../..\");\nconst OUTPUT_DIR = join(PKG_ROOT, \"generated\");\nconst TEMP_DIR = join(PKG_ROOT, \"temp\");\nconst GENERATE_DIR = join(PKG_ROOT, \"swagger\");\n\n// Files the openapi-generator would emit that we don't consume.\n// Only `src/**` is referenced by the outer package;\n// README.md and docs/ are kept as generated reference material.\nconst IGNORED_GENERATOR_OUTPUTS = [\n    \"package.json\",\n    \"tsconfig.json\",\n    \"tsconfig.esm.json\",\n    \".npmignore\",\n    \".gitignore\",\n];\n\nasync function downloadSwagger(): Promise<any> {\n    console.log(\"Downloading swagger.json...\");\n    const response = await fetch(SWAGGER_URL);\n    if (!response.ok) {\n        throw new Error(`Failed to download swagger: ${response.statusText}`);\n    }\n    return await response.json();\n}\n\nfunction filterSwaggerPaths(swagger: any): any {\n    const filteredPaths: any = {};\n\n    // Exclude all endpoints except /api/packages/\n    const excludedPathPrefixes = [\n        \"/api/blobfileaccess\",\n        \"/api/configurations/\",\n        \"/api/deployments/\",\n        \"/api/lookups/\",\n        \"/api/messagebus\",\n        \"/api/metadata\",\n        \"/api/projects/\",\n        \"/api/resourcecatalog/\",\n        \"/api/search/\",\n        \"/api/settings/\",\n        \"/api/translations\",\n        \"/api/users/\",\n        \"/api/v1/projects/\",\n        \"/api/v1/solutions/\",\n        \"/api/v2/search/\",\n        \"/api/v3/search/\",\n    ];\n\n    // Explicitly included paths that would otherwise be excluded by prefix rules\n    const explicitlyIncludedPaths = [\n        \"/api/deployments/{deploymentKey}\",\n        \"/api/deployments/deploy\",\n        \"/api/search/packages\",\n        \"/api/v3/search/deployments\",\n    ];\n\n    for (const [path, methods] of Object.entries(swagger.paths)) {\n        const isExplicitlyIncluded = explicitlyIncludedPaths.includes(path);\n        const shouldExclude =\n            !isExplicitlyIncluded &&\n            excludedPathPrefixes.some((prefix) => path.startsWith(prefix));\n\n        if (shouldExclude) {\n            console.log(` Skipping path: ${path} (problematic headers)`);\n        } else {\n            // For explicitly included paths that have multiple methods,\n            // only include the methods we need\n            if (path === \"/api/deployments/{deploymentKey}\") {\n                const pathMethods = methods as Record<string, any>;\n                filteredPaths[path] = { get: pathMethods.get };\n                console.log(\n                    `Including path: GET ${path} (explicitly included)`,\n                );\n            } else {\n                filteredPaths[path] = methods;\n                console.log(`Including path: ${path}`);\n            }\n        }\n    }\n\n    return {\n        ...swagger,\n        paths: filteredPaths,\n    };\n}\n\nfunction collectReferencedSchemas(swagger: any, paths: any): Set<string> {\n    const referenced = new Set<string>();\n    const toProcess: any[] = [];\n\n    // Start by collecting all schemas from paths\n    for (const methods of Object.values(paths)) {\n        for (const operation of Object.values(methods as any)) {\n            if (typeof operation === \"object\" && operation !== null) {\n                toProcess.push(operation);\n            }\n        }\n    }\n\n    // Recursively find all $ref references\n    const findRefs = (obj: any) => {\n        if (!obj || typeof obj !== \"object\") return;\n\n        if (obj.$ref && typeof obj.$ref === \"string\") {\n            // Extract schema name from \"#/components/schemas/MyDto\"\n            const match = obj.$ref.match(/#\\/components\\/schemas\\/(.+)/);\n            if (match?.[1]) {\n                const schemaName = match[1];\n                if (!referenced.has(schemaName)) {\n                    referenced.add(schemaName);\n                    // Recursively process this schema\n                    if (swagger.components?.schemas?.[schemaName]) {\n                        findRefs(swagger.components.schemas[schemaName]);\n                    }\n                }\n            }\n        }\n\n        // Traverse arrays and objects\n        if (Array.isArray(obj)) {\n            obj.forEach(findRefs);\n        } else if (typeof obj === \"object\") {\n            Object.values(obj).forEach(findRefs);\n        }\n    };\n\n    toProcess.forEach(findRefs);\n    return referenced;\n}\n\nfunction filterUnusedSchemas(swagger: any): any {\n    const referencedSchemas = collectReferencedSchemas(swagger, swagger.paths);\n    const filteredSchemas: any = {};\n\n    const totalSchemas = Object.keys(swagger.components?.schemas || {}).length;\n    console.log(\n        `\\nFound ${referencedSchemas.size} referenced schemas out of ${totalSchemas} total`,\n    );\n\n    for (const schemaName of referencedSchemas) {\n        if (swagger.components?.schemas?.[schemaName]) {\n            filteredSchemas[schemaName] =\n                swagger.components.schemas[schemaName];\n        }\n    }\n\n    return {\n        ...swagger,\n        components: {\n            ...swagger.components,\n            schemas: filteredSchemas,\n        },\n    };\n}\n\nasync function generateClient(filteredSwagger: any): Promise<void> {\n    console.log(\"\\nGenerating TypeScript client...\");\n\n    await rm(TEMP_DIR, { recursive: true, force: true });\n    await rm(OUTPUT_DIR, { recursive: true, force: true });\n\n    await mkdir(TEMP_DIR, { recursive: true });\n    await mkdir(OUTPUT_DIR, { recursive: true });\n\n    const swaggerPath = join(TEMP_DIR, \"filtered-swagger.json\");\n    await writeFile(swaggerPath, JSON.stringify(filteredSwagger, null, 2));\n\n    // Seed .openapi-generator-ignore so the generator never writes unused\n    // support files. It must exist in OUTPUT_DIR before the generator runs.\n    await writeFile(\n        join(OUTPUT_DIR, \".openapi-generator-ignore\"),\n        `${IGNORED_GENERATOR_OUTPUTS.join(\"\\n\")}\\n`,\n    );\n\n    const command = [\n        \"npx @openapitools/openapi-generator-cli generate\",\n        `-i ${swaggerPath}`,\n        `-g typescript-fetch`,\n        `-o ${OUTPUT_DIR}`,\n        \"--skip-validate-spec\",\n        \"--additional-properties=typescriptThreePlus=true,supportsES6=true,npmName=@uipath/solution-sdk\",\n    ].join(\" \");\n\n    execSync(command, { stdio: \"inherit\" });\n    console.log(\"Client generated successfully!\");\n}\n\nasync function main(): Promise<void> {\n    try {\n        const swagger = await downloadSwagger();\n        const filteredPaths = filterSwaggerPaths(swagger);\n        const filtered = filterUnusedSchemas(filteredPaths);\n\n        // Create generate directory and save files\n        await mkdir(GENERATE_DIR, { recursive: true });\n        await writeFile(\n            join(GENERATE_DIR, \"swagger.json\"),\n            JSON.stringify(swagger, null, 2),\n        );\n        await writeFile(\n            join(GENERATE_DIR, \"filtered-swagger.json\"),\n            JSON.stringify(filtered, null, 2),\n        );\n\n        await generateClient(filtered);\n\n        // Clean up temp files\n        await rm(TEMP_DIR, { recursive: true, force: true });\n\n        console.log(`\\n✅ Generated SDK available in: ${OUTPUT_DIR}`);\n        console.log(`📁 Reference files saved in: ${GENERATE_DIR}`);\n    } catch (error) {\n        console.error(\"Error generating SDK:\", error);\n        process.exit(1);\n    }\n}\n\nif (import.meta.main) {\n    main();\n}\n\nexport { main as generateSdk };\n"
+  ],
+  "mappings": ";;;;AACA;AACA;AACA;AACA;AAEA,IAAM,cACF;AACJ,IAAM,aAAY,YAAY,OAAO,QAAQ,cAAc,YAAY,GAAG,CAAC;AAC3E,IAAM,WAAW,KAAK,YAAW,OAAO;AACxC,IAAM,aAAa,KAAK,UAAU,WAAW;AAC7C,IAAM,WAAW,KAAK,UAAU,MAAM;AACtC,IAAM,eAAe,KAAK,UAAU,SAAS;AAK7C,IAAM,4BAA4B;AAAA,EAC9B;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAEA,eAAe,eAAe,GAAiB;AAAA,EAC3C,QAAQ,IAAI,6BAA6B;AAAA,EACzC,MAAM,WAAW,MAAM,MAAM,WAAW;AAAA,EACxC,IAAI,CAAC,SAAS,IAAI;AAAA,IACd,MAAM,IAAI,MAAM,+BAA+B,SAAS,YAAY;AAAA,EACxE;AAAA,EACA,OAAO,MAAM,SAAS,KAAK;AAAA;AAG/B,SAAS,kBAAkB,CAAC,SAAmB;AAAA,EAC3C,MAAM,gBAAqB,CAAC;AAAA,EAG5B,MAAM,uBAAuB;AAAA,IACzB;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ;AAAA,EAGA,MAAM,0BAA0B;AAAA,IAC5B;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACJ;AAAA,EAEA,YAAY,MAAM,YAAY,OAAO,QAAQ,QAAQ,KAAK,GAAG;AAAA,IACzD,MAAM,uBAAuB,wBAAwB,SAAS,IAAI;AAAA,IAClE,MAAM,gBACF,CAAC,wBACD,qBAAqB,KAAK,CAAC,WAAW,KAAK,WAAW,MAAM,CAAC;AAAA,IAEjE,IAAI,eAAe;AAAA,MACf,QAAQ,IAAI,mBAAmB,4BAA4B;AAAA,IAC/D,EAAO;AAAA,MAGH,IAAI,SAAS,oCAAoC;AAAA,QAC7C,MAAM,cAAc;AAAA,QACpB,cAAc,QAAQ,EAAE,KAAK,YAAY,IAAI;AAAA,QAC7C,QAAQ,IACJ,uBAAuB,4BAC3B;AAAA,MACJ,EAAO;AAAA,QACH,cAAc,QAAQ;AAAA,QACtB,QAAQ,IAAI,mBAAmB,MAAM;AAAA;AAAA;AAAA,EAGjD;AAAA,EAEA,OAAO;AAAA,OACA;AAAA,IACH,OAAO;AAAA,EACX;AAAA;AAGJ,SAAS,wBAAwB,CAAC,SAAc,OAAyB;AAAA,EACrE,MAAM,aAAa,IAAI;AAAA,EACvB,MAAM,YAAmB,CAAC;AAAA,EAG1B,WAAW,WAAW,OAAO,OAAO,KAAK,GAAG;AAAA,IACxC,WAAW,aAAa,OAAO,OAAO,OAAc,GAAG;AAAA,MACnD,IAAI,OAAO,cAAc,YAAY,cAAc,MAAM;AAAA,QACrD,UAAU,KAAK,SAAS;AAAA,MAC5B;AAAA,IACJ;AAAA,EACJ;AAAA,EAGA,MAAM,WAAW,CAAC,QAAa;AAAA,IAC3B,IAAI,CAAC,OAAO,OAAO,QAAQ;AAAA,MAAU;AAAA,IAErC,IAAI,IAAI,QAAQ,OAAO,IAAI,SAAS,UAAU;AAAA,MAE1C,MAAM,QAAQ,IAAI,KAAK,MAAM,8BAA8B;AAAA,MAC3D,IAAI,QAAQ,IAAI;AAAA,QACZ,MAAM,aAAa,MAAM;AAAA,QACzB,IAAI,CAAC,WAAW,IAAI,UAAU,GAAG;AAAA,UAC7B,WAAW,IAAI,UAAU;AAAA,UAEzB,IAAI,QAAQ,YAAY,UAAU,aAAa;AAAA,YAC3C,SAAS,QAAQ,WAAW,QAAQ,WAAW;AAAA,UACnD;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ;AAAA,IAGA,IAAI,MAAM,QAAQ,GAAG,GAAG;AAAA,MACpB,IAAI,QAAQ,QAAQ;AAAA,IACxB,EAAO,SAAI,OAAO,QAAQ,UAAU;AAAA,MAChC,OAAO,OAAO,GAAG,EAAE,QAAQ,QAAQ;AAAA,IACvC;AAAA;AAAA,EAGJ,UAAU,QAAQ,QAAQ;AAAA,EAC1B,OAAO;AAAA;AAGX,SAAS,mBAAmB,CAAC,SAAmB;AAAA,EAC5C,MAAM,oBAAoB,yBAAyB,SAAS,QAAQ,KAAK;AAAA,EACzE,MAAM,kBAAuB,CAAC;AAAA,EAE9B,MAAM,eAAe,OAAO,KAAK,QAAQ,YAAY,WAAW,CAAC,CAAC,EAAE;AAAA,EACpE,QAAQ,IACJ;AAAA,QAAW,kBAAkB,kCAAkC,oBACnE;AAAA,EAEA,WAAW,cAAc,mBAAmB;AAAA,IACxC,IAAI,QAAQ,YAAY,UAAU,aAAa;AAAA,MAC3C,gBAAgB,cACZ,QAAQ,WAAW,QAAQ;AAAA,IACnC;AAAA,EACJ;AAAA,EAEA,OAAO;AAAA,OACA;AAAA,IACH,YAAY;AAAA,SACL,QAAQ;AAAA,MACX,SAAS;AAAA,IACb;AAAA,EACJ;AAAA;AAGJ,eAAe,cAAc,CAAC,iBAAqC;AAAA,EAC/D,QAAQ,IAAI;AAAA,gCAAmC;AAAA,EAE/C,MAAM,GAAG,UAAU,EAAE,WAAW,MAAM,OAAO,KAAK,CAAC;AAAA,EACnD,MAAM,GAAG,YAAY,EAAE,WAAW,MAAM,OAAO,KAAK,CAAC;AAAA,EAErD,MAAM,MAAM,UAAU,EAAE,WAAW,KAAK,CAAC;AAAA,EACzC,MAAM,MAAM,YAAY,EAAE,WAAW,KAAK,CAAC;AAAA,EAE3C,MAAM,cAAc,KAAK,UAAU,uBAAuB;AAAA,EAC1D,MAAM,UAAU,aAAa,KAAK,UAAU,iBAAiB,MAAM,CAAC,CAAC;AAAA,EAIrE,MAAM,UACF,KAAK,YAAY,2BAA2B,GAC5C,GAAG,0BAA0B,KAAK;AAAA,CAAI;AAAA,CAC1C;AAAA,EAEA,MAAM,UAAU;AAAA,IACZ;AAAA,IACA,MAAM;AAAA,IACN;AAAA,IACA,MAAM;AAAA,IACN;AAAA,IACA;AAAA,EACJ,EAAE,KAAK,GAAG;AAAA,EAEV,SAAS,SAAS,EAAE,OAAO,UAAU,CAAC;AAAA,EACtC,QAAQ,IAAI,gCAAgC;AAAA;AAGhD,eAAe,IAAI,GAAkB;AAAA,EACjC,IAAI;AAAA,IACA,MAAM,UAAU,MAAM,gBAAgB;AAAA,IACtC,MAAM,gBAAgB,mBAAmB,OAAO;AAAA,IAChD,MAAM,WAAW,oBAAoB,aAAa;AAAA,IAGlD,MAAM,MAAM,cAAc,EAAE,WAAW,KAAK,CAAC;AAAA,IAC7C,MAAM,UACF,KAAK,cAAc,cAAc,GACjC,KAAK,UAAU,SAAS,MAAM,CAAC,CACnC;AAAA,IACA,MAAM,UACF,KAAK,cAAc,uBAAuB,GAC1C,KAAK,UAAU,UAAU,MAAM,CAAC,CACpC;AAAA,IAEA,MAAM,eAAe,QAAQ;AAAA,IAG7B,MAAM,GAAG,UAAU,EAAE,WAAW,MAAM,OAAO,KAAK,CAAC;AAAA,IAEnD,QAAQ,IAAI;AAAA,qCAAkC,YAAY;AAAA,IAC1D,QAAQ,IAAI,0CAA+B,cAAc;AAAA,IAC3D,OAAO,OAAO;AAAA,IACZ,QAAQ,MAAM,yBAAyB,KAAK;AAAA,IAC5C,QAAQ,KAAK,CAAC;AAAA;AAAA;AAItB,IAAI,oCAAkB;AAAA,EAClB,KAAK;AACT;",
+  "debugId": "03A1AC393696691964756E2164756E21",
+  "names": []
+}

package/dist/src/bundle-service.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Bundle a solution directory into a .uis file.
+ * Also provides buildSolutionPackageFromDir for building .uis from
+ * a pre-assembled solution directory (used by debug services).
+ */
+import type { IFileSystem } from "@uipath/filesystem";
+import type { BundleResult } from "./types";
+/**
+ * Bundle a solution directory into a .uis file.
+ * Validates the .uipx file, flattens project directories, and zips everything.
+ *
+ * Returns the path to the .uis file and metadata.
+ * The caller is responsible for cleaning up the .uis file if it was created in a temp location.
+ */
+export declare function bundleSolution(fs: IFileSystem, solutionDir: string, outputDir: string, outputName?: string): Promise<BundleResult>;
+/**
+ * Build a .uis solution package from a pre-assembled solution directory.
+ * The directory should already contain project subdirectories and optionally a .uipx file.
+ * If a .uipx exists, SolutionStorage.json is generated from it.
+ *
+ * Used by debug services that prepare their own staging directory.
+ * Uses fflate for in-process zip creation (no external zip CLI dependency).
+ */
+export declare function buildSolutionPackageFromDir(fs: IFileSystem, solutionDir: string): Promise<string>;
+export { resolveSolutionDir } from "./solution-file";

package/dist/src/index.d.ts

@@ -0,0 +1,9 @@
+import "./user-agent.js";
+export * from "../generated/src/index.js";
+export { buildSolutionPackageFromDir, bundleSolution, resolveSolutionDir, } from "./bundle-service";
+export type { ParentSolutionDiscovery, ProjectSolutionRegistration, RegisterProjectOptions, } from "./solution-file";
+export { findNearestParentUipxFile, findSolutionFile, isProjectRegisteredInSolution, normalizeProjectType, readSolutionManifest, readUipxFile, toPortableRelativePath, tryRegisterProjectInParentSolution, updateSolutionFile, updateUipxSolutionId, } from "./solution-file";
+export type { BundleResult, SolutionImportResponse, StudioWebConfig, UipxFile, UipxProject, } from "./types";
+export { importSolution, overwriteSolution, solutionExistsOnStudioWeb, uploadOrOverwriteSolution, } from "./upload-service";
+export { SDK_USER_AGENT } from "./user-agent.js";
+export { collectFiles, createZipFromDir } from "./zip-utils";

package/dist/src/solution-file.d.ts

@@ -0,0 +1,133 @@
+/**
+ * Utilities for reading, finding, and updating .uipx solution files.
+ */
+import type { IFileSystem } from "@uipath/filesystem";
+import type { UipxFile, UipxProject } from "./types";
+/**
+ * Outcome of attempting to register a project in its parent `.uipx` solution.
+ *
+ * Status meanings:
+ * - `Registered`        — Project was added to `<solution>.uipx` Projects[] in this call.
+ * - `AlreadyRegistered` — Project was already in Projects[]; no write performed.
+ * - `Skipped`           — A candidate solution was found but registration was deliberately
+ *                         not attempted (ambiguous: multiple `.uipx` in same dir, or the
+ *                         project dir sits outside the discovered solution dir).
+ * - `Failed`            — Registration was attempted and an error occurred (read/write/parse).
+ * - `NotInSolution`     — No `.uipx` file was found by walking ancestor directories. The
+ *                         project was created in standalone mode. This is the explicit
+ *                         contract value for "no parent solution discovered" so that
+ *                         downstream consumers (agents, the skill doc, CI scripts) can
+ *                         distinguish "missing field due to old CLI" from "field
+ *                         intentionally indicates no enclosing solution" (MST-10004).
+ * - `OptedOut`          — The caller passed `skipRegistration` (the `--skip-solution-registration`
+ *                         CLI flag): discovery and registration were intentionally not
+ *                         attempted. Distinct from `Skipped` (structural ambiguity the
+ *                         tool could not resolve) and `NotInSolution` (no solution exists):
+ *                         the user explicitly declined registration.
+ */
+export interface ProjectSolutionRegistration {
+    Status: "Registered" | "AlreadyRegistered" | "Skipped" | "Failed" | "NotInSolution" | "OptedOut";
+    Message: string;
+    Solution?: string;
+    Project?: string;
+    ProjectId?: string;
+    Instructions?: string;
+}
+/**
+ * Options for {@link tryRegisterProjectInParentSolution}.
+ */
+export interface RegisterProjectOptions {
+    /**
+     * When true, skip solution discovery and registration entirely and return an
+     * `OptedOut` envelope. Set by the `--skip-solution-registration` CLI flag. The `OptedOut`
+     * envelope is still returned (the field is never absent) so downstream consumers
+     * keep a uniform `Data.SolutionRegistration` contract.
+     */
+    skipRegistration?: boolean;
+}
+export declare const STUDIO_WEB_PROJECT_TYPE_OVERRIDES: Record<string, string>;
+export declare function normalizeProjectType(projectType: string): string;
+/**
+ * Converts a relative path to forward slashes. ProjectRelativePath values in
+ * the .uipx manifest must always use forward slashes — Studio Web rejects
+ * backslash separators, which `fs.path.relative`/`join` produce on Windows.
+ */
+export declare function toPortableRelativePath(relativePath: string): string;
+/**
+ * Find and parse the .uipx file in a solution directory.
+ * Validates the required fields (SolutionId, Projects).
+ */
+export declare function readUipxFile(fs: IFileSystem, solutionDir: string): Promise<{
+    uipx: UipxFile;
+    uipxFileName: string;
+}>;
+/**
+ * Resolve input to a solution directory path.
+ * Accepts a directory path or a .uipx file path.
+ */
+export declare function resolveSolutionDir(fs: IFileSystem, inputPath: string): string;
+/**
+ * Update the SolutionId in a .uipx file at a known path.
+ * Called after successful upload to ensure subsequent uploads use overwrite.
+ */
+export declare function updateUipxSolutionId(fs: IFileSystem, uipxPath: string, newSolutionId: string): Promise<void>;
+/**
+ * Find the .uipx solution file in the parent directory of a project path.
+ * Returns the solutionId and projectId, or undefined if not found.
+ */
+export declare function findSolutionFile(fs: IFileSystem, projectPath: string): Promise<{
+    solutionId: string;
+    projectId: string;
+} | undefined>;
+/**
+ * Update the .uipx solution file in the parent directory of a project path.
+ * Scans the parent dir for a .uipx file and updates its SolutionId.
+ */
+export declare function updateSolutionFile(fs: IFileSystem, projectPath: string, newSolutionId: string): Promise<void>;
+export declare function tryRegisterProjectInParentSolution(fs: IFileSystem, projectDir: string, options?: RegisterProjectOptions): Promise<ProjectSolutionRegistration>;
+export type ParentSolutionDiscovery = {
+    status: "found";
+    solutionFile: string;
+} | {
+    status: "notFound";
+} | {
+    status: "skipped";
+    registration: ProjectSolutionRegistration;
+};
+export declare function findNearestParentUipxFile(fs: IFileSystem, projectDir: string): Promise<ParentSolutionDiscovery>;
+export declare function readSolutionManifest(fs: IFileSystem, solutionFile: string): Promise<[Error, null] | [
+    null,
+    {
+        content: Record<string, unknown>;
+        projects: UipxProject[];
+    }
+]>;
+/**
+ * Read the .uipx solution manifest at `solutionFile` and report whether the
+ * project at `projectDir` is registered in its `Projects[]` array.
+ *
+ * Matching is path-based: each `Projects[].ProjectRelativePath` is resolved
+ * to an absolute project directory and compared to `projectDir` after
+ * canonicalization via `realpath()`. Canonicalization makes the comparison
+ * tolerant of:
+ *   - case-folding differences on macOS / Windows filesystems
+ *   - symlinks that resolve `projectDir` and the manifest entry to the same
+ *     underlying inode through different surface forms
+ * If `realpath()` fails (e.g. the path does not exist), the literal path is
+ * used — the surrounding pre-flight will already surface the missing-dir
+ * error separately, so we should not double-fail here.
+ *
+ * Throws when the manifest cannot be read or parsed (invalid JSON, missing
+ * `Projects` array, malformed entry). The boolean return is reserved for
+ * the answerable question "is this project listed?" — a corrupt manifest
+ * is a separate failure mode that callers must not silently translate
+ * into "not registered", since the repair (`uip solution project add`)
+ * won't fix a manifest that fails to parse.
+ *
+ * Used by `flow debug` to catch the empty-solution-archive case BEFORE
+ * uploading to Studio Web (MST-10004). Studio Web's import endpoint rejects
+ * archives whose `Projects[]` is empty (or whose listed projects don't match
+ * the staged contents) with an opaque HTTP 400 — failing locally with the
+ * project path and the manifest path is far more actionable.
+ */
+export declare function isProjectRegisteredInSolution(fs: IFileSystem, projectDir: string, solutionFile: string): Promise<boolean>;

package/dist/src/types.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Shared type definitions for solution packaging and Studio Web upload.
+ */
+/** Minimal config needed for Studio Web API calls. */
+export interface StudioWebConfig {
+    baseUrl: string;
+    authToken: string;
+    tenantId?: string;
+}
+/** Response from Studio Web Import/Overwrite API. */
+export interface SolutionImportResponse {
+    id: string;
+    solutionId?: string;
+    projects: Array<{
+        id: string;
+        name: string;
+    }>;
+}
+/** A project entry inside a .uipx file. */
+export interface UipxProject {
+    Type: string;
+    ProjectRelativePath: string;
+    Id: string;
+}
+/** Parsed contents of a .uipx file. */
+export interface UipxFile {
+    DocVersion?: string;
+    StudioMinVersion?: string;
+    SolutionId: string;
+    Projects: UipxProject[];
+}
+/** Result of bundling a solution directory into a .uis file. */
+export interface BundleResult {
+    uisPath: string;
+    solutionName: string;
+    solutionId: string;
+    uipxPath: string;
+    projects: Array<{
+        Name: string;
+        Type: string;
+    }>;
+}

package/dist/src/upload-service.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Upload/overwrite solutions to UiPath Studio Web.
+ * Consolidates the upload logic previously duplicated in solution-tool and maestro-sdk.
+ */
+import type { IFileSystem } from "@uipath/filesystem";
+import type { SolutionImportResponse, StudioWebConfig } from "./types";
+/**
+ * Probe Studio Web for the existence of a solution by id.
+ * Returns true on 2xx, false on 404. Throws on any other status so callers
+ * don't silently treat transient errors (auth, 5xx) as "missing".
+ *
+ * Routes through `@uipath/studioweb-sdk`'s generated `SolutionApi`
+ * (`Solution_GetSolution` → `GET /api/Solution/{solutionId}`) so the URL,
+ * auth header composition, and tenant routing come from the Studio Web
+ * swagger instead of being hand-typed here. The `Raw` variant is used so we
+ * can branch on response status (404 = missing) without forcing the body
+ * parse.
+ */
+export declare function solutionExistsOnStudioWeb(config: StudioWebConfig, organizationName: string, solutionId: string): Promise<boolean>;
+/**
+ * Upload a .uis file to Studio Web Import endpoint (new solution).
+ */
+export declare function importSolution(config: StudioWebConfig, organizationName: string, fileBuffer: Uint8Array, fileName: string): Promise<SolutionImportResponse>;
+/**
+ * Overwrite an existing solution on Studio Web.
+ */
+export declare function overwriteSolution(config: StudioWebConfig, organizationName: string, fileBuffer: Uint8Array, fileName: string, solutionId: string): Promise<SolutionImportResponse>;
+/**
+ * Upload or overwrite a solution on Studio Web.
+ * If solutionId is provided, tries overwrite first with 404 fallback to import.
+ *
+ * Accepts either a file buffer or a file path (reads the file using fs).
+ */
+export declare function uploadOrOverwriteSolution(config: StudioWebConfig, organizationName: string, fileBufferOrPath: Uint8Array | string, solutionId: string | undefined, fs?: IFileSystem): Promise<SolutionImportResponse>;

package/dist/src/user-agent.d.ts

@@ -0,0 +1 @@
+export declare const SDK_USER_AGENT: string;

package/dist/src/zip-utils.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Shared zip utilities for solution packaging.
+ * Uses fflate for in-process zip creation (no external zip CLI dependency).
+ */
+import type { IFileSystem } from "@uipath/filesystem";
+/**
+ * Directory names that are never part of a solution bundle. Skipped at walk
+ * time so the bundle stays small and Studio Web doesn't receive
+ * developer-local artifacts.
+ *
+ *   .venv          Python virtualenvs (per-agent under solution/<agent>/.venv).
+ *                  Each is hundreds of MB and contains binaries that won't
+ *                  execute on the Studio Web side anyway.
+ *   node_modules   Node dependency cache; same reasoning as .venv.
+ *   __pycache__    Python bytecode; regenerated on import.
+ *   .git           VCS metadata; never belongs in an upload.
+ *
+ * Callers can extend this set per-walk via the `additionalExcludeDirs` option
+ * (sourced from a `.uipignore` file at the solution root by bundle-service).
+ */
+export declare const DEFAULT_EXCLUDED_DIR_NAMES: ReadonlySet<string>;
+/** File name read by bundle-service to extend the default exclude set. */
+export declare const UIPIGNORE_FILENAME = ".uipignore";
+/**
+ * Parse a `.uipignore` file body: one directory name per line, `#` for line
+ * comments, blank lines ignored. Returns the names as a Set. The parser is
+ * deliberately minimal — no globs, no negation, no path separators. Each
+ * entry matches by exact directory name at any depth (same semantics as the
+ * built-in defaults).
+ */
+export declare function parseUipignore(body: string): Set<string>;
+/**
+ * Recursively walk `dir`, returning every file path and every empty directory
+ * path beneath it. An empty directory is a directory whose `readdir` returns
+ * no entries; deeper empty chains are represented by their leaves only, since
+ * fflate creates parent directory records implicitly when it sees `a/b/c/`.
+ *
+ * Skips DEFAULT_EXCLUDED_DIR_NAMES plus any `additionalExcludeDirs` the
+ * caller provides. Exclusion is by exact directory name at any depth.
+ */
+export declare function collectTree(fs: IFileSystem, dir: string, options?: {
+    additionalExcludeDirs?: Iterable<string>;
+}): Promise<{
+    files: string[];
+    emptyDirs: string[];
+}>;
+/**
+ * Recursively collect all file paths under a directory.
+ */
+export declare function collectFiles(fs: IFileSystem, dir: string, options?: {
+    additionalExcludeDirs?: Iterable<string>;
+}): Promise<string[]>;
+/**
+ * Collect all files (and empty directories) under `dir` and zip them using
+ * fflate. Empty directories are written as standard zip directory records
+ * (path keys ending with `/` mapped to a zero-length buffer) so they survive
+ * the round-trip to Studio Web.
+ *
+ * Returns the zip as a Uint8Array.
+ */
+export declare function createZipFromDir(fs: IFileSystem, dir: string, options?: {
+    additionalExcludeDirs?: Iterable<string>;
+}): Promise<Uint8Array>;

package/package.json

@@ -0,0 +1,44 @@
+{
+    "name": "@uipath/solution-sdk",
+    "license": "MIT",
+    "version": "1.196.0",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/UiPath/cli.git",
+        "directory": "packages/solution-sdk"
+    },
+    "publishConfig": {
+        "registry": "https://registry.npmjs.org/"
+    },
+    "keywords": [
+        "uipath",
+        "solution",
+        "sdk"
+    ],
+    "type": "module",
+    "main": "./dist/index.js",
+    "types": "./dist/src/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/src/index.d.ts",
+            "default": "./dist/index.js"
+        }
+    },
+    "bin": {
+        "generate-sdk": "./dist/scripts/generate-sdk.js"
+    },
+    "files": [
+        "dist"
+    ],
+    "private": false,
+    "devDependencies": {
+        "@openapitools/openapi-generator-cli": "^2.31.1",
+        "@uipath/common": "1.196.0",
+        "@uipath/filesystem": "1.196.0",
+        "@uipath/studioweb-sdk": "1.196.0",
+        "@types/node": "^25.5.2",
+        "fflate": "^0.8.2",
+        "typescript": "^6.0.2"
+    },
+    "gitHead": "bed2b46f1ec33a47a7dcae2e6d4b7ab99bd06981"
+}