@crossplane-org/function-sdk-typescript 0.1.0

package/dist/response/response.js

@@ -0,0 +1,339 @@
+/**
+ * Response utilities for working with RunFunctionResponse
+ *
+ * This module provides helper functions to build and manipulate RunFunctionResponse objects,
+ * including setting desired state, managing results, handling context, and working with
+ * composite resources and their status.
+ */
+import { Resource, RunFunctionRequest, RunFunctionResponse, Severity, Ready, } from "../proto/run_function.js";
+import { Duration } from "../proto/google/protobuf/duration.js";
+import { merge } from "ts-deepmerge";
+/**
+ * Default time-to-live for function responses (60 seconds).
+ * Crossplane will call the function again when the TTL expires.
+ */
+const DEFAULT_TTL = { seconds: 60, nanos: 0 };
+export { DEFAULT_TTL };
+/**
+ * Bootstrap a response from a request.
+ *
+ * This function creates a new RunFunctionResponse with the request's tag automatically
+ * copied, and initializes the desired state from the request. Using this function is
+ * the recommended pattern to ensure proper response initialization.
+ *
+ * The response will:
+ * - Copy the request's tag to the response metadata
+ * - Initialize the desired state from the request (or create empty if not present)
+ * - Set the TTL (time-to-live) for caching
+ * - Initialize empty results and conditions arrays
+ *
+ * @param req - The RunFunctionRequest to bootstrap from
+ * @param ttl - Optional time-to-live duration (defaults to 60 seconds)
+ * @returns A new RunFunctionResponse initialized from the request
+ *
+ * @example
+ * ```typescript
+ * async RunFunction(req: RunFunctionRequest): Promise<RunFunctionResponse> {
+ *   let rsp = to(req);
+ *   // Add your logic here
+ *   normal(rsp, "Processing complete");
+ *   return rsp;
+ * }
+ * ```
+ */
+export function to(req, ttl) {
+    // Initialize desired state if needed
+    let desired = req.desired;
+    // If desired is not set, initialize it
+    if (!desired) {
+        desired = { composite: undefined, resources: {} };
+    }
+    // If composite is explicitly null, initialize it as an empty resource
+    if (desired.composite === null) {
+        desired.composite = Resource.fromJSON({});
+    }
+    return {
+        conditions: [],
+        context: req.context,
+        desired: desired,
+        meta: { tag: req.meta?.tag || "", ttl: ttl || DEFAULT_TTL },
+        requirements: undefined,
+        results: [],
+    };
+}
+/**
+ * Update a map of desired composed resources by adding or updating a named resource.
+ *
+ * This is a helper function to add a single resource to a map of composed resources.
+ * It's useful when building up desired resources before calling setDesiredComposedResources.
+ *
+ * @param cds - The current map of composed resources
+ * @param res - The named resource to add or update
+ * @returns The updated map of composed resources
+ *
+ * @example
+ * ```typescript
+ * let dcds = getDesiredComposedResources(req);
+ * dcds = updateDesiredComposedResources(dcds, {
+ *   name: "my-bucket",
+ *   resource: Resource.fromJSON({ resource: bucketConfig })
+ * });
+ * rsp = setDesiredComposedResources(rsp, dcds);
+ * ```
+ */
+export function updateDesiredComposedResources(cds, res) {
+    cds[res.name] = res.resource;
+    return cds;
+}
+/**
+ * Add a fatal result to the response.
+ *
+ * Fatal results cause the function pipeline run to be considered a failure.
+ * Subsequent functions may still run, but the first fatal result will be
+ * returned as an error. Fatal results should be used for errors that prevent
+ * the function from producing valid output.
+ *
+ * @param rsp - The RunFunctionResponse to add the result to
+ * @param message - The error message describing the fatal condition
+ * @returns The updated response
+ *
+ * @example
+ * ```typescript
+ * if (!requiredInput) {
+ *   fatal(rsp, "Required input 'databaseSize' not provided");
+ *   return rsp;
+ * }
+ * ```
+ */
+export function fatal(rsp, message) {
+    if (rsp && rsp.results) {
+        rsp.results.push({
+            severity: Severity.SEVERITY_FATAL,
+            message: message,
+        });
+    }
+    return rsp;
+}
+/**
+ * Add a normal result to the response.
+ *
+ * Normal results are informational and emitted as normal events and debug logs
+ * associated with the composite resource (XR) or operation. They indicate
+ * successful processing or expected conditions.
+ *
+ * @param rsp - The RunFunctionResponse to add the result to
+ * @param message - The informational message
+ *
+ * @example
+ * ```typescript
+ * normal(rsp, "Successfully configured 3 database replicas");
+ * ```
+ */
+export function normal(rsp, message) {
+    if (rsp && rsp.results) {
+        rsp.results.push({
+            severity: Severity.SEVERITY_NORMAL,
+            message: message,
+        });
+    }
+}
+/**
+ * Add a warning result to the response.
+ *
+ * Warning results are non-fatal issues that should be brought to attention.
+ * The entire pipeline will run to completion, but warning events and debug logs
+ * will be emitted. Use warnings for recoverable issues or deprecated usage.
+ *
+ * @param rsp - The RunFunctionResponse to add the result to
+ * @param message - The warning message
+ *
+ * @example
+ * ```typescript
+ * if (input.legacyFormat) {
+ *   warning(rsp, "Using deprecated input format, please migrate to new format");
+ * }
+ * ```
+ */
+export function warning(rsp, message) {
+    if (rsp && rsp.results) {
+        rsp.results.push({
+            severity: Severity.SEVERITY_WARNING,
+            message: message,
+        });
+    }
+}
+/**
+ * Set the desired composed resources in the response.
+ *
+ * This function sets or merges the desired composed resources in the response.
+ * It uses deep merge to combine new resources with any existing resources,
+ * allowing functions to add or modify resources while preserving those set
+ * by previous functions in the pipeline.
+ *
+ * If the desired state or resources map don't exist, they will be initialized.
+ *
+ * @param rsp - The RunFunctionResponse to update
+ * @param dcds - A map of resource names to Resource objects to set as desired
+ * @returns The updated response
+ *
+ * @example
+ * ```typescript
+ * const dcds = getDesiredComposedResources(req);
+ * dcds["my-deployment"] = Resource.fromJSON({
+ *   resource: { apiVersion: "apps/v1", kind: "Deployment", ... }
+ * });
+ * rsp = setDesiredComposedResources(rsp, dcds);
+ * ```
+ */
+export function setDesiredComposedResources(rsp, dcds) {
+    // Ensure desired state exists
+    if (!rsp.desired) {
+        rsp.desired = { composite: undefined, resources: {} };
+    }
+    // Merge the new resources with existing ones
+    rsp.desired.resources = merge(rsp.desired.resources || {}, dcds);
+    return rsp;
+}
+/**
+ * Update a resource by merging source into target.
+ *
+ * This function performs a deep merge of the source resource into the target resource,
+ * allowing you to update specific fields while preserving others. The merge is performed
+ * using the ts-deepmerge library.
+ *
+ * @param src - The source Resource containing updates
+ * @param tgt - The target Resource to be updated
+ * @returns A new Resource with merged values
+ *
+ * @example
+ * ```typescript
+ * const existing = getDesiredComposedResources(req)["my-resource"];
+ * const updated = update(
+ *   Resource.fromJSON({ resource: { spec: { replicas: 5 } } }),
+ *   existing
+ * );
+ * ```
+ */
+export function update(src, tgt) {
+    return merge(tgt, src);
+}
+/**
+ * Set the desired composite resource status.
+ *
+ * This function updates only the status field of the desired composite resource.
+ * It merges the provided status with any existing status, allowing partial updates.
+ * Note that functions should only set the status of composite resources (XRs),
+ * not their metadata or spec.
+ *
+ * @param params - Object containing the response and status to set
+ * @param params.rsp - The RunFunctionResponse to update
+ * @param params.status - The status object to merge into the composite resource
+ * @returns The updated response
+ *
+ * @example
+ * ```typescript
+ * rsp = setDesiredCompositeStatus({
+ *   rsp,
+ *   status: {
+ *     phase: "Ready",
+ *     conditions: [{ type: "Synced", status: "True" }]
+ *   }
+ * });
+ * ```
+ */
+export function setDesiredCompositeStatus({ rsp, status }) {
+    if (rsp.desired?.composite?.resource) {
+        rsp.desired.composite.resource = merge(rsp.desired.composite.resource, {
+            "status": status,
+        });
+    }
+    return rsp;
+}
+/**
+ * Set a context key in the response.
+ *
+ * Context allows functions to pass arbitrary data to subsequent functions in the
+ * pipeline. The context is initialized if it doesn't exist. Crossplane discards
+ * all context returned by the last function in the pipeline.
+ *
+ * @param rsp - The RunFunctionResponse to update
+ * @param key - The context key to set
+ * @param value - The value to associate with the key (can be any JSON-serializable value)
+ * @returns The updated response
+ *
+ * @example
+ * ```typescript
+ * // Set context for next function in pipeline
+ * rsp = setContextKey(rsp, "database-endpoint", "db.example.com:5432");
+ * rsp = setContextKey(rsp, "connection-config", { host: "db.example.com", port: 5432 });
+ * ```
+ */
+export function setContextKey(rsp, key, value) {
+    if (!rsp.context) {
+        rsp.context = {};
+    }
+    rsp.context[key] = value;
+    return rsp;
+}
+/**
+ * Set the desired composite resource in the response.
+ *
+ * This function sets the entire desired composite resource and optionally its ready status.
+ * The ready status can be used to override Crossplane's standard readiness detection,
+ * which normally determines the composite's ready state based on composed resources.
+ *
+ * Note: Ready status is only used for composition functions, not operations.
+ *
+ * @param rsp - The RunFunctionResponse to update
+ * @param resource - The desired composite resource to set
+ * @param ready - Optional ready status (READY_TRUE, READY_FALSE, or READY_UNSPECIFIED)
+ * @returns The updated response
+ *
+ * @example
+ * ```typescript
+ * const composite = getObservedCompositeResource(req);
+ * if (composite) {
+ *   // Modify and set as desired with ready status
+ *   rsp = setDesiredCompositeResource(rsp, composite, Ready.READY_TRUE);
+ * }
+ * ```
+ */
+export function setDesiredCompositeResource(rsp, resource, ready) {
+    if (!rsp.desired) {
+        rsp.desired = { composite: undefined, resources: {} };
+    }
+    // Create a new resource with the specified ready status using fromPartial
+    // to ensure proper type handling for the protobuf-generated Resource type
+    rsp.desired.composite = Resource.fromPartial({
+        resource: resource.resource,
+        connectionDetails: resource.connectionDetails,
+        ready: ready !== undefined ? ready : Ready.READY_UNSPECIFIED,
+    });
+    return rsp;
+}
+/**
+ * Set the function output in the response.
+ *
+ * Function output is specific to operation functions. The output must be a
+ * JSON-serializable object. Composite resources (XRs) will discard any function
+ * output, as it's only used by operations.
+ *
+ * @param rsp - The RunFunctionResponse to update
+ * @param output - The output object to set (must be JSON-serializable)
+ * @returns The updated response
+ *
+ * @example
+ * ```typescript
+ * // For operation functions
+ * rsp = setOutput(rsp, {
+ *   resourcesCreated: 5,
+ *   status: "success",
+ *   details: { timestamp: new Date().toISOString() }
+ * });
+ * ```
+ */
+export function setOutput(rsp, output) {
+    rsp.output = output;
+    return rsp;
+}
+//# sourceMappingURL=response.js.map

