@dagger.io/dagger 0.0.1-0

package/dist/src/provisioning/engineconn.d.ts

@@ -0,0 +1,30 @@
+import { GraphQLClient } from "graphql-request";
+import { Writable } from "node:stream";
+export interface ConnectOpts {
+    Workdir?: string;
+    Project?: string;
+    LogOutput?: Writable;
+    Timeout?: number;
+}
+export interface ConnectParams {
+    port: number;
+    session_token: string;
+}
+export interface EngineConn {
+    /**
+     * Library connection provisioning, it returns a ready to use GraphQL client
+     * connected to the Dagger engine.
+     *
+     * This test multiple options to connect to the Dagger Engine.
+     * 1. Check for already running engine through `DAGGER_SESSION_PORT` & `DAGGER_SESSION_TOKEN`
+     * environment variable.
+     * 2. Auto provision the engine from the Dagger CLI (install it if it doesn't exist) and
+     * connect the client.
+     */
+    Connect: (opts: ConnectOpts) => Promise<GraphQLClient>;
+    /**
+     * Close stops the current connection.
+     */
+    Close: () => void;
+}
+//# sourceMappingURL=engineconn.d.ts.map

package/dist/src/provisioning/engineconn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engineconn.d.ts","sourceRoot":"","sources":["../../../src/provisioning/engineconn.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAEtC,MAAM,WAAW,WAAW;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,QAAQ,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,UAAU;IACzB;;;;;;;;;OASG;IACH,OAAO,EAAE,CAAC,IAAI,EAAE,WAAW,KAAK,OAAO,CAAC,aAAa,CAAC,CAAA;IAEtD;;OAEG;IACH,KAAK,EAAE,MAAM,IAAI,CAAA;CAClB"}

package/dist/src/provisioning/engineconn.js

@@ -0,0 +1 @@
+export {};

package/dist/src/provisioning/index.d.ts

@@ -0,0 +1,4 @@
+import { GraphQLClient } from "graphql-request";
+import { ConnectOpts } from "../connectOpts.js";
+export declare function withEngineSession<T>(connectOpts: ConnectOpts, cb: (gqlClient: GraphQLClient) => Promise<T>): Promise<T>;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/provisioning/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/provisioning/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA;AAE/C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAI/C,wBAAsB,iBAAiB,CAAC,CAAC,EACvC,WAAW,EAAE,WAAW,EACxB,EAAE,EAAE,CAAC,SAAS,EAAE,aAAa,KAAK,OAAO,CAAC,CAAC,CAAC,GAC3C,OAAO,CAAC,CAAC,CAAC,CAYZ"}

package/dist/src/provisioning/index.js

@@ -0,0 +1,14 @@
+import { Bin } from "./bin.js";
+import { CLI_VERSION } from "./default.js";
+export async function withEngineSession(connectOpts, cb) {
+    const cliBin = process.env["_EXPERIMENTAL_DAGGER_CLI_BIN"];
+    const engineConn = new Bin(cliBin, CLI_VERSION);
+    const gqlClient = await engineConn.Connect(connectOpts);
+    try {
+        const res = await cb(gqlClient);
+        return res;
+    }
+    finally {
+        await engineConn.Close();
+    }
+}

package/dist/src/telemetry/index.d.ts

@@ -0,0 +1,3 @@
+import { getTracer } from "./telemetry.js";
+export { getTracer };
+//# sourceMappingURL=index.d.ts.map

package/dist/src/telemetry/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/telemetry/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE1C,OAAO,EAAE,SAAS,EAAE,CAAA"}

package/dist/src/telemetry/index.js

@@ -0,0 +1,2 @@
+import { getTracer } from "./telemetry.js";
+export { getTracer };

package/dist/src/telemetry/init.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A wrapper around the OpenTelemetry SDK to configure it for Dagger.
+ */
+export declare class DaggerOtelConfigurator {
+    private is_configured;
+    private sdk?;
+    /**
+     * Initialize the Open Telemetry SDK if enabled or not already configured.
+     */
+    initialize(): void;
+    configure(): void;
+    /**
+     * Shutdown the Open Telemetry SDK to flush traces and metrics and close the connection.
+     */
+    close(): Promise<void>;
+    /**
+     * Setup environment for auto-configuring the SDK.
+     */
+    setupEnv(): void;
+}
+//# sourceMappingURL=init.d.ts.map

package/dist/src/telemetry/init.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../../src/telemetry/init.ts"],"names":[],"mappings":"AAwBA;;GAEG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,aAAa,CAAQ;IAE7B,OAAO,CAAC,GAAG,CAAC,CAAS;IAErB;;OAEG;IACH,UAAU;IAQV,SAAS;IAkCT;;OAEG;IACG,KAAK;IAMX;;OAEG;IACH,QAAQ;CAeT"}

