@bluelibs/runner-dev 6.1.0 → 6.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +143 -14
- package/dist/cli/generators/initUtils.js +1 -1
- package/dist/cli/generators/initUtils.js.map +1 -1
- package/dist/cli/generators/scaffold/templates/README.md.js +21 -5
- package/dist/cli/generators/scaffold/templates/README.md.js.map +1 -1
- package/dist/cli/generators/scaffold/templates/index.d.ts +2 -3
- package/dist/cli/generators/scaffold/templates/index.js +5 -7
- package/dist/cli/generators/scaffold/templates/index.js.map +1 -1
- package/dist/cli/generators/scaffold/templates/package.json.d.ts +11 -8
- package/dist/cli/generators/scaffold/templates/package.json.js +11 -8
- package/dist/cli/generators/scaffold/templates/package.json.js.map +1 -1
- package/dist/cli/generators/scaffold/templates/src/app.test.ts.d.ts +1 -0
- package/dist/cli/generators/scaffold/templates/src/app.test.ts.js +29 -0
- package/dist/cli/generators/scaffold/templates/src/app.test.ts.js.map +1 -0
- package/dist/cli/generators/scaffold/templates/src/app.ts.d.ts +1 -0
- package/dist/cli/generators/scaffold/templates/src/app.ts.js +15 -0
- package/dist/cli/generators/scaffold/templates/src/app.ts.js.map +1 -0
- package/dist/cli/generators/scaffold/templates/src/main.test.ts.js +3 -1
- package/dist/cli/generators/scaffold/templates/src/main.test.ts.js.map +1 -1
- package/dist/cli/generators/scaffold/templates/src/main.ts.js +3 -10
- package/dist/cli/generators/scaffold/templates/src/main.ts.js.map +1 -1
- package/dist/cli/generators/scaffold/templates/tsconfig.json.d.ts +2 -0
- package/dist/cli/generators/scaffold/templates/tsconfig.json.js +2 -0
- package/dist/cli/generators/scaffold/templates/tsconfig.json.js.map +1 -1
- package/dist/cli/generators/scaffold.js +2 -3
- package/dist/cli/generators/scaffold.js.map +1 -1
- package/dist/cli/init.js +1 -2
- package/dist/cli/init.js.map +1 -1
- package/dist/docs/packageDocs.d.ts +16 -0
- package/dist/docs/packageDocs.js +107 -0
- package/dist/docs/packageDocs.js.map +1 -0
- package/dist/exportDocs.d.ts +10 -0
- package/dist/exportDocs.js +98 -0
- package/dist/exportDocs.js.map +1 -0
- package/dist/generated/resolvers-types.d.ts +127 -42
- package/dist/index.d.ts +5 -2
- package/dist/index.js +3 -1
- package/dist/index.js.map +1 -1
- package/dist/mcp/env.d.ts +5 -0
- package/dist/mcp/env.js +30 -1
- package/dist/mcp/env.js.map +1 -1
- package/dist/mcp/help.d.ts +8 -1
- package/dist/mcp/help.js +30 -4
- package/dist/mcp/help.js.map +1 -1
- package/dist/mcp/http.js +10 -0
- package/dist/mcp/http.js.map +1 -1
- package/dist/mcp/projectOverview.js +13 -4
- package/dist/mcp/projectOverview.js.map +1 -1
- package/dist/mcp/snapshot.d.ts +22 -0
- package/dist/mcp/snapshot.js +347 -0
- package/dist/mcp/snapshot.js.map +1 -0
- package/dist/mcp/tools/graphql.mutation.js +4 -1
- package/dist/mcp/tools/graphql.mutation.js.map +1 -1
- package/dist/mcp/tools/graphql.ping.js +1 -1
- package/dist/mcp/tools/graphql.ping.js.map +1 -1
- package/dist/mcp/tools/graphql.query.js +1 -1
- package/dist/mcp/tools/graphql.query.js.map +1 -1
- package/dist/mcp/tools/help.read.js +7 -5
- package/dist/mcp/tools/help.read.js.map +1 -1
- package/dist/mcp/tools/help.runner.js +3 -1
- package/dist/mcp/tools/help.runner.js.map +1 -1
- package/dist/mcp/tools/help.runnerDev.js +4 -4
- package/dist/mcp/tools/help.runnerDev.js.map +1 -1
- package/dist/mcp.js +4 -9
- package/dist/mcp.js.map +1 -1
- package/dist/resources/cli.config.resource.js +1 -1
- package/dist/resources/cli.config.resource.js.map +1 -1
- package/dist/resources/coverage.resource.js +1 -1
- package/dist/resources/coverage.resource.js.map +1 -1
- package/dist/resources/dev.resource.d.ts +1 -1
- package/dist/resources/dev.resource.js +1 -1
- package/dist/resources/dev.resource.js.map +1 -1
- package/dist/resources/docs.generator.resource.js +1 -1
- package/dist/resources/docs.generator.resource.js.map +1 -1
- package/dist/resources/docsPayload.d.ts +33 -0
- package/dist/resources/docsPayload.js +171 -0
- package/dist/resources/docsPayload.js.map +1 -0
- package/dist/resources/docsUiAssets.d.ts +27 -0
- package/dist/resources/docsUiAssets.js +150 -0
- package/dist/resources/docsUiAssets.js.map +1 -0
- package/dist/resources/graphql-accumulator.resource.d.ts +1 -0
- package/dist/resources/graphql-accumulator.resource.js +31 -27
- package/dist/resources/graphql-accumulator.resource.js.map +1 -1
- package/dist/resources/graphql.cli.resource.js +1 -1
- package/dist/resources/graphql.cli.resource.js.map +1 -1
- package/dist/resources/graphql.query.cli.task.d.ts +2 -4
- package/dist/resources/graphql.query.cli.task.js +1 -1
- package/dist/resources/graphql.query.cli.task.js.map +1 -1
- package/dist/resources/graphql.query.task.d.ts +2 -4
- package/dist/resources/graphql.query.task.js +1 -1
- package/dist/resources/graphql.query.task.js.map +1 -1
- package/dist/resources/http.tag.js +1 -1
- package/dist/resources/http.tag.js.map +1 -1
- package/dist/resources/introspector.cli.resource.js +1 -1
- package/dist/resources/introspector.cli.resource.js.map +1 -1
- package/dist/resources/introspector.resource.js +1 -1
- package/dist/resources/introspector.resource.js.map +1 -1
- package/dist/resources/live.resource.js +4 -4
- package/dist/resources/live.resource.js.map +1 -1
- package/dist/resources/models/Introspector.d.ts +16 -4
- package/dist/resources/models/Introspector.js +68 -39
- package/dist/resources/models/Introspector.js.map +1 -1
- package/dist/resources/models/durable.tools.js +3 -1
- package/dist/resources/models/durable.tools.js.map +1 -1
- package/dist/resources/models/initializeFromStore.js +5 -5
- package/dist/resources/models/initializeFromStore.js.map +1 -1
- package/dist/resources/models/initializeFromStore.utils.d.ts +2 -2
- package/dist/resources/models/initializeFromStore.utils.js +424 -78
- package/dist/resources/models/initializeFromStore.utils.js.map +1 -1
- package/dist/resources/models/introspector.tools.js +103 -19
- package/dist/resources/models/introspector.tools.js.map +1 -1
- package/dist/resources/routeHandlers/createDocsServeHandler.js +13 -37
- package/dist/resources/routeHandlers/createDocsServeHandler.js.map +1 -1
- package/dist/resources/routeHandlers/getDocsData.d.ts +1 -6
- package/dist/resources/routeHandlers/getDocsData.js +10 -168
- package/dist/resources/routeHandlers/getDocsData.js.map +1 -1
- package/dist/resources/routeHandlers/registerHttpRoutes.hook.js +1 -1
- package/dist/resources/routeHandlers/registerHttpRoutes.hook.js.map +1 -1
- package/dist/resources/server.resource.js +1 -2
- package/dist/resources/server.resource.js.map +1 -1
- package/dist/resources/swap.cli.resource.js +1 -1
- package/dist/resources/swap.cli.resource.js.map +1 -1
- package/dist/resources/swap.resource.js +1 -1
- package/dist/resources/swap.resource.js.map +1 -1
- package/dist/resources/telemetry.resource.js +27 -6
- package/dist/resources/telemetry.resource.js.map +1 -1
- package/dist/resources/ui.static.js +4 -9
- package/dist/resources/ui.static.js.map +1 -1
- package/dist/runtime/symbolMetadata.d.ts +1 -0
- package/dist/{architect/core/interfaces.js → runtime/symbolMetadata.js} +1 -1
- package/dist/runtime/symbolMetadata.js.map +1 -0
- package/dist/schema/model.d.ts +18 -0
- package/dist/schema/model.js +14 -0
- package/dist/schema/model.js.map +1 -1
- package/dist/schema/query.js +6 -4
- package/dist/schema/query.js.map +1 -1
- package/dist/schema/types/AllType.js +2 -21
- package/dist/schema/types/AllType.js.map +1 -1
- package/dist/schema/types/AsyncContextType.js +21 -17
- package/dist/schema/types/AsyncContextType.js.map +1 -1
- package/dist/schema/types/ErrorType.js +1 -3
- package/dist/schema/types/ErrorType.js.map +1 -1
- package/dist/schema/types/EventType.js +6 -19
- package/dist/schema/types/EventType.js.map +1 -1
- package/dist/schema/types/HookType.js +4 -16
- package/dist/schema/types/HookType.js.map +1 -1
- package/dist/schema/types/ResourceType.js +50 -23
- package/dist/schema/types/ResourceType.js.map +1 -1
- package/dist/schema/types/TaskLikeCommon.js +2 -2
- package/dist/schema/types/TaskLikeCommon.js.map +1 -1
- package/dist/schema/types/TaskType.js +6 -19
- package/dist/schema/types/TaskType.js.map +1 -1
- package/dist/schema/types/middleware/UsageTypes.d.ts +1 -0
- package/dist/schema/types/middleware/UsageTypes.js +16 -5
- package/dist/schema/types/middleware/UsageTypes.js.map +1 -1
- package/dist/schema/types/middleware/common.js +2 -2
- package/dist/schema/types/middleware/common.js.map +1 -1
- package/dist/ui/.vite/manifest.json +2 -2
- package/dist/ui/assets/docs-Beb_xRuE.js +304 -0
- package/dist/ui/assets/docs-Beb_xRuE.js.map +1 -0
- package/dist/ui/assets/docs-lid1amCk.css +1 -0
- package/dist/ui/docs/favicon.ico +0 -0
- package/dist/utils/lane-resources.d.ts +69 -0
- package/dist/utils/lane-resources.js +154 -1
- package/dist/utils/lane-resources.js.map +1 -1
- package/dist/utils/runner-namespace.d.ts +1 -0
- package/dist/utils/runner-namespace.js +9 -0
- package/dist/utils/runner-namespace.js.map +1 -0
- package/dist/utils/schemaFormat.d.ts +6 -0
- package/dist/utils/schemaFormat.js +244 -0
- package/dist/utils/schemaFormat.js.map +1 -0
- package/dist/utils/system-namespace.d.ts +1 -0
- package/dist/utils/system-namespace.js +9 -0
- package/dist/utils/system-namespace.js.map +1 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +29 -11
- package/readmes/API_REFERENCE.md +364 -0
- package/readmes/COMPACT_GUIDE.md +254 -0
- package/skills/core/SKILL.md +27 -0
- package/skills/core/references/readmes/API_REFERENCE.md +364 -0
- package/skills/core/references/readmes/COMPACT_GUIDE.md +254 -0
- package/AI.md +0 -622
- package/dist/app/tasks/create-user.task.d.ts +0 -5
- package/dist/app/tasks/create-user.task.js +0 -20
- package/dist/app/tasks/create-user.task.js.map +0 -1
- package/dist/app/tasks/index.d.ts +0 -1
- package/dist/app/tasks/index.js +0 -18
- package/dist/app/tasks/index.js.map +0 -1
- package/dist/architect/core/errors.d.ts +0 -39
- package/dist/architect/core/errors.js +0 -143
- package/dist/architect/core/errors.js.map +0 -1
- package/dist/architect/core/index.d.ts +0 -3
- package/dist/architect/core/index.js +0 -21
- package/dist/architect/core/index.js.map +0 -1
- package/dist/architect/core/interfaces.d.ts +0 -158
- package/dist/architect/core/interfaces.js.map +0 -1
- package/dist/architect/core/types.d.ts +0 -544
- package/dist/architect/core/types.js +0 -49
- package/dist/architect/core/types.js.map +0 -1
- package/dist/architect/execution/executor.d.ts +0 -23
- package/dist/architect/execution/executor.js +0 -476
- package/dist/architect/execution/executor.js.map +0 -1
- package/dist/architect/execution/index.d.ts +0 -1
- package/dist/architect/execution/index.js +0 -19
- package/dist/architect/execution/index.js.map +0 -1
- package/dist/architect/executor.d.ts +0 -7
- package/dist/architect/executor.js +0 -150
- package/dist/architect/executor.js.map +0 -1
- package/dist/architect/index.d.ts +0 -45
- package/dist/architect/index.js +0 -76
- package/dist/architect/index.js.map +0 -1
- package/dist/architect/llmClient.d.ts +0 -10
- package/dist/architect/llmClient.js +0 -33
- package/dist/architect/llmClient.js.map +0 -1
- package/dist/architect/models/base.d.ts +0 -16
- package/dist/architect/models/base.js +0 -68
- package/dist/architect/models/base.js.map +0 -1
- package/dist/architect/models/factory.d.ts +0 -16
- package/dist/architect/models/factory.js +0 -73
- package/dist/architect/models/factory.js.map +0 -1
- package/dist/architect/models/index.d.ts +0 -3
- package/dist/architect/models/index.js +0 -21
- package/dist/architect/models/index.js.map +0 -1
- package/dist/architect/models/openai.d.ts +0 -7
- package/dist/architect/models/openai.js +0 -71
- package/dist/architect/models/openai.js.map +0 -1
- package/dist/architect/planner.d.ts +0 -9
- package/dist/architect/planner.js +0 -42
- package/dist/architect/planner.js.map +0 -1
- package/dist/architect/planning/index.d.ts +0 -4
- package/dist/architect/planning/index.js +0 -22
- package/dist/architect/planning/index.js.map +0 -1
- package/dist/architect/planning/optimizer.d.ts +0 -14
- package/dist/architect/planning/optimizer.js +0 -275
- package/dist/architect/planning/optimizer.js.map +0 -1
- package/dist/architect/planning/planner.d.ts +0 -15
- package/dist/architect/planning/planner.js +0 -124
- package/dist/architect/planning/planner.js.map +0 -1
- package/dist/architect/planning/prompts.d.ts +0 -6
- package/dist/architect/planning/prompts.js +0 -111
- package/dist/architect/planning/prompts.js.map +0 -1
- package/dist/architect/planning/validator.d.ts +0 -16
- package/dist/architect/planning/validator.js +0 -331
- package/dist/architect/planning/validator.js.map +0 -1
- package/dist/architect/prompt.d.ts +0 -1
- package/dist/architect/prompt.js +0 -13
- package/dist/architect/prompt.js.map +0 -1
- package/dist/architect/types.d.ts +0 -4
- package/dist/architect/types.js +0 -24
- package/dist/architect/types.js.map +0 -1
- package/dist/cli/generators/scaffold/templates/jest.config.cjs.d.ts +0 -1
- package/dist/cli/generators/scaffold/templates/jest.config.cjs.js +0 -24
- package/dist/cli/generators/scaffold/templates/jest.config.cjs.js.map +0 -1
- package/dist/cli/generators/scaffold/templates/tsconfig.jest.json.d.ts +0 -11
- package/dist/cli/generators/scaffold/templates/tsconfig.jest.json.js +0 -17
- package/dist/cli/generators/scaffold/templates/tsconfig.jest.json.js.map +0 -1
- package/dist/client/documentation.d.ts +0 -8
- package/dist/client/documentation.js +0 -144
- package/dist/client/documentation.js.map +0 -1
- package/dist/components/Documentation/Documentation.d.ts +0 -8
- package/dist/components/Documentation/Documentation.js +0 -283
- package/dist/components/Documentation/Documentation.js.map +0 -1
- package/dist/components/Documentation/components/DiagnosticsPanel.d.ts +0 -7
- package/dist/components/Documentation/components/DiagnosticsPanel.js +0 -189
- package/dist/components/Documentation/components/DiagnosticsPanel.js.map +0 -1
- package/dist/components/Documentation/components/EventCard.d.ts +0 -8
- package/dist/components/Documentation/components/EventCard.js +0 -290
- package/dist/components/Documentation/components/EventCard.js.map +0 -1
- package/dist/components/Documentation/components/HookCard.d.ts +0 -8
- package/dist/components/Documentation/components/HookCard.js +0 -282
- package/dist/components/Documentation/components/HookCard.js.map +0 -1
- package/dist/components/Documentation/components/MiddlewareCard.d.ts +0 -8
- package/dist/components/Documentation/components/MiddlewareCard.js +0 -314
- package/dist/components/Documentation/components/MiddlewareCard.js.map +0 -1
- package/dist/components/Documentation/components/ResourceCard.d.ts +0 -8
- package/dist/components/Documentation/components/ResourceCard.js +0 -228
- package/dist/components/Documentation/components/ResourceCard.js.map +0 -1
- package/dist/components/Documentation/components/Sidebar.d.ts +0 -13
- package/dist/components/Documentation/components/Sidebar.js +0 -165
- package/dist/components/Documentation/components/Sidebar.js.map +0 -1
- package/dist/components/Documentation/components/TagCard.d.ts +0 -7
- package/dist/components/Documentation/components/TagCard.js +0 -75
- package/dist/components/Documentation/components/TagCard.js.map +0 -1
- package/dist/components/Documentation/components/TaskCard.d.ts +0 -8
- package/dist/components/Documentation/components/TaskCard.js +0 -196
- package/dist/components/Documentation/components/TaskCard.js.map +0 -1
- package/dist/components/Documentation/index.d.ts +0 -2
- package/dist/components/Documentation/index.js +0 -6
- package/dist/components/Documentation/index.js.map +0 -1
- package/dist/components/Documentation/utils/formatting.d.ts +0 -8
- package/dist/components/Documentation/utils/formatting.js +0 -84
- package/dist/components/Documentation/utils/formatting.js.map +0 -1
- package/dist/components/ExampleComponent.d.ts +0 -10
- package/dist/components/ExampleComponent.js +0 -89
- package/dist/components/ExampleComponent.js.map +0 -1
- package/dist/mcp/z3.d.ts +0 -1
- package/dist/mcp/z3.js +0 -9
- package/dist/mcp/z3.js.map +0 -1
- package/dist/project-writer/AIModel.d.ts +0 -29
- package/dist/project-writer/AIModel.js +0 -48
- package/dist/project-writer/AIModel.js.map +0 -1
- package/dist/resources/docs.route.d.ts +0 -23
- package/dist/resources/docs.route.js +0 -73
- package/dist/resources/docs.route.js.map +0 -1
- package/dist/resources/durable.workflow.tag.d.ts +0 -2
- package/dist/resources/durable.workflow.tag.js +0 -28
- package/dist/resources/durable.workflow.tag.js.map +0 -1
- package/dist/resources/getFileContents.task.d.ts +0 -17
- package/dist/resources/getFileContents.task.js +0 -44
- package/dist/resources/getFileContents.task.js.map +0 -1
- package/dist/resources/introspector.tools.d.ts +0 -47
- package/dist/resources/introspector.tools.js +0 -505
- package/dist/resources/introspector.tools.js.map +0 -1
- package/dist/resources/models/extractTunnelInfo.d.ts +0 -8
- package/dist/resources/models/extractTunnelInfo.js +0 -85
- package/dist/resources/models/extractTunnelInfo.js.map +0 -1
- package/dist/resources/models/tunnel.tools.d.ts +0 -3
- package/dist/resources/models/tunnel.tools.js +0 -35
- package/dist/resources/models/tunnel.tools.js.map +0 -1
- package/dist/runner-compat.d.ts +0 -85
- package/dist/runner-compat.js +0 -178
- package/dist/runner-compat.js.map +0 -1
- package/dist/runner-node-compat.d.ts +0 -2
- package/dist/runner-node-compat.js +0 -28
- package/dist/runner-node-compat.js.map +0 -1
- package/dist/schema/types/TunnelInfoType.d.ts +0 -5
- package/dist/schema/types/TunnelInfoType.js +0 -86
- package/dist/schema/types/TunnelInfoType.js.map +0 -1
- package/dist/tasks/create-user.d.ts +0 -5
- package/dist/tasks/create-user.js +0 -20
- package/dist/tasks/create-user.js.map +0 -1
- package/dist/tasks/index.d.ts +0 -1
- package/dist/tasks/index.js +0 -18
- package/dist/tasks/index.js.map +0 -1
- package/dist/ui/assets/docs-CHvYnckk.js +0 -302
- package/dist/ui/assets/docs-CHvYnckk.js.map +0 -1
- package/dist/ui/assets/docs-CipvKUxZ.css +0 -1
- package/dist/ui-test/index.html +0 -1
- package/readmes/runner-AI.md +0 -740
- package/readmes/runner-durable-workflows.md +0 -2247
- package/readmes/runner-full-guide.md +0 -5869
- package/readmes/runner-remote-lanes.md +0 -909
package/dist/cli/init.js
CHANGED
|
@@ -130,8 +130,7 @@ async function main(argv) {
|
|
|
130
130
|
}
|
|
131
131
|
if (shouldRunTests && !SKIP_TESTS) {
|
|
132
132
|
console.log("\nRunning tests...\n");
|
|
133
|
-
|
|
134
|
-
await (0, initUtils_1.runCommand)("npm", ["run", "test", "--", "--ci", "--watchAll=false", "--runInBand"], targetDir);
|
|
133
|
+
await (0, initUtils_1.runCommand)("npm", ["run", "test"], targetDir);
|
|
135
134
|
}
|
|
136
135
|
else if (shouldRunTests && SKIP_TESTS) {
|
|
137
136
|
console.log("\nSkipping tests due to RUNNER_DEV_* env.\n");
|
package/dist/cli/init.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/cli/init.ts"],"names":[],"mappings":";;;;;AAaA,
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/cli/init.ts"],"names":[],"mappings":";;;;;AAaA,oBA8OC;AA3PD,gDAAwB;AACxB,sDAAgF;AAChF,qCAA8D;AAE9D,oDAAyD;AACzD,oDAAiD;AACjD,4DAAyD;AAOlD,KAAK,UAAU,IAAI,CAAC,IAAc;IACvC,sEAAsE;IACtE,MAAM,eAAe,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IAChC,MAAM,SAAS,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1B,0DAA0D;IAC1D,4CAA4C;IAC5C,kDAAkD;IAClD,6DAA6D;IAC7D,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,IAAA,sBAAU,EAAC,QAAQ,CAAC,CAAC;IAClD,IACE,eAAe,KAAK,MAAM;QAC1B,eAAe,KAAK,IAAI;QACxB,eAAe,KAAK,QAAQ;QAC5B,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC;QACnB,CAAC,eAAe,EAChB,CAAC;QACD,IAAA,2BAAY,GAAE,CAAC;QACf,OAAO;IACT,CAAC;IACD,MAAM,UAAU,GAAmB;QACjC,SAAS;QACT,UAAU;QACV,MAAM;QACN,OAAO;QACP,MAAM;QACN,KAAK;QACL,iBAAiB;QACjB,qBAAqB;KACtB,CAAC;IAEF,IAAI,IAAkB,CAAC;IACvB,IAAI,aAAiC,CAAC;IACtC,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;QAClC,IAAI,GAAG,SAAS,CAAC;QACjB,aAAa,GAAG,SAAS,IAAI,mBAAmB,CAAC;IACnD,CAAC;SAAM,IAAK,UAAuB,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,CAAC;QAC9D,IAAI,GAAG,eAA+B,CAAC;QACvC,aAAa,GAAG,SAAS,CAAC;IAC5B,CAAC;SAAM,CAAC;QACN,gDAAgD;QAChD,IAAI,GAAG,SAAS,CAAC;QACjB,aAAa,GAAG,eAAe,IAAI,mBAAmB,CAAC;IACzD,CAAC;IAED,eAAe;IACf,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC7C,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACrC,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC3E,0EAA0E;IAC1E,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,EAAE,KAAK,MAAM,CAAC;IAC9E,MAAM,YAAY,GAAG,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,KAAK,GAAG,CAAC;IACzE,MAAM,UAAU,GAAG,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,KAAK,GAAG,CAAC;IACrE,MAAM,QAAQ,GAAG,IAAI,IAAI,OAAO,CAAC,GAAG,CAAC,mBAAmB,KAAK,GAAG,CAAC;IAEjE,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,WAAW,GAAG,CAAC,aAAa,IAAI,mBAAmB,CAAC,CAAC,IAAI,EAAE,CAAC;QAClE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC1C,OAAO,CAAC,KAAK,CACX,0EAA0E,CAC3E,CAAC;YACF,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;YACrB,OAAO;QACT,CAAC;QAED,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,WAAW,CAAC,CAAC;QAC3D,MAAM,IAAA,0BAAc,EAAC,SAAS,CAAC,CAAC;QAEhC,MAAM,OAAO,GAAoB,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;QAC5D,MAAM,IAAA,mBAAQ,EAAC,OAAO,CAAC,CAAC;QAExB,OAAO,CAAC,GAAG,CAAC,KAAK,UAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,IAAI,UAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QAExE,6BAA6B;QAC7B,MAAM,KAAK,GAAG,IAAA,kBAAS,EACrB;YACE,CAAC,UAAC,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,qCAAqC,CAAC;YAC9D,CAAC,UAAC,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,kDAAkD,CAAC;YACvE,CAAC,UAAC,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,+BAA+B,CAAC;SAC3D,EACD,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CACtB,CAAC;QAEF,MAAM,KAAK,GAAG,IAAA,oBAAW,EACvB;YACE,GAAG,UAAC,CAAC,IAAI,CAAC,+BAA+B,CAAC,EAAE;YAC5C,0CAA0C,UAAC,CAAC,GAAG,CAC7C,sBAAsB,CACvB,2CAA2C;YAC5C,GAAG,UAAC,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE;YAC1B,GAAG,UAAC,CAAC,GAAG,CACN,2BAA2B,CAC5B,2CAA2C;SAC7C,CAAC,IAAI,CAAC,IAAI,CAAC,EACZ,CAAC,CACF,CAAC;QAEF,MAAM,cAAc,GAAG,4CAA4C,CAAC;QACpE,MAAM,GAAG,GAAG,IAAA,kBAAS,EACnB;YACE,CAAC,UAAC,CAAC,IAAI,CAAC,6BAA6B,CAAC,EAAE,sBAAsB,CAAC;YAC/D,CAAC,UAAC,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,yBAAyB,CAAC;YACnD,CAAC,UAAC,CAAC,IAAI,CAAC,sBAAsB,CAAC,EAAE,uBAAuB,CAAC;SAC1D,EACD,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CACtB,CAAC;QAEF,OAAO,CAAC,GAAG,CACT;YACE,EAAE;YACF,UAAC,CAAC,KAAK,CAAC,4BAA4B,CAAC;YACrC,IAAA,gBAAO,GAAE;YACT,UAAC,CAAC,IAAI,CAAC,4BAA4B,CAAC;YACpC,KAAK;YACL,EAAE;YACF,UAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC;YACxB,KAAK;YACL,EAAE;YACF,UAAC,CAAC,IAAI,CAAC,aAAa,CAAC;YACrB,GAAG;YACH,EAAE;SACH,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAEF,OAAO,CAAC,GAAG,CACT;YACE,UAAC,CAAC,IAAI,CAAC,WAAW,CAAC;YACnB,IAAA,kBAAS,EACP;gBACE,CAAC,UAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,+BAA+B,CAAC;gBACpD,CAAC,UAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,+BAA+B,CAAC;gBACpD,CAAC,UAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,4BAA4B,CAAC;aAC/C,EACD,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CACtB;SACF,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QAEF,yCAAyC;QACzC,IAAI,CAAC,aAAa,IAAI,cAAc,IAAI,SAAS,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YACpE,OAAO,CAAC,GAAG,CAAC,gCAAgC,CAAC,CAAC;YAC9C,MAAM,IAAA,sBAAU,EACd,KAAK,EACL;gBACE,SAAS;gBACT,kBAAkB;gBAClB,YAAY;gBACZ,WAAW;gBACX,kBAAkB;aACnB,EACD,SAAS,CACV,CAAC;QACJ,CAAC;aAAM,IAAI,aAAa,IAAI,YAAY,EAAE,CAAC;YACzC,OAAO,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,cAAc,IAAI,CAAC,UAAU,EAAE,CAAC;YAClC,OAAO,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;YACpC,MAAM,IAAA,sBAAU,EAAC,KAAK,EAAE,CAAC,KAAK,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;QACtD,CAAC;aAAM,IAAI,cAAc,IAAI,UAAU,EAAE,CAAC;YACxC,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC;QAC7D,CAAC;QACD,IAAI,SAAS,IAAI,CAAC,QAAQ,EAAE,CAAC;YAC3B,OAAO,CAAC,GAAG,CAAC,6CAA6C,CAAC,CAAC;YAC3D,MAAM,IAAA,sBAAU,EAAC,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,SAAS,CAAC,CAAC;QACrD,CAAC;aAAM,IAAI,SAAS,IAAI,QAAQ,EAAE,CAAC;YACjC,OAAO,CAAC,GAAG,CAAC,wDAAwD,CAAC,CAAC;QACxE,CAAC;QAED,OAAO,CAAC,GAAG,CACT,KAAK,UAAC,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,IAAA,kBAAS,EACrC;YACE,CAAC,UAAC,CAAC,GAAG,CAAC,MAAM,WAAW,EAAE,CAAC,EAAE,yBAAyB,CAAC;YACvD,CAAC,UAAC,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,sBAAsB,CAAC;YAC9C,CAAC,UAAC,CAAC,GAAG,CAAC,aAAa,CAAC,EAAE,wBAAwB,CAAC;SACjD,EACD,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CACtB,EAAE,CACJ,CAAC;QACF,OAAO;IACT,CAAC;IAED,2CAA2C;IAC3C,MAAM,OAAO,GAAG,CAAC,aAAa,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC7C,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CACX,gDAAgD,IAAI,wCAAwC,CAC7F,CAAC;QACF,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrB,OAAO;IACT,CAAC;IAED,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,WAAW,CAAC,IAAI,KAAK,CAAC;IAC7D,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC;IACxC,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IAC5D,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;IACpE,MAAM,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAEnC,IAAI,GAAiD,CAAC;IACtD,IAAI,CAAC;QACH,GAAG,GAAG,MAAM,IAAA,2BAAgB,EAAC;YAC3B,IAAI;YACJ,IAAI,EAAE,OAAO;YACb,SAAS,EAAE,KAAK;YAChB,OAAO;YACP,MAAM;YACN,QAAQ;YACR,UAAU;YACV,KAAK;SACN,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,KAAK,CAAE,CAAW,EAAE,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;QAClD,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;QACrB,OAAO;IACT,CAAC;IAED,IAAI,MAAM,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QAC1B,OAAO,CAAC,GAAG,CAAC,KAAK,UAAC,CAAC,KAAK,CAAC,4BAA4B,CAAC,EAAE,CAAC,CAAC;QAE1D,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACrE,OAAO;IACT,CAAC;IAED,OAAO,CAAC,GAAG,CACT,KAAK,UAAC,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,UAAC,CAAC,IAAI,CAC/B,cAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,CAAC,QAAQ,CAAC,CAC3C,IAAI;QACH,IAAA,kBAAS,EACP;YACE,CAAC,UAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;YACtB;gBACE,UAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAChB,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,qBAAqB;aAC3D;SACF,EACD,EAAE,GAAG,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CACtB,CACJ,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
export declare const RUNNER_FRAMEWORK_COMPACT_DOC_PATHS: readonly ["readmes/COMPACT_GUIDE.md"];
|
|
2
|
+
export declare const RUNNER_FRAMEWORK_COMPLETE_DOC_PATHS: readonly ["readmes/FULL_GUIDE.md"];
|
|
3
|
+
export declare class PackageDocNotFoundError extends Error {
|
|
4
|
+
readonly attemptedPaths: string[];
|
|
5
|
+
constructor(packageName: string, docPaths: readonly string[], attemptedPaths: string[]);
|
|
6
|
+
}
|
|
7
|
+
export declare function readPackageDoc(packageName: string, docPath?: string): Promise<{
|
|
8
|
+
packageName: string;
|
|
9
|
+
filePath: string;
|
|
10
|
+
content: string;
|
|
11
|
+
}>;
|
|
12
|
+
export declare function readFirstAvailablePackageDoc(packageName: string, docPaths: string[]): Promise<{
|
|
13
|
+
packageName: string;
|
|
14
|
+
filePath: string;
|
|
15
|
+
content: string;
|
|
16
|
+
}>;
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.PackageDocNotFoundError = exports.RUNNER_FRAMEWORK_COMPLETE_DOC_PATHS = exports.RUNNER_FRAMEWORK_COMPACT_DOC_PATHS = void 0;
|
|
7
|
+
exports.readPackageDoc = readPackageDoc;
|
|
8
|
+
exports.readFirstAvailablePackageDoc = readFirstAvailablePackageDoc;
|
|
9
|
+
const promises_1 = __importDefault(require("node:fs/promises"));
|
|
10
|
+
const node_path_1 = __importDefault(require("node:path"));
|
|
11
|
+
const path_1 = require("../utils/path");
|
|
12
|
+
exports.RUNNER_FRAMEWORK_COMPACT_DOC_PATHS = [
|
|
13
|
+
"readmes/COMPACT_GUIDE.md",
|
|
14
|
+
];
|
|
15
|
+
exports.RUNNER_FRAMEWORK_COMPLETE_DOC_PATHS = [
|
|
16
|
+
"readmes/FULL_GUIDE.md",
|
|
17
|
+
];
|
|
18
|
+
const PACKAGE_NAME_PATTERN = /^(?:@[a-z0-9_.-]+\/)?[a-z0-9_.-]+$/i;
|
|
19
|
+
const PACKAGE_DOC_ROOTS_BY_PACKAGE = {
|
|
20
|
+
"@bluelibs/runner": [
|
|
21
|
+
".agents/skills/bluelibs-runner-core/references",
|
|
22
|
+
"node_modules/@bluelibs/runner",
|
|
23
|
+
],
|
|
24
|
+
};
|
|
25
|
+
class PackageDocNotFoundError extends Error {
|
|
26
|
+
attemptedPaths;
|
|
27
|
+
constructor(packageName, docPaths, attemptedPaths) {
|
|
28
|
+
super(`Required package docs for ${packageName} were not found. Tried: ${docPaths.join(", ")}`);
|
|
29
|
+
this.attemptedPaths = attemptedPaths;
|
|
30
|
+
this.name = "PackageDocNotFoundError";
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
exports.PackageDocNotFoundError = PackageDocNotFoundError;
|
|
34
|
+
function isMissingFileError(error) {
|
|
35
|
+
return (typeof error === "object" &&
|
|
36
|
+
error !== null &&
|
|
37
|
+
"code" in error &&
|
|
38
|
+
error.code === "ENOENT");
|
|
39
|
+
}
|
|
40
|
+
function normalizeDocPath(docPath) {
|
|
41
|
+
const normalized = node_path_1.default.posix.normalize(docPath.replaceAll("\\", "/"));
|
|
42
|
+
if (!normalized ||
|
|
43
|
+
normalized === "." ||
|
|
44
|
+
normalized.startsWith("../") ||
|
|
45
|
+
normalized === ".." ||
|
|
46
|
+
node_path_1.default.posix.isAbsolute(normalized)) {
|
|
47
|
+
return "README.md";
|
|
48
|
+
}
|
|
49
|
+
return normalized;
|
|
50
|
+
}
|
|
51
|
+
function getPackageDocCandidatePaths(root, packageName, normalizedDocPath) {
|
|
52
|
+
const configuredRoots = PACKAGE_DOC_ROOTS_BY_PACKAGE[packageName];
|
|
53
|
+
if (configuredRoots?.length) {
|
|
54
|
+
return configuredRoots.map((configuredRoot) => node_path_1.default.join(root, configuredRoot, normalizedDocPath));
|
|
55
|
+
}
|
|
56
|
+
const packageRoot = node_path_1.default.join(root, "node_modules", packageName);
|
|
57
|
+
return [node_path_1.default.join(packageRoot, normalizedDocPath)];
|
|
58
|
+
}
|
|
59
|
+
async function readPackageDoc(packageName, docPath = "README.md") {
|
|
60
|
+
if (!PACKAGE_NAME_PATTERN.test(packageName)) {
|
|
61
|
+
return {
|
|
62
|
+
packageName,
|
|
63
|
+
filePath: packageName,
|
|
64
|
+
content: "",
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
const root = process.cwd();
|
|
68
|
+
const normalizedDocPath = normalizeDocPath(docPath);
|
|
69
|
+
const candidatePaths = getPackageDocCandidatePaths(root, packageName, normalizedDocPath);
|
|
70
|
+
let lastTriedPath = candidatePaths[0];
|
|
71
|
+
for (const candidatePath of candidatePaths) {
|
|
72
|
+
lastTriedPath = candidatePath;
|
|
73
|
+
try {
|
|
74
|
+
const content = await promises_1.default.readFile(candidatePath, "utf8");
|
|
75
|
+
return {
|
|
76
|
+
packageName,
|
|
77
|
+
filePath: (0, path_1.sanitizePath)(candidatePath) ?? candidatePath,
|
|
78
|
+
content,
|
|
79
|
+
};
|
|
80
|
+
}
|
|
81
|
+
catch (error) {
|
|
82
|
+
if (!isMissingFileError(error)) {
|
|
83
|
+
throw error;
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
return {
|
|
88
|
+
packageName,
|
|
89
|
+
filePath: (0, path_1.sanitizePath)(lastTriedPath) ?? lastTriedPath,
|
|
90
|
+
content: "",
|
|
91
|
+
};
|
|
92
|
+
}
|
|
93
|
+
async function readFirstAvailablePackageDoc(packageName, docPaths) {
|
|
94
|
+
const attemptedPaths = [];
|
|
95
|
+
for (const docPath of docPaths) {
|
|
96
|
+
if (!docPath) {
|
|
97
|
+
continue;
|
|
98
|
+
}
|
|
99
|
+
const doc = await readPackageDoc(packageName, docPath);
|
|
100
|
+
attemptedPaths.push(doc.filePath);
|
|
101
|
+
if (doc.content) {
|
|
102
|
+
return doc;
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
throw new PackageDocNotFoundError(packageName, docPaths, attemptedPaths);
|
|
106
|
+
}
|
|
107
|
+
//# sourceMappingURL=packageDocs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"packageDocs.js","sourceRoot":"","sources":["../../src/docs/packageDocs.ts"],"names":[],"mappings":";;;;;;AA2EA,wCA4CC;AAED,oEAmBC;AA5ID,gEAAkC;AAClC,0DAA6B;AAC7B,wCAA6C;AAEhC,QAAA,kCAAkC,GAAG;IAChD,0BAA0B;CAClB,CAAC;AAEE,QAAA,mCAAmC,GAAG;IACjD,uBAAuB;CACf,CAAC;AAEX,MAAM,oBAAoB,GAAG,qCAAqC,CAAC;AACnE,MAAM,4BAA4B,GAA6B;IAC7D,kBAAkB,EAAE;QAClB,gDAAgD;QAChD,+BAA+B;KAChC;CACF,CAAC;AAEF,MAAa,uBAAwB,SAAQ,KAAK;IAI9B;IAHlB,YACE,WAAmB,EACnB,QAA2B,EACX,cAAwB;QAExC,KAAK,CACH,6BAA6B,WAAW,2BAA2B,QAAQ,CAAC,IAAI,CAC9E,IAAI,CACL,EAAE,CACJ,CAAC;QANc,mBAAc,GAAd,cAAc,CAAU;QAOxC,IAAI,CAAC,IAAI,GAAG,yBAAyB,CAAC;IACxC,CAAC;CACF;AAbD,0DAaC;AAED,SAAS,kBAAkB,CAAC,KAAc;IACxC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,MAAM,IAAI,KAAK;QACd,KAA4B,CAAC,IAAI,KAAK,QAAQ,CAChD,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAe;IACvC,MAAM,UAAU,GAAG,mBAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;IACvE,IACE,CAAC,UAAU;QACX,UAAU,KAAK,GAAG;QAClB,UAAU,CAAC,UAAU,CAAC,KAAK,CAAC;QAC5B,UAAU,KAAK,IAAI;QACnB,mBAAI,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EACjC,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,2BAA2B,CAClC,IAAY,EACZ,WAAmB,EACnB,iBAAyB;IAEzB,MAAM,eAAe,GAAG,4BAA4B,CAAC,WAAW,CAAC,CAAC;IAClE,IAAI,eAAe,EAAE,MAAM,EAAE,CAAC;QAC5B,OAAO,eAAe,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAC5C,mBAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,iBAAiB,CAAC,CACnD,CAAC;IACJ,CAAC;IAED,MAAM,WAAW,GAAG,mBAAI,CAAC,IAAI,CAAC,IAAI,EAAE,cAAc,EAAE,WAAW,CAAC,CAAC;IACjE,OAAO,CAAC,mBAAI,CAAC,IAAI,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC,CAAC;AACrD,CAAC;AAEM,KAAK,UAAU,cAAc,CAClC,WAAmB,EACnB,OAAO,GAAG,WAAW;IAErB,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;QAC5C,OAAO;YACL,WAAW;YACX,QAAQ,EAAE,WAAW;YACrB,OAAO,EAAE,EAAE;SACZ,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;IAC3B,MAAM,iBAAiB,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpD,MAAM,cAAc,GAAG,2BAA2B,CAChD,IAAI,EACJ,WAAW,EACX,iBAAiB,CAClB,CAAC;IAEF,IAAI,aAAa,GAAG,cAAc,CAAC,CAAC,CAAC,CAAC;IAEtC,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;QAC3C,aAAa,GAAG,aAAa,CAAC;QAE9B,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;YACzD,OAAO;gBACL,WAAW;gBACX,QAAQ,EAAE,IAAA,mBAAY,EAAC,aAAa,CAAC,IAAI,aAAa;gBACtD,OAAO;aACR,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/B,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,WAAW;QACX,QAAQ,EAAE,IAAA,mBAAY,EAAC,aAAa,CAAC,IAAI,aAAa;QACtD,OAAO,EAAE,EAAE;KACZ,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,4BAA4B,CAChD,WAAmB,EACnB,QAAkB;IAElB,MAAM,cAAc,GAAa,EAAE,CAAC;IAEpC,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,SAAS;QACX,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,cAAc,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;QACvD,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;YAChB,OAAO,GAAG,CAAC;QACb,CAAC;IACH,CAAC;IAED,MAAM,IAAI,uBAAuB,CAAC,WAAW,EAAE,QAAQ,EAAE,cAAc,CAAC,CAAC;AAC3E,CAAC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export type ExportDocsOptions = {
|
|
2
|
+
output?: string;
|
|
3
|
+
overwrite?: boolean;
|
|
4
|
+
};
|
|
5
|
+
export type ExportDocsResult = {
|
|
6
|
+
outputDir: string;
|
|
7
|
+
entryHtmlPath: string;
|
|
8
|
+
snapshotPath: string;
|
|
9
|
+
};
|
|
10
|
+
export declare function exportDocs(app: unknown, options?: ExportDocsOptions): Promise<ExportDocsResult>;
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
3
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
4
|
+
};
|
|
5
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
+
exports.exportDocs = exportDocs;
|
|
7
|
+
const runner_1 = require("@bluelibs/runner");
|
|
8
|
+
const promises_1 = __importDefault(require("node:fs/promises"));
|
|
9
|
+
const node_path_1 = __importDefault(require("node:path"));
|
|
10
|
+
const printSchema_1 = require("graphql/utilities/printSchema");
|
|
11
|
+
const docsPayload_1 = require("./resources/docsPayload");
|
|
12
|
+
const graphql_accumulator_resource_1 = require("./resources/graphql-accumulator.resource");
|
|
13
|
+
const Introspector_1 = require("./resources/models/Introspector");
|
|
14
|
+
const docsUiAssets_1 = require("./resources/docsUiAssets");
|
|
15
|
+
function resolveOutputDir(output) {
|
|
16
|
+
const resolved = output ?? "./runner-dev-catalog";
|
|
17
|
+
return node_path_1.default.isAbsolute(resolved)
|
|
18
|
+
? resolved
|
|
19
|
+
: node_path_1.default.resolve(process.cwd(), resolved);
|
|
20
|
+
}
|
|
21
|
+
function isDefaultOutputDir(outputDir) {
|
|
22
|
+
return outputDir === resolveOutputDir("./runner-dev-catalog");
|
|
23
|
+
}
|
|
24
|
+
function isDangerousOutputDir(outputDir) {
|
|
25
|
+
const cwd = node_path_1.default.resolve(process.cwd());
|
|
26
|
+
const parentDir = node_path_1.default.resolve(cwd, "..");
|
|
27
|
+
const homeDir = node_path_1.default.resolve(process.env.HOME || "~");
|
|
28
|
+
const rootDir = node_path_1.default.parse(outputDir).root;
|
|
29
|
+
return [cwd, parentDir, homeDir, rootDir].includes(outputDir);
|
|
30
|
+
}
|
|
31
|
+
async function assertOutputDirIsSafe(outputDir, options) {
|
|
32
|
+
if (isDangerousOutputDir(outputDir)) {
|
|
33
|
+
throw new Error(`Refusing to export Runner-Dev docs into '${outputDir}' because that path is too broad. Pick a dedicated directory instead.`);
|
|
34
|
+
}
|
|
35
|
+
let entries = null;
|
|
36
|
+
try {
|
|
37
|
+
entries = await promises_1.default.readdir(outputDir);
|
|
38
|
+
}
|
|
39
|
+
catch {
|
|
40
|
+
return;
|
|
41
|
+
}
|
|
42
|
+
if (entries.length === 0) {
|
|
43
|
+
return;
|
|
44
|
+
}
|
|
45
|
+
const canOverwrite = options.overwrite === true || isDefaultOutputDir(outputDir);
|
|
46
|
+
if (!canOverwrite) {
|
|
47
|
+
throw new Error(`Refusing to overwrite the non-empty export directory '${outputDir}'. Pass { overwrite: true } or choose a dedicated path.`);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
async function exportDocs(app, options = {}) {
|
|
51
|
+
const outputDir = resolveOutputDir(options.output);
|
|
52
|
+
const entryHtmlPath = node_path_1.default.join(outputDir, "index.html");
|
|
53
|
+
const snapshotPath = node_path_1.default.join(outputDir, "snapshot.json");
|
|
54
|
+
const uiAssets = await (0, docsUiAssets_1.resolveDocsBuildAssets)();
|
|
55
|
+
const dryRuntime = await (0, runner_1.run)(app, {
|
|
56
|
+
dryRun: true,
|
|
57
|
+
logs: { printThreshold: null },
|
|
58
|
+
});
|
|
59
|
+
try {
|
|
60
|
+
const store = await dryRuntime.getResourceValue(runner_1.resources.store);
|
|
61
|
+
const runtime = await dryRuntime.getResourceValue(runner_1.resources.runtime);
|
|
62
|
+
const introspector = new Introspector_1.Introspector({ store, runtime });
|
|
63
|
+
const graphqlSdl = (0, printSchema_1.printSchema)((0, graphql_accumulator_resource_1.createRunnerDevGraphqlSchema)());
|
|
64
|
+
const payload = await (0, docsPayload_1.buildDocsPagePayload)({
|
|
65
|
+
store,
|
|
66
|
+
introspector,
|
|
67
|
+
mode: "catalog",
|
|
68
|
+
getGraphqlSdl: () => graphqlSdl,
|
|
69
|
+
});
|
|
70
|
+
if (!payload.graphqlSdl || payload.graphqlSdl.trim().length === 0) {
|
|
71
|
+
throw new Error("Runner-Dev export could not generate graphqlSdl for the snapshot payload.");
|
|
72
|
+
}
|
|
73
|
+
await assertOutputDirIsSafe(outputDir, options);
|
|
74
|
+
await promises_1.default.rm(outputDir, { recursive: true, force: true });
|
|
75
|
+
await promises_1.default.mkdir(node_path_1.default.dirname(outputDir), { recursive: true });
|
|
76
|
+
await promises_1.default.mkdir(outputDir, { recursive: true });
|
|
77
|
+
await promises_1.default.writeFile(snapshotPath, JSON.stringify(payload, null, 2), "utf8");
|
|
78
|
+
await promises_1.default.writeFile(entryHtmlPath, await (0, docsUiAssets_1.renderStandaloneDocsHtml)({
|
|
79
|
+
uiDir: uiAssets.uiDir,
|
|
80
|
+
entry: uiAssets.entry,
|
|
81
|
+
payload,
|
|
82
|
+
}), "utf8");
|
|
83
|
+
return {
|
|
84
|
+
outputDir,
|
|
85
|
+
entryHtmlPath,
|
|
86
|
+
snapshotPath,
|
|
87
|
+
};
|
|
88
|
+
}
|
|
89
|
+
finally {
|
|
90
|
+
try {
|
|
91
|
+
await dryRuntime.dispose();
|
|
92
|
+
}
|
|
93
|
+
catch {
|
|
94
|
+
/* best-effort cleanup */
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
//# sourceMappingURL=exportDocs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"exportDocs.js","sourceRoot":"","sources":["../src/exportDocs.ts"],"names":[],"mappings":";;;;;AA0EA,gCA4DC;AAtID,6CAAqE;AACrE,gEAAkC;AAClC,0DAA6B;AAC7B,+DAA4D;AAC5D,yDAA+D;AAC/D,2FAAwF;AACxF,kEAA+D;AAC/D,2DAGkC;AAalC,SAAS,gBAAgB,CAAC,MAAe;IACvC,MAAM,QAAQ,GAAG,MAAM,IAAI,sBAAsB,CAAC;IAClD,OAAO,mBAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;QAC9B,CAAC,CAAC,QAAQ;QACV,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,CAAC,CAAC;AAC5C,CAAC;AAED,SAAS,kBAAkB,CAAC,SAAiB;IAC3C,OAAO,SAAS,KAAK,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,oBAAoB,CAAC,SAAiB;IAC7C,MAAM,GAAG,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,mBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC1C,MAAM,OAAO,GAAG,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,IAAI,GAAG,CAAC,CAAC;IACtD,MAAM,OAAO,GAAG,mBAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC;IAE3C,OAAO,CAAC,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AAChE,CAAC;AAED,KAAK,UAAU,qBAAqB,CAClC,SAAiB,EACjB,OAA0B;IAE1B,IAAI,oBAAoB,CAAC,SAAS,CAAC,EAAE,CAAC;QACpC,MAAM,IAAI,KAAK,CACb,4CAA4C,SAAS,uEAAuE,CAC7H,CAAC;IACJ,CAAC;IAED,IAAI,OAAO,GAAoB,IAAI,CAAC;IACpC,IAAI,CAAC;QACH,OAAO,GAAG,MAAM,kBAAE,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO;IACT,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IAED,MAAM,YAAY,GAChB,OAAO,CAAC,SAAS,KAAK,IAAI,IAAI,kBAAkB,CAAC,SAAS,CAAC,CAAC;IAE9D,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,IAAI,KAAK,CACb,yDAAyD,SAAS,yDAAyD,CAC5H,CAAC;IACJ,CAAC;AACH,CAAC;AAEM,KAAK,UAAU,UAAU,CAC9B,GAAY,EACZ,UAA6B,EAAE;IAE/B,MAAM,SAAS,GAAG,gBAAgB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnD,MAAM,aAAa,GAAG,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IACzD,MAAM,YAAY,GAAG,mBAAI,CAAC,IAAI,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;IAE3D,MAAM,QAAQ,GAAG,MAAM,IAAA,qCAAsB,GAAE,CAAC;IAChD,MAAM,UAAU,GAAG,MAAM,IAAA,YAAG,EAAC,GAAU,EAAE;QACvC,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE;KAC/B,CAAC,CAAC;IAEH,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,kBAAe,CAAC,KAAK,CAAC,CAAC;QACvE,MAAM,OAAO,GAAG,MAAM,UAAU,CAAC,gBAAgB,CAAC,kBAAe,CAAC,OAAO,CAAC,CAAC;QAC3E,MAAM,YAAY,GAAG,IAAI,2BAAY,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAC1D,MAAM,UAAU,GAAG,IAAA,yBAAW,EAAC,IAAA,2DAA4B,GAAE,CAAC,CAAC;QAE/D,MAAM,OAAO,GAAG,MAAM,IAAA,kCAAoB,EAAC;YACzC,KAAK;YACL,YAAY;YACZ,IAAI,EAAE,SAAS;YACf,aAAa,EAAE,GAAG,EAAE,CAAC,UAAU;SAChC,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAClE,MAAM,IAAI,KAAK,CACb,2EAA2E,CAC5E,CAAC;QACJ,CAAC;QAED,MAAM,qBAAqB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAChD,MAAM,kBAAE,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;QACzD,MAAM,kBAAE,CAAC,KAAK,CAAC,mBAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC7D,MAAM,kBAAE,CAAC,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/C,MAAM,kBAAE,CAAC,SAAS,CAAC,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAC3E,MAAM,kBAAE,CAAC,SAAS,CAChB,aAAa,EACb,MAAM,IAAA,uCAAwB,EAAC;YAC7B,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,OAAO;SACR,CAAC,EACF,MAAM,CACP,CAAC;QAEF,OAAO;YACL,SAAS;YACT,aAAa;YACb,YAAY;SACb,CAAC;IACJ,CAAC;YAAS,CAAC;QACT,IAAI,CAAC;YACH,MAAM,UAAU,CAAC,OAAO,EAAE,CAAC;QAC7B,CAAC;QAAC,MAAM,CAAC;YACP,yBAAyB;QAC3B,CAAC;IACH,CAAC;AACH,CAAC"}
|