package/dist/response/response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../../src/response/response.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EACL,QAAQ,EACR,kBAAkB,EAClB,mBAAmB,EACnB,QAAQ,EACR,KAAK,GACN,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,QAAQ,EAAE,MAAM,sCAAsC,CAAC;AAChE,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAErC;;;GAGG;AACH,MAAM,WAAW,GAAa,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;AAExD,OAAO,EAAE,WAAW,EAAE,CAAC;AAEvB;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,UAAU,EAAE,CAAC,GAAuB,EAAE,GAAc;IACxD,qCAAqC;IACrC,IAAI,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC;IAE1B,uCAAuC;IACvC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IACpD,CAAC;IAED,sEAAsE;IACtE,IAAI,OAAO,CAAC,SAAS,KAAK,IAAI,EAAE,CAAC;QAC/B,OAAO,CAAC,SAAS,GAAG,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC5C,CAAC;IAED,OAAO;QACL,UAAU,EAAE,EAAE;QACd,OAAO,EAAE,GAAG,CAAC,OAAO;QACpB,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,IAAI,WAAW,EAAE;QAC3D,YAAY,EAAE,SAAS;QACvB,OAAO,EAAE,EAAE;KACZ,CAAC;AACJ,CAAC;AAOD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,8BAA8B,CAC5C,GAAgC,EAChC,GAAkB;IAElB,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC;IAC7B,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,KAAK,CACnB,GAAwB,EACxB,OAAe;IAEf,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QACvB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,QAAQ,EAAE,QAAQ,CAAC,cAAc;YACjC,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,MAAM,CAAC,GAAwB,EAAE,OAAe;IAC9D,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QACvB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,QAAQ,EAAE,QAAQ,CAAC,eAAe;YAClC,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,OAAO,CAAC,GAAwB,EAAE,OAAe;IAC/D,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC;QACvB,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;YACf,QAAQ,EAAE,QAAQ,CAAC,gBAAgB;YACnC,OAAO,EAAE,OAAO;SACjB,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,2BAA2B,CACzC,GAAwB,EACxB,IAAiC;IAEjC,8BAA8B;IAC9B,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACjB,GAAG,CAAC,OAAO,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IACxD,CAAC;IAED,6CAA6C;IAC7C,GAAG,CAAC,OAAO,CAAC,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,IAAI,EAAE,EAAE,IAAI,CAE9D,CAAC;IAEF,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,MAAM,CAAC,GAAa,EAAE,GAAa;IACjD,OAAO,KAAK,CAAC,GAAG,EAAE,GAAG,CAAa,CAAC;AACrC,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,UAAU,yBAAyB,CACzC,EAAE,GAAG,EAAE,MAAM,EAAkE;IAE7E,IAAI,GAAG,CAAC,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;QACrC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,QAAQ,EAAE;YACrE,QAAQ,EAAE,MAAM;SACjB,CAA2B,CAAC;IAC/B,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,aAAa,CAAC,GAAwB,EAAE,GAAW,EAAE,KAAU;IAC7E,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACjB,GAAG,CAAC,OAAO,GAAG,EAAE,CAAC;IACnB,CAAC;IACD,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,MAAM,UAAU,2BAA2B,CACzC,GAAwB,EACxB,QAAkB,EAClB,KAAa;IAEb,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACjB,GAAG,CAAC,OAAO,GAAG,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IACxD,CAAC;IAED,0EAA0E;IAC1E,0EAA0E;IAC1E,GAAG,CAAC,OAAO,CAAC,SAAS,GAAG,QAAQ,CAAC,WAAW,CAAC;QAC3C,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB;QAC7C,KAAK,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,iBAAiB;KAC7D,CAAC,CAAC;IAEH,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,UAAU,SAAS,CAAC,GAAwB,EAAE,MAA8B;IAChF,GAAG,CAAC,MAAM,GAAG,MAAM,CAAC;IACpB,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/runtime/runtime.d.ts