package/dist/src/telemetry/init.js

@@ -0,0 +1,86 @@
+import { getBooleanFromEnv } from "@opentelemetry/core";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-proto";
+import { NodeSDK } from "@opentelemetry/sdk-node";
+import { BatchSpanProcessor, } from "@opentelemetry/sdk-trace-base";
+import { LiveProcessor } from "./live_processor.js";
+const SERVICE_NAME = "dagger-typescript-sdk";
+/*
+ * Look for variables prefixed with OTel to see if OpenTelemetry is configured.
+ */
+function otelConfigured() {
+    return Object.keys(process.env).some((key) => key.startsWith("OTEL_"));
+}
+/**
+ * Batch span processor scheduler delays.
+ * We set to 100ms so it's almost live.
+ */
+const NEARLY_IMMEDIATE = 100;
+/**
+ * A wrapper around the OpenTelemetry SDK to configure it for Dagger.
+ */
+export class DaggerOtelConfigurator {
+    is_configured = false;
+    sdk;
+    /**
+     * Initialize the Open Telemetry SDK if enabled or not already configured.
+     */
+    initialize() {
+        if (this.is_configured) {
+            return;
+        }
+        this.configure();
+        this.is_configured = true;
+    }
+    configure() {
+        if (!otelConfigured()) {
+            return;
+        }
+        if (getBooleanFromEnv("OTEL_SDK_DISABLED") ?? true) {
+            return;
+        }
+        this.setupEnv();
+        const exporter = new OTLPTraceExporter();
+        let processor;
+        if (process.env.OTEL_EXPORTER_OTLP_TRACES_LIVE !== undefined) {
+            processor = new LiveProcessor(exporter, {
+                scheduledDelayMillis: NEARLY_IMMEDIATE,
+            });
+        }
+        else {
+            processor = new BatchSpanProcessor(exporter, {
+                scheduledDelayMillis: NEARLY_IMMEDIATE,
+            });
+        }
+        // Create the node SDK with the context manager, the resource and the exporter.
+        this.sdk = new NodeSDK({
+            serviceName: SERVICE_NAME,
+            spanProcessors: [processor],
+        });
+        // Register the SDK to the OpenTelemetry API
+        this.sdk.start();
+    }
+    /**
+     * Shutdown the Open Telemetry SDK to flush traces and metrics and close the connection.
+     */
+    async close() {
+        if (this.sdk) {
+            await this.sdk.shutdown();
+        }
+    }
+    /**
+     * Setup environment for auto-configuring the SDK.
+     */
+    setupEnv() {
+        // TODO: The insecure flag should be set by the shim instead of the SDK.
+        Object.entries(process.env).forEach(([key, value]) => {
+            if (key.startsWith("OTEL_") &&
+                key.endsWith("_ENDPOINT") &&
+                value?.startsWith("http://")) {
+                const insecure = key.replace(/_ENDPOINT$/, "_INSECURE");
+                if (process.env[insecure] === undefined) {
+                    process.env[insecure] = "true";
+                }
+            }
+        });
+    }
+}

package/dist/src/telemetry/live_processor.d.ts

@@ -0,0 +1,12 @@
+import type { Context } from "@opentelemetry/api";
+import { BatchSpanProcessor, type Span } from "@opentelemetry/sdk-trace-base";
+/**
+ * Live span processor implementation.
+ *
+ * It's a BatchSpanProcessor whose on_start calls on_end on the underlying
+ * SpanProcessor in order to send live telemetry.
+ */
+export declare class LiveProcessor extends BatchSpanProcessor {
+    onStart(_span: Span, _parentContext: Context): void;
+}
+//# sourceMappingURL=live_processor.d.ts.map

package/dist/src/telemetry/live_processor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"live_processor.d.ts","sourceRoot":"","sources":["../../../src/telemetry/live_processor.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AACjD,OAAO,EAAE,kBAAkB,EAAE,KAAK,IAAI,EAAE,MAAM,+BAA+B,CAAA;AAE7E;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,kBAAkB;IAE1C,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,cAAc,EAAE,OAAO,GAAG,IAAI;CAG7D"}

package/dist/src/telemetry/live_processor.js

@@ -0,0 +1,13 @@
+import { BatchSpanProcessor } from "@opentelemetry/sdk-trace-base";
+/**
+ * Live span processor implementation.
+ *
+ * It's a BatchSpanProcessor whose on_start calls on_end on the underlying
+ * SpanProcessor in order to send live telemetry.
+ */
+export class LiveProcessor extends BatchSpanProcessor {
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    onStart(_span, _parentContext) {
+        this.onEnd(_span);
+    }
+}

