@sdlcworks/components 0.0.29 → 0.0.30

package/dist/index.d.ts

@@ -79,23 +79,33 @@ export declare function toCanonicalInterfaceName(name: string): string;
 /**
  * Connection interface definition with a unique name and typed schema.
  * The name is used for matching interfaces across separately bundled components.
+ *
+ * @param TName - Unique interface name
+ * @param TSchema - Input schema (data from connecting component)
+ * @param TResultSchema - Optional result metadata schema for typed handler results
  */
-export type ConnectionInterfaceDef<TName extends string = string, TSchema extends z.ZodObject<z.ZodRawShape> = z.ZodObject<z.ZodRawShape>> = {
+export type ConnectionInterfaceDef<TName extends string = string, TSchema extends z.ZodObject<z.ZodRawShape> = z.ZodObject<z.ZodRawShape>, TResultSchema extends z.ZodObject<z.ZodRawShape> | undefined = undefined> = {
 	readonly name: TName;
 	readonly schema: TSchema;
+	readonly resultSchema?: TResultSchema;
 };
 /**
- * Creates a connection interface definition with a unique name and schema.
+ * Creates a connection interface definition with a unique name and schemas.
  * The name is canonicalized to hyphen-separated lowercase and registered
  * globally to detect collisions.
  *
+ * @param name - Unique interface name
+ * @param schema - Input schema for data passed to handler via ctx.connectionData
+ * @param resultSchema - Optional schema for typed metadata returned by handler
+ *
  * @example
  * const ServiceAccountCI = defineConnectionInterface(
  *   "service-account",
- *   z.object({ email: z.string() })
+ *   z.object({ email: z.string() }),
+ *   z.object({ role: z.string() })  // Optional result metadata
  * );
  */
-export declare function defineConnectionInterface<TName extends string, TSchema extends z.ZodObject<z.ZodRawShape>>(name: TName, schema: TSchema): ConnectionInterfaceDef<TName, TSchema>;
+export declare function defineConnectionInterface<TName extends string, TSchema extends z.ZodObject<z.ZodRawShape>, TResultSchema extends z.ZodObject<z.ZodRawShape> | undefined = undefined>(name: TName, schema: TSchema, resultSchema?: TResultSchema): ConnectionInterfaceDef<TName, TSchema, TResultSchema>;
 /**
  * Merges a parent interface's schema with additional fields.
  * Use with defineConnectionInterface to create extended interfaces.
@@ -127,7 +137,7 @@ export declare const TCPCI: ConnectionInterfaceDef<"tcp", z.ZodObject<{
 		value: z.ZodString;
 	}, z.core.$strip>;
 	publicAccess: z.ZodBoolean;
-}, z.core.$strip>>;
+}, z.core.$strip>, undefined>;
 /**
  * Extract the inferred data type from a ConnectionInterfaceDef.
  */
@@ -138,6 +148,11 @@ export type InferConnectionData<D extends ConnectionInterfaceDef> = z.infer<D["s
 export type InferConnectionDataWithInputs<D extends ConnectionInterfaceDef> = InferConnectionData<D> extends infer Data ? {
 	[K in keyof Data]: PulumiInput<Data[K]>;
 } : never;
+/**
+ * Extract the inferred result metadata type from a ConnectionInterfaceDef.
+ * Returns undefined if no resultSchema is defined.
+ */
+export type InferConnectionResultMetadata<D extends ConnectionInterfaceDef> = D extends ConnectionInterfaceDef<any, any, infer R> ? R extends z.ZodObject<z.ZodRawShape> ? z.infer<R> : undefined : undefined;
 /**
  * Entry type for declareConnectionInterfaces parameter.
  * Declares an interface that this component exposes with typed data.
@@ -233,15 +248,25 @@ export type ConnectionHandlerCtx<S, ConnectorData, ConnectionType extends string
 };
 /**
  * Result returned by connection handlers.
- * Must return a record mapping component names to their URIs.
+ * - uri: Required, the connection URI as a Pulumi Output
+ * - metadata: Optional, typed based on interface's resultSchema
+ *
+ * If no resultSchema is defined on the interface, metadata can be any record.
+ * If resultSchema is defined, metadata is typed and validated against it.
  */
-export type ConnectionHandlerResult = Record<string, PulumiOutput<string>>;
+export type ConnectionHandlerResult<TMetadata = undefined> = {
+	uri: PulumiOutput<string>;
+	metadata?: TMetadata extends undefined ? Record<string, PulumiInput<string | number | boolean>> : {
+		[K in keyof TMetadata]: PulumiInput<TMetadata[K]>;
+	};
+};
 /**
  * A connection handler entry mapping a ConnectionInterfaceDef to its handler function.
+ * The handler returns typed metadata based on the interface's resultSchema.
  */
 export type ConnectionHandlerEntry<S, ConnectionType extends string, D extends ConnectionInterfaceDef, P extends CloudProvider = CloudProvider> = {
 	interface: D;
-	handler: (ctx: ConnectionHandlerCtx<S, InferConnectionData<D>, ConnectionType, P>) => Promise<ConnectionHandlerResult>;
+	handler: (ctx: ConnectionHandlerCtx<S, InferConnectionData<D>, ConnectionType, P>) => Promise<ConnectionHandlerResult<InferConnectionResultMetadata<D>>>;
 };
 /**
  * Type definition for a connection handler entry.
@@ -249,7 +274,7 @@ export type ConnectionHandlerEntry<S, ConnectionType extends string, D extends C
  */
 export type ConnectionHandlerDef<D extends ConnectionInterfaceDef> = {
 	interface: D;
-	handler: (ctx: ConnectionHandlerCtx<any, InferConnectionData<D>, any>) => Promise<ConnectionHandlerResult>;
+	handler: (ctx: ConnectionHandlerCtx<any, InferConnectionData<D>, any>) => Promise<ConnectionHandlerResult<InferConnectionResultMetadata<D>>>;
 };
 export declare function connectionHandler<D extends ConnectionInterfaceDef>(entry: ConnectionHandlerDef<D>): ConnectionHandlerDef<D>;
 export type ProviderDeployCtx<D, S, P extends CloudProvider = CloudProvider> = {
@@ -316,8 +341,8 @@ export type ProviderFnsDef<I, D, O, SShape extends z.ZodRawShape = EmptyStateSha
  * when accessing from the registry, allowing runtime schema access.
  */
 export type StoredConnectionHandlerEntry = {
-	interface: ConnectionInterfaceDef;
-	handler: (ctx: ConnectionHandlerCtx<any, any, any, any>) => Promise<ConnectionHandlerResult>;
+	interface: ConnectionInterfaceDef<string, any, any>;
+	handler: (ctx: ConnectionHandlerCtx<any, any, any, any>) => Promise<ConnectionHandlerResult<any>>;
 };
 export type StoredProviderFns = {
 	stateSchema: z.ZodObject<any>;

package/dist/index.js

@@ -1 +1 @@
-import{z as j}from"zod";import*as Y from"@pulumi/pulumi";var Q;((L)=>{L.aws="aws";L.gcloud="gcloud";L.azure="azure";L.linode="linode";L.hetzner="hetzner";L.cloudflare="cloudflare"})(Q||={});var W;((B)=>B.container_image="container_image")(W||={});var Z;((H)=>{H.ipv4="ipv4";H.ipv6="ipv6";H.domain="domain"})(Z||={});var X=new Map;function _(b){return b.replace(/([a-z])([A-Z])/g,"$1-$2").replace(/[_\s]+/g,"-").toLowerCase().replace(/-+/g,"-").replace(/^-|-$/g,"")}function $(b){let B=_(b);if(B.length===0)throw new Error("Connection interface name cannot be empty");let F=X.get(B);if(F!==void 0&&F!==b)throw new Error(`Connection interface name collision: '${b}' resolves to '${B}' which is already registered by '${F}'`);return X.set(B,b),B}function q(b,B){return{name:$(b),schema:B}}function w(b,B){return b.schema.merge(B)}var x=q("tcp",j.object({url:j.object({type:j.nativeEnum(Z),value:j.string()}),publicAccess:j.boolean()})),R=j.object({});function J(b){if(b instanceof j.ZodObject){let B=b.shape,F={};for(let H in B)F[H]=J(B[H]);return j.object(F)}if(b instanceof j.ZodOptional)return J(b.unwrap()).optional();if(b instanceof j.ZodNullable)return J(b.unwrap()).nullable();if(b instanceof j.ZodDefault)return J(b._def.innerType).default(b._def.defaultValue);if(b instanceof j.ZodArray)return j.array(J(b.element));if(b instanceof j.ZodDiscriminatedUnion){let B=b._def.options.map((F)=>J(F));return j.discriminatedUnion(b._def.discriminator,B)}if(b instanceof j.ZodRecord){let B=b._def.keyType,F=b._def.valueType,H=B?J(B):j.string(),M=F?J(F):j.any();return j.record(H,M)}return j.union([b,j.custom((B)=>Y.Output.isInstance(B))])}var E=j.object({metadata:j.object({stateful:j.boolean(),proxiable:j.boolean()}),connectionTypes:j.record(j.string(),j.object({description:j.string().min(5)})),configSchema:j.custom(),deploymentInputSchema:j.custom(),outputSchema:j.custom()});function U(b){return b}var G=j.object({});class K{opts;providers;validationSchema;validationDeploymentInputSchema;declaredConnectionInterfaces=new Map;constructor(b){this.opts=E.parse(b),this.providers={},this.validationSchema=J(b.configSchema),this.validationDeploymentInputSchema=J(b.deploymentInputSchema)}implement(b,B){return this.providers[b]={...B,stateSchema:B.stateSchema??G,initialState:B.initialState},this}getConnectionSchema(b){return b.schema}createDeclareConnectionInterfacesFn(){return(b)=>{for(let B of b){let F=B.interface.schema,H=J(F),M=H.safeParse(B.data);if(!M.success)throw new Error(`Invalid data for connection interface '${B.interface.name}': ${M.error.message}`);this.declaredConnectionInterfaces.set(B.interface.name,{schema:H,data:B.data})}}}getDeclaredInterfaces(){return this.declaredConnectionInterfaces}}export{_ as toCanonicalInterfaceName,w as extendSchema,q as defineConnectionInterface,U as connectionHandler,Z as TCPUrlType,x as TCPCI,K as InfraComponent,W as DeploymentArtifactType,Q as CloudProvider};
+import{z as j}from"zod";import*as Y from"@pulumi/pulumi";var Q;((L)=>{L.aws="aws";L.gcloud="gcloud";L.azure="azure";L.linode="linode";L.hetzner="hetzner";L.cloudflare="cloudflare"})(Q||={});var W;((B)=>B.container_image="container_image")(W||={});var Z;((H)=>{H.ipv4="ipv4";H.ipv6="ipv6";H.domain="domain"})(Z||={});var X=new Map;function _(b){return b.replace(/([a-z])([A-Z])/g,"$1-$2").replace(/[_\s]+/g,"-").toLowerCase().replace(/-+/g,"-").replace(/^-|-$/g,"")}function $(b){let B=_(b);if(B.length===0)throw new Error("Connection interface name cannot be empty");let F=X.get(B);if(F!==void 0&&F!==b)throw new Error(`Connection interface name collision: '${b}' resolves to '${B}' which is already registered by '${F}'`);return X.set(B,b),B}function q(b,B,F){return{name:$(b),schema:B,resultSchema:F}}function w(b,B){return b.schema.merge(B)}var x=q("tcp",j.object({url:j.object({type:j.nativeEnum(Z),value:j.string()}),publicAccess:j.boolean()})),R=j.object({});function J(b){if(b instanceof j.ZodObject){let B=b.shape,F={};for(let H in B)F[H]=J(B[H]);return j.object(F)}if(b instanceof j.ZodOptional)return J(b.unwrap()).optional();if(b instanceof j.ZodNullable)return J(b.unwrap()).nullable();if(b instanceof j.ZodDefault)return J(b._def.innerType).default(b._def.defaultValue);if(b instanceof j.ZodArray)return j.array(J(b.element));if(b instanceof j.ZodDiscriminatedUnion){let B=b._def.options.map((F)=>J(F));return j.discriminatedUnion(b._def.discriminator,B)}if(b instanceof j.ZodRecord){let B=b._def.keyType,F=b._def.valueType,H=B?J(B):j.string(),M=F?J(F):j.any();return j.record(H,M)}return j.union([b,j.custom((B)=>Y.Output.isInstance(B))])}var E=j.object({metadata:j.object({stateful:j.boolean(),proxiable:j.boolean()}),connectionTypes:j.record(j.string(),j.object({description:j.string().min(5)})),configSchema:j.custom(),deploymentInputSchema:j.custom(),outputSchema:j.custom()});function U(b){return b}var G=j.object({});class K{opts;providers;validationSchema;validationDeploymentInputSchema;declaredConnectionInterfaces=new Map;constructor(b){this.opts=E.parse(b),this.providers={},this.validationSchema=J(b.configSchema),this.validationDeploymentInputSchema=J(b.deploymentInputSchema)}implement(b,B){return this.providers[b]={...B,stateSchema:B.stateSchema??G,initialState:B.initialState},this}getConnectionSchema(b){return b.schema}createDeclareConnectionInterfacesFn(){return(b)=>{for(let B of b){let F=B.interface.schema,H=J(F),M=H.safeParse(B.data);if(!M.success)throw new Error(`Invalid data for connection interface '${B.interface.name}': ${M.error.message}`);this.declaredConnectionInterfaces.set(B.interface.name,{schema:H,data:B.data})}}}getDeclaredInterfaces(){return this.declaredConnectionInterfaces}}export{_ as toCanonicalInterfaceName,w as extendSchema,q as defineConnectionInterface,U as connectionHandler,Z as TCPUrlType,x as TCPCI,K as InfraComponent,W as DeploymentArtifactType,Q as CloudProvider};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sdlcworks/components",
-  "version": "0.0.29",
+  "version": "0.0.30",
   "module": "dist/index.js",
   "files": [
     "dist"