@@ -0,0 +1,121 @@
+/**
+ * Runtime utilities for creating and managing gRPC servers
+ *
+ * This module provides functions to create gRPC servers for Crossplane functions,
+ * handle TLS credentials, and manage server lifecycle. It simplifies the process
+ * of setting up a production-ready function server with proper security.
+ */
+import * as grpc from "@grpc/grpc-js";
+import type { Logger } from "pino";
+import { FunctionRunner } from "../function/function.js";
+/**
+ * Configuration options for the gRPC server.
+ */
+export interface ServerOptions {
+    /**
+     * The address to listen on (e.g., "0.0.0.0:9443" or ":9443")
+     * Default is ":9443" when using the CLI
+     */
+    address: string;
+    /**
+     * Whether to run without TLS encryption.
+     * Set to true for local development only. Production should use TLS.
+     * Default: false
+     */
+    insecure?: boolean;
+    /**
+     * Enable debug-level logging.
+     * Default: false
+     */
+    debug?: boolean;
+    /**
+     * Filesystem directory containing TLS certificates.
+     * Should contain: tls.key, tls.crt, and ca.crt
+     * Ignored if insecure is set to true.
+     */
+    tlsServerCertsDir?: string;
+}
+/**
+ * Create gRPC ServerCredentials from TLS certificate files.
+ *
+ * This function loads TLS certificates from the filesystem and creates
+ * appropriate ServerCredentials for the gRPC server. In insecure mode,
+ * it returns insecure credentials (suitable for local development only).
+ *
+ * For secure mode, it expects three files in tlsServerCertsDir:
+ * - tls.key: The server's private key
+ * - tls.crt: The server's certificate
+ * - ca.crt: The certificate authority certificate
+ *
+ * @param opts - Server options containing TLS configuration
+ * @returns gRPC ServerCredentials (secure or insecure based on options)
+ * @throws Error if certificate files cannot be read in secure mode
+ *
+ * @example
+ * ```typescript
+ * // Secure mode (production)
+ * const creds = getServerCredentials({
+ *   address: ":9443",
+ *   tlsServerCertsDir: "/tls"
+ * });
+ *
+ * // Insecure mode (development only)
+ * const creds = getServerCredentials({
+ *   address: ":9443",
+ *   insecure: true
+ * });
+ * ```
+ */
+export declare function getServerCredentials(opts?: ServerOptions): grpc.ServerCredentials;
+/**
+ * Create a new gRPC server with the function runner registered.
+ *
+ * This function creates a gRPC server instance and registers the provided
+ * FunctionRunner to handle incoming RunFunction requests. The server is
+ * created but not yet bound to an address - use startServer to bind and start it.
+ *
+ * @param functionRunner - The FunctionRunner instance that will handle requests
+ * @param logger - Logger instance for debug and error logging
+ * @returns A configured gRPC Server instance ready to be started
+ *
+ * @example
+ * ```typescript
+ * const runner = new FunctionRunner(new MyFunction(), logger);
+ * const server = newGrpcServer(runner, logger);
+ * startServer(server, { address: ":9443", insecure: false }, logger);
+ * ```
+ */
+export declare function newGrpcServer(functionRunner: FunctionRunner, logger: Logger): grpc.Server;
+/**
+ * Bind and start a gRPC server.
+ *
+ * This function binds the server to the specified address and starts listening
+ * for incoming connections. It handles both secure (TLS) and insecure modes
+ * based on the provided options. The binding happens asynchronously.
+ *
+ * The server will log when it successfully starts listening or if an error occurs
+ * during binding.
+ *
+ * @param server - The gRPC Server instance to start
+ * @param opts - Server options including address and TLS configuration
+ * @param logger - Logger instance for info and error logging
+ * @returns The same server instance (now bound and listening)
+ *
+ * @example
+ * ```typescript
+ * const server = newGrpcServer(runner, logger);
+ * startServer(server, {
+ *   address: "0.0.0.0:9443",
+ *   tlsServerCertsDir: "/tls",
+ *   debug: true
+ * }, logger);
+ *
+ * // For local development
+ * startServer(server, {
+ *   address: "localhost:9443",
+ *   insecure: true
+ * }, logger);
+ * ```
+ */
+export declare function startServer(server: grpc.Server, opts: ServerOptions, logger: Logger): grpc.Server;
+//# sourceMappingURL=runtime.d.ts.map