package/dist/src/telemetry/telemetry.d.ts

@@ -0,0 +1,16 @@
+import * as opentelemetry from "@opentelemetry/api";
+import { Tracer } from "./tracer.js";
+export declare function initialize(): void;
+export declare function close(): Promise<void>;
+/**
+ * Return a tracer to use with Dagger.
+ *
+ * The tracer is automatically initialized if not already done.
+ * As a conveniance function, you can use `withTracingSpan` that automatically close
+ * the span at the end of the function.
+ *
+ * You can add a custom name to the tracer based on your application.
+ */
+export declare function getTracer(name?: string): Tracer;
+export declare function getContext(): opentelemetry.Context;
+//# sourceMappingURL=telemetry.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"telemetry.d.ts","sourceRoot":"","sources":["../../../src/telemetry/telemetry.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAGnD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAMpC,wBAAgB,UAAU,SAEzB;AAED,wBAAsB,KAAK,kBAE1B;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,IAAI,SAAqB,GAAG,MAAM,CAG3D;AAED,wBAAgB,UAAU,0BAgBzB"}

package/dist/src/telemetry/telemetry.js

@@ -0,0 +1,38 @@
+import * as opentelemetry from "@opentelemetry/api";
+import { DaggerOtelConfigurator } from "./init.js";
+import { Tracer } from "./tracer.js";
+const DAGGER_TRACER_NAME = "dagger.io/sdk.typescript";
+const configurator = new DaggerOtelConfigurator();
+export function initialize() {
+    configurator.initialize();
+}
+export async function close() {
+    await configurator.close();
+}
+/**
+ * Return a tracer to use with Dagger.
+ *
+ * The tracer is automatically initialized if not already done.
+ * As a conveniance function, you can use `withTracingSpan` that automatically close
+ * the span at the end of the function.
+ *
+ * You can add a custom name to the tracer based on your application.
+ */
+export function getTracer(name = DAGGER_TRACER_NAME) {
+    initialize();
+    return new Tracer(name);
+}
+export function getContext() {
+    const ctx = opentelemetry.context.active();
+    const spanCtx = opentelemetry.trace.getSpanContext(ctx);
+    if (spanCtx && opentelemetry.trace.isSpanContextValid(spanCtx)) {
+        return ctx;
+    }
+    const parentID = process.env.TRACEPARENT;
+    if (parentID) {
+        return opentelemetry.propagation.extract(ctx, {
+            traceparent: parentID,
+        });
+    }
+    return ctx;
+}

package/dist/src/telemetry/tracer.d.ts

@@ -0,0 +1,32 @@
+import * as opentelemetry from "@opentelemetry/api";
+/**
+ * Tracer encapsulates the OpenTelemetry Tracer.
+ */
+export declare class Tracer {
+    private tracer;
+    constructor(name: string);
+    startSpan(name: string, attributes?: opentelemetry.Attributes): opentelemetry.Span;
+    /**
+     * Execute the functions with a custom span with the given name using startActiveSpan.
+     * The function executed will use the parent context of the function (it can be another span
+     * or the main function).
+     *
+     * @param name The name of the span
+     * @param fn The functions to execute
+     *
+     * startActiveSpan returns the result of the executed functions.
+     *
+     * The span is automatically ended when the function is done.
+     * The span is automatically marked as an error if the function throws an error.
+     *
+     *
+     * @example
+     * ```
+     * return getTracer().startActiveSpan(name, async () => {
+     *   return this.containerEcho("test").stdout()
+     * })
+     * ```
+     */
+    startActiveSpan<T>(name: string, fn: (span: opentelemetry.Span) => Promise<T>, attributes?: opentelemetry.Attributes): Promise<T>;
+}
+//# sourceMappingURL=tracer.d.ts.map

package/dist/src/telemetry/tracer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tracer.d.ts","sourceRoot":"","sources":["../../../src/telemetry/tracer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,oBAAoB,CAAA;AAEnD;;GAEG;AACH,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAsB;gBAExB,IAAI,EAAE,MAAM;IAIjB,SAAS,CACd,IAAI,EAAE,MAAM,EACZ,UAAU,CAAC,EAAE,aAAa,CAAC,UAAU,GACpC,aAAa,CAAC,IAAI;IAIrB;;;;;;;;;;;;;;;;;;;;OAoBG;IACU,eAAe,CAAC,CAAC,EAC5B,IAAI,EAAE,MAAM,EACZ,EAAE,EAAE,CAAC,IAAI,EAAE,aAAa,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,EAC5C,UAAU,CAAC,EAAE,aAAa,CAAC,UAAU;CAoBxC"}