package/dist/runtime/runtime.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.d.ts","sourceRoot":"","sources":["../../src/runtime/runtime.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AACtC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAGnC,OAAO,EAAE,cAAc,EAAa,MAAM,yBAAyB,CAAC;AAEpE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,oBAAoB,CAChC,IAAI,CAAC,EAAE,aAAa,GACrB,IAAI,CAAC,iBAAiB,CAkBxB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,aAAa,CAAC,cAAc,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAMzF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC,MAAM,CAgBjG"}

package/dist/runtime/runtime.js

@@ -0,0 +1,124 @@
+/**
+ * Runtime utilities for creating and managing gRPC servers
+ *
+ * This module provides functions to create gRPC servers for Crossplane functions,
+ * handle TLS credentials, and manage server lifecycle. It simplifies the process
+ * of setting up a production-ready function server with proper security.
+ */
+import * as grpc from "@grpc/grpc-js";
+import { readFileSync } from "node:fs";
+import { join } from "node:path";
+import { FunctionRunner, getServer } from "../function/function.js";
+/**
+ * Create gRPC ServerCredentials from TLS certificate files.
+ *
+ * This function loads TLS certificates from the filesystem and creates
+ * appropriate ServerCredentials for the gRPC server. In insecure mode,
+ * it returns insecure credentials (suitable for local development only).
+ *
+ * For secure mode, it expects three files in tlsServerCertsDir:
+ * - tls.key: The server's private key
+ * - tls.crt: The server's certificate
+ * - ca.crt: The certificate authority certificate
+ *
+ * @param opts - Server options containing TLS configuration
+ * @returns gRPC ServerCredentials (secure or insecure based on options)
+ * @throws Error if certificate files cannot be read in secure mode
+ *
+ * @example
+ * ```typescript
+ * // Secure mode (production)
+ * const creds = getServerCredentials({
+ *   address: ":9443",
+ *   tlsServerCertsDir: "/tls"
+ * });
+ *
+ * // Insecure mode (development only)
+ * const creds = getServerCredentials({
+ *   address: ":9443",
+ *   insecure: true
+ * });
+ * ```
+ */
+export function getServerCredentials(opts) {
+    if (opts?.insecure || opts?.tlsServerCertsDir === "" || opts?.tlsServerCertsDir === undefined) {
+        return grpc.ServerCredentials.createInsecure();
+    }
+    const tlsCertsDir = opts.tlsServerCertsDir;
+    if (typeof tlsCertsDir !== "string" || tlsCertsDir.trim() === "") {
+        throw new Error("tlsServerCertsDir must be a non-empty string when TLS is enabled");
+    }
+    const privateKey = readFileSync(join(tlsCertsDir, "tls.key"));
+    const certChain = readFileSync(join(tlsCertsDir, "tls.crt"));
+    const rootCerts = readFileSync(join(tlsCertsDir, "ca.crt"));
+    return grpc.ServerCredentials.createSsl(rootCerts, [{ private_key: privateKey, cert_chain: certChain }], false);
+}
+/**
+ * Create a new gRPC server with the function runner registered.
+ *
+ * This function creates a gRPC server instance and registers the provided
+ * FunctionRunner to handle incoming RunFunction requests. The server is
+ * created but not yet bound to an address - use startServer to bind and start it.
+ *
+ * @param functionRunner - The FunctionRunner instance that will handle requests
+ * @param logger - Logger instance for debug and error logging
+ * @returns A configured gRPC Server instance ready to be started
+ *
+ * @example
+ * ```typescript
+ * const runner = new FunctionRunner(new MyFunction(), logger);
+ * const server = newGrpcServer(runner, logger);
+ * startServer(server, { address: ":9443", insecure: false }, logger);
+ * ```
+ */
+export function newGrpcServer(functionRunner, logger) {
+    const server = getServer(functionRunner, logger);
+    if (logger) {
+        logger.debug("grpc server created");
+    }
+    return server;
+}
+/**
+ * Bind and start a gRPC server.
+ *
+ * This function binds the server to the specified address and starts listening
+ * for incoming connections. It handles both secure (TLS) and insecure modes
+ * based on the provided options. The binding happens asynchronously.
+ *
+ * The server will log when it successfully starts listening or if an error occurs
+ * during binding.
+ *
+ * @param server - The gRPC Server instance to start
+ * @param opts - Server options including address and TLS configuration
+ * @param logger - Logger instance for info and error logging
+ * @returns The same server instance (now bound and listening)
+ *
+ * @example
+ * ```typescript
+ * const server = newGrpcServer(runner, logger);
+ * startServer(server, {
+ *   address: "0.0.0.0:9443",
+ *   tlsServerCertsDir: "/tls",
+ *   debug: true
+ * }, logger);
+ *
+ * // For local development
+ * startServer(server, {
+ *   address: "localhost:9443",
+ *   insecure: true
+ * }, logger);
+ * ```
+ */
+export function startServer(server, opts, logger) {
+    const creds = getServerCredentials(opts);
+    logger.debug(`serverCredentials type: ${creds.constructor.name}`);
+    server.bindAsync(opts.address, creds, (err) => {
+        if (err) {
+            logger.error(`server bind error: ${err.message}`);
+            return;
+        }
+        logger.info(`server started and listening on ${opts.address}`);
+    });
+    return server;
+}
+//# sourceMappingURL=runtime.js.map