package/dist/src/telemetry/tracer.js

@@ -0,0 +1,54 @@
+import * as opentelemetry from "@opentelemetry/api";
+/**
+ * Tracer encapsulates the OpenTelemetry Tracer.
+ */
+export class Tracer {
+    tracer;
+    constructor(name) {
+        this.tracer = opentelemetry.trace.getTracer(name);
+    }
+    startSpan(name, attributes) {
+        return this.tracer.startSpan(name, { attributes });
+    }
+    /**
+     * Execute the functions with a custom span with the given name using startActiveSpan.
+     * The function executed will use the parent context of the function (it can be another span
+     * or the main function).
+     *
+     * @param name The name of the span
+     * @param fn The functions to execute
+     *
+     * startActiveSpan returns the result of the executed functions.
+     *
+     * The span is automatically ended when the function is done.
+     * The span is automatically marked as an error if the function throws an error.
+     *
+     *
+     * @example
+     * ```
+     * return getTracer().startActiveSpan(name, async () => {
+     *   return this.containerEcho("test").stdout()
+     * })
+     * ```
+     */
+    async startActiveSpan(name, fn, attributes) {
+        return this.tracer.startActiveSpan(name, { attributes }, async (span) => {
+            try {
+                return await fn(span);
+            }
+            catch (e) {
+                if (e instanceof Error) {
+                    span.recordException(e);
+                    span.setStatus({
+                        code: opentelemetry.SpanStatusCode.ERROR,
+                        message: e.message,
+                    });
+                }
+                throw e;
+            }
+            finally {
+                span.end();
+            }
+        });
+    }
+}

package/package.json

@@ -0,0 +1,74 @@
+{
+  "name": "@dagger.io/dagger",
+  "version": "0.0.1-0",
+  "author": "hello@dagger.io",
+  "license": "Apache-2.0",
+  "types": "./dist/src/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist/"
+  ],
+  "exports": {
+    ".": "./dist/src/index.js",
+    "./telemetry": "./dist/src/telemetry/index.js"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "main": "dist/src/index.js",
+  "dependencies": {
+    "@grpc/grpc-js": "^1.14.3",
+    "@lifeomic/axios-fetch": "^3.1.0",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/core": "^2.2.0",
+    "@opentelemetry/exporter-jaeger": "^2.2.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.208.0",
+    "@opentelemetry/sdk-metrics": "^2.2.0",
+    "@opentelemetry/sdk-node": "^0.208.0",
+    "@opentelemetry/semantic-conventions": "^1.38.0",
+    "adm-zip": "^0.5.16",
+    "env-paths": "^3.0.0",
+    "execa": "^9.6.1",
+    "graphql": "^16.12.0",
+    "graphql-request": "^7.4.0",
+    "graphql-tag": "^2.12.6",
+    "node-color-log": "^13.0.3",
+    "node-fetch": "^3.3.2",
+    "reflect-metadata": "^0.2.2",
+    "tar": "^7.5.2",
+    "typescript": "^5.9.3"
+  },
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w",
+    "test": "yarn run test:node",
+    "test:bun": "bun run --bun mocha",
+    "test:node": "mocha",
+    "test:generate-scan": "tsx ./introspector/test/testdata/generate_expected_scan.ts",
+    "lint": "yarn eslint --max-warnings=0 .",
+    "fmt": "yarn eslint --max-warnings=0 --fix .",
+    "docs:lint": "cd ../../docs/current_docs && eslint -c ../../sdk/typescript/eslint-docs.config.js --max-warnings=0 ./**/*.ts",
+    "docs:fmt": "cd ../../docs/current_docs && eslint --fix -c ../../sdk/typescript/eslint-docs.config.js --max-warnings=0 ./**/*.ts"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.0",
+    "@otel-test-runner/mocha-test": "0.3.1",
+    "@trivago/prettier-plugin-sort-imports": "^6.0.1",
+    "@types/adm-zip": "^0.5.7",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "~25.0.3",
+    "@types/tar": "^6.1.13",
+    "@typescript-eslint/eslint-plugin": "^8.51.0",
+    "@typescript-eslint/parser": "^8.51.0",
+    "eslint": "^9.39.2",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-prettier": "^5.5.4",
+    "mocha": "^11.7.5",
+    "prettier": "^3.7.4",
+    "rollup": "^4.54.0",
+    "rollup-plugin-dts": "^6.3.0",
+    "ts-node": "^10.9.2",
+    "tsx": "^4.21.0",
+    "typescript-eslint": "^8.51.0"
+  }
+}