package/dist/runtime/runtime.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"runtime.js","sourceRoot":"","sources":["../../src/runtime/runtime.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,IAAI,MAAM,eAAe,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAiCpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,oBAAoB,CAChC,IAAoB;IAEpB,IAAI,IAAI,EAAE,QAAQ,IAAI,IAAI,EAAE,iBAAiB,KAAK,EAAE,IAAI,IAAI,EAAE,iBAAiB,KAAK,SAAS,EAAE,CAAC;QAC5F,OAAO,IAAI,CAAC,iBAAiB,CAAC,cAAc,EAAE,CAAC;IACnD,CAAC;IAED,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC;IAC3C,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,WAAW,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QAC/D,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;IACxF,CAAC;IAED,MAAM,UAAU,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;IAC9D,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;IAC7D,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC;IAC5D,OAAO,IAAI,CAAC,iBAAiB,CAAC,SAAS,CACnC,SAAS,EACT,CAAC,EAAE,WAAW,EAAE,UAAU,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,EACpD,KAAK,CACR,CAAC;AACN,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,aAAa,CAAC,cAA8B,EAAE,MAAc;IACxE,MAAM,MAAM,GAAG,SAAS,CAAC,cAAc,EAAE,MAAM,CAAC,CAAC;IACjD,IAAI,MAAM,EAAE,CAAC;QACT,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,MAAM,CAAC;AAClB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,UAAU,WAAW,CAAC,MAAmB,EAAE,IAAmB,EAAE,MAAc;IAChF,MAAM,KAAK,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACzC,MAAM,CAAC,KAAK,CAAC,2BAA2B,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IAElE,MAAM,CAAC,SAAS,CACZ,IAAI,CAAC,OAAO,EACZ,KAAK,EACL,CAAC,GAAG,EAAE,EAAE;QACJ,IAAI,GAAG,EAAE,CAAC;YACN,MAAM,CAAC,KAAK,CAAC,sBAAsB,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC;YAClD,OAAO;QACX,CAAC;QACD,MAAM,CAAC,IAAI,CAAC,mCAAmC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC,CACJ,CAAC;IACF,OAAO,MAAM,CAAC;AAClB,CAAC"}

package/dist/vitest.config.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("vite").UserConfig;
+export default _default;
+//# sourceMappingURL=vitest.config.d.ts.map

package/dist/vitest.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.config.d.ts","sourceRoot":"","sources":["../src/vitest.config.ts"],"names":[],"mappings":";AAEA,wBAcG"}

package/dist/vitest.config.js

@@ -0,0 +1,17 @@
+import { defineConfig } from 'vitest/config';
+export default defineConfig({
+    test: {
+        globals: true,
+        environment: 'node',
+        coverage: {
+            provider: 'v8',
+            reporter: ['text', 'json', 'html'],
+            exclude: [
+                'node_modules/',
+                'dist/',
+                'src/proto/',
+            ],
+        },
+    },
+});
+//# sourceMappingURL=vitest.config.js.map

package/dist/vitest.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vitest.config.js","sourceRoot":"","sources":["../src/vitest.config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,eAAe,YAAY,CAAC;IAC1B,IAAI,EAAE;QACJ,OAAO,EAAE,IAAI;QACb,WAAW,EAAE,MAAM;QACnB,QAAQ,EAAE;YACR,QAAQ,EAAE,IAAI;YACd,QAAQ,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;YAClC,OAAO,EAAE;gBACP,eAAe;gBACf,OAAO;gBACP,YAAY;aACb;SACF;KACF;CACF,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@crossplane-org/function-sdk-typescript",
+  "version": "0.1.0",
+  "description": "A Crossplane Function SDK for Typescript",
+  "keywords": [
+    "crossplane",
+    "kubernetes",
+    "typescript"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "github.com/upbound/function-sdk-typescript"
+  },
+  "license": "Apache-2.0",
+  "author": "Steven Borrelli",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "clean": "scripts/clean.sh",
+    "build": "npx tsc",
+    "pack": "npm pack",
+    "prepublishOnly": "npm run build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "@grpc/grpc-js": "^1.12.4",
+    "@grpc/proto-loader": "^0.8.0",
+    "google-protobuf": "^4.0.0",
+    "kubernetes-models": "^4.5.1",
+    "pino": "^10.1.0",
+    "ts-deepmerge": "^7.0.3",
+    "ts-proto": "^2.8.3"
+  },
+  "devDependencies": {
+    "@types/google-protobuf": "^3.15.12",
+    "@types/node": "^22.10.5",
+    "@vitest/coverage-v8": "^2.1.8",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.2",
+    "vitest": "^2.1.8"
+  }
+}