@sdlcworks/components 0.0.27 → 0.0.29

package/dist/index.d.ts

@@ -3,6 +3,14 @@
 import { Input as PulumiInput, Output as PulumiOutput } from '@pulumi/pulumi';
 import { z } from 'zod';
 
+/**
+ * Types copied from @sdlc/types for use in the published @sdlcworks/components package.
+ * These are duplicated here to avoid requiring users to install @sdlc/types
+ * (which is an internal monorepo package not published to npm).
+ *
+ * ⚠️  SYNC REQUIRED: When modifying these types, also update @sdlc/types/src/index.ts
+ *     and vice versa. These files must be kept in sync manually.
+ */
 export declare enum CloudProvider {
 	aws = "aws",
 	gcloud = "gcloud",
@@ -11,14 +19,53 @@ export declare enum CloudProvider {
 	hetzner = "hetzner",
 	cloudflare = "cloudflare"
 }
+export declare enum DeploymentArtifactType {
+	container_image = "container_image"
+}
+/**
+ * GCP credential fields required for authentication.
+ */
+export type BranchMetadataCloudCredentialGCP = {
+	GCP_PROJECT_ID: string;
+	GCP_SERVICE_ACCOUNT_KEY: string;
+};
+/**
+ * AWS credential fields required for authentication.
+ */
+export type BranchMetadataCloudCredentialAWS = {
+	AWS_ACCESS_KEY_ID: string;
+	AWS_SECRET_ACCESS_KEY: string;
+	AWS_REGION: string;
+};
+/**
+ * Cloudflare credential fields required for authentication.
+ */
+export type BranchMetadataCloudCredentialCloudflare = {
+	CLOUDFLARE_API_TOKEN: string;
+	CLOUDFLARE_ACCOUNT_ID?: string;
+};
+/**
+ * Maps each CloudProvider to its corresponding credential type.
+ * Used to provide fully-typed credentials in handler contexts.
+ */
+export type ProviderCredentialsMap = {
+	[CloudProvider.gcloud]: BranchMetadataCloudCredentialGCP;
+	[CloudProvider.aws]: BranchMetadataCloudCredentialAWS;
+	[CloudProvider.cloudflare]: BranchMetadataCloudCredentialCloudflare;
+	[CloudProvider.azure]: Record<string, unknown>;
+	[CloudProvider.linode]: Record<string, unknown>;
+	[CloudProvider.hetzner]: Record<string, unknown>;
+};
+/**
+ * Function type for getCredentials.
+ * Returns the typed credentials for the specified provider.
+ */
+export type GetCredentialsFn<P extends CloudProvider> = () => ProviderCredentialsMap[P];
 export declare enum TCPUrlType {
 	ipv4 = "ipv4",
 	ipv6 = "ipv6",
 	domain = "domain"
 }
-export declare enum DeploymentArtifactType {
-	container_image = "container_image"
-}
 /**
  * Transforms any interface name to canonical hyphen-separated lowercase form.
  *
@@ -161,7 +208,7 @@ export type DeploymentInfo = {
 		type: DeploymentArtifactType;
 	};
 };
-export type ProviderPulumiCtx<I, S> = {
+export type ProviderPulumiCtx<I, S, P extends CloudProvider = CloudProvider> = {
 	componentName: string;
 	$: {
 		(name: string, ...values: any[]): string;
@@ -171,16 +218,18 @@ export type ProviderPulumiCtx<I, S> = {
 	state: S;
 	declareConnectionInterfaces: DeclareConnectionInterfacesFn;
 	buildArtifacts: Record<string, ArtifactInfo>;
+	getCredentials: GetCredentialsFn<P>;
 };
 /**
  * Context passed to connection handlers.
  * Contains the provider state, typed data from the connecting component,
- * and the connection type chosen by the orchestrator.
+ * the connection type chosen by the orchestrator, and getCredentials function.
  */
-export type ConnectionHandlerCtx<S, ConnectorData, ConnectionType extends string = string> = {
+export type ConnectionHandlerCtx<S, ConnectorData, ConnectionType extends string = string, P extends CloudProvider = CloudProvider> = {
 	state: S;
 	connectionData: ConnectorData;
 	connectionType: ConnectionType;
+	getCredentials: GetCredentialsFn<P>;
 };
 /**
  * Result returned by connection handlers.
@@ -190,9 +239,9 @@ export type ConnectionHandlerResult = Record<string, PulumiOutput<string>>;
 /**
  * A connection handler entry mapping a ConnectionInterfaceDef to its handler function.
  */
-export type ConnectionHandlerEntry<S, ConnectionType extends string, D extends ConnectionInterfaceDef> = {
+export type ConnectionHandlerEntry<S, ConnectionType extends string, D extends ConnectionInterfaceDef, P extends CloudProvider = CloudProvider> = {
 	interface: D;
-	handler: (ctx: ConnectionHandlerCtx<S, InferConnectionData<D>, ConnectionType>) => Promise<ConnectionHandlerResult>;
+	handler: (ctx: ConnectionHandlerCtx<S, InferConnectionData<D>, ConnectionType, P>) => Promise<ConnectionHandlerResult>;
 };
 /**
  * Type definition for a connection handler entry.
@@ -203,10 +252,11 @@ export type ConnectionHandlerDef<D extends ConnectionInterfaceDef> = {
 	handler: (ctx: ConnectionHandlerCtx<any, InferConnectionData<D>, any>) => Promise<ConnectionHandlerResult>;
 };
 export declare function connectionHandler<D extends ConnectionInterfaceDef>(entry: ConnectionHandlerDef<D>): ConnectionHandlerDef<D>;
-export type ProviderDeployCtx<D, S> = {
+export type ProviderDeployCtx<D, S, P extends CloudProvider = CloudProvider> = {
 	state: S;
+	getCredentials: GetCredentialsFn<P>;
 } & Record<string, DeploymentInfo>;
-export type ProviderAllocateCtx<S> = {
+export type ProviderAllocateCtx<S, P extends CloudProvider = CloudProvider> = {
 	name: string;
 	deploymentConfig: Record<string, any>;
 	state: S;
@@ -214,8 +264,9 @@ export type ProviderAllocateCtx<S> = {
 		(name: string, ...values: any[]): string;
 		(strings: TemplateStringsArray, ...values: any[]): string;
 	};
+	getCredentials: GetCredentialsFn<P>;
 };
-export type ProviderDeallocateCtx<S> = {
+export type ProviderDeallocateCtx<S, P extends CloudProvider = CloudProvider> = {
 	name: string;
 	deploymentConfig: Record<string, any>;
 	state: S;
@@ -223,16 +274,18 @@ export type ProviderDeallocateCtx<S> = {
 		(name: string, ...values: any[]): string;
 		(strings: TemplateStringsArray, ...values: any[]): string;
 	};
+	getCredentials: GetCredentialsFn<P>;
 };
-export type ProviderUpsertArtifactsCtx<S> = {
+export type ProviderUpsertArtifactsCtx<S, P extends CloudProvider = CloudProvider> = {
 	buildArtifacts: Record<string, ArtifactInfo>;
 	state: S;
+	getCredentials: GetCredentialsFn<P>;
 };
-export type ProviderPulumiFn<I, S, O> = (ctx: ProviderPulumiCtx<I, S>) => Promise<O>;
-export type ProviderDeployFn<D, S> = (ctx: ProviderDeployCtx<D, S>) => Promise<void>;
-export type ProviderAllocateFn<S> = (ctx: ProviderAllocateCtx<S>) => Promise<void>;
-export type ProviderDeallocateFn<S> = (ctx: ProviderDeallocateCtx<S>) => Promise<void>;
-export type ProviderUpsertArtifactsFn<S> = (ctx: ProviderUpsertArtifactsCtx<S>) => Promise<void>;
+export type ProviderPulumiFn<I, S, O, P extends CloudProvider = CloudProvider> = (ctx: ProviderPulumiCtx<I, S, P>) => Promise<O>;
+export type ProviderDeployFn<D, S, P extends CloudProvider = CloudProvider> = (ctx: ProviderDeployCtx<D, S, P>) => Promise<void>;
+export type ProviderAllocateFn<S, P extends CloudProvider = CloudProvider> = (ctx: ProviderAllocateCtx<S, P>) => Promise<void>;
+export type ProviderDeallocateFn<S, P extends CloudProvider = CloudProvider> = (ctx: ProviderDeallocateCtx<S, P>) => Promise<void>;
+export type ProviderUpsertArtifactsFn<S, P extends CloudProvider = CloudProvider> = (ctx: ProviderUpsertArtifactsCtx<S, P>) => Promise<void>;
 declare const emptyStateSchema: z.ZodObject<{}, z.core.$strip>;
 export type EmptyStateShape = typeof emptyStateSchema.shape;
 export type InferredState<SShape extends z.ZodRawShape> = z.infer<z.ZodObject<SShape>>;
@@ -247,15 +300,15 @@ export type InferredState<SShape extends z.ZodRawShape> = z.infer<z.ZodObject<SS
 export type RuntimeState<SShape extends z.ZodRawShape> = {
 	[K in keyof InferredState<SShape>]: InferredState<SShape>[K] | PulumiOutput<InferredState<SShape>[K]>;
 };
-export type ProviderFnsDef<I, D, O, SShape extends z.ZodRawShape = EmptyStateShape, ConnectionType extends string = string, S = RuntimeState<SShape>> = {
+export type ProviderFnsDef<I, D, O, SShape extends z.ZodRawShape = EmptyStateShape, ConnectionType extends string = string, P extends CloudProvider = CloudProvider, S = RuntimeState<SShape>> = {
 	stateSchema?: z.ZodObject<SShape>;
 	initialState?: Partial<S>;
-	pulumi: ProviderPulumiFn<I, S, O>;
+	pulumi: ProviderPulumiFn<I, S, O, P>;
 	connect?: readonly ConnectionHandlerEntry<S, ConnectionType, any>[];
-	deploy?: ProviderDeployFn<D, S>;
-	allocateComponent?: ProviderAllocateFn<S>;
-	deallocateComponent?: ProviderDeallocateFn<S>;
-	upsertArtifacts?: ProviderUpsertArtifactsFn<S>;
+	deploy?: ProviderDeployFn<D, S, P>;
+	allocateComponent?: ProviderAllocateFn<S, P>;
+	deallocateComponent?: ProviderDeallocateFn<S, P>;
+	upsertArtifacts?: ProviderUpsertArtifactsFn<S, P>;
 };
 /**
  * Stored version of ConnectionHandlerEntry that preserves ConnectionInterfaceDef type.
@@ -264,17 +317,17 @@ export type ProviderFnsDef<I, D, O, SShape extends z.ZodRawShape = EmptyStateSha
  */
 export type StoredConnectionHandlerEntry = {
 	interface: ConnectionInterfaceDef;
-	handler: (ctx: ConnectionHandlerCtx<any, any, any>) => Promise<ConnectionHandlerResult>;
+	handler: (ctx: ConnectionHandlerCtx<any, any, any, any>) => Promise<ConnectionHandlerResult>;
 };
 export type StoredProviderFns = {
 	stateSchema: z.ZodObject<any>;
 	initialState?: any;
-	pulumi: ProviderPulumiFn<any, any, any>;
+	pulumi: ProviderPulumiFn<any, any, any, any>;
 	connect?: readonly StoredConnectionHandlerEntry[];
-	deploy?: ProviderDeployFn<any, any>;
-	allocateComponent?: ProviderAllocateFn<any>;
-	deallocateComponent?: ProviderDeallocateFn<any>;
-	upsertArtifacts?: ProviderUpsertArtifactsFn<any>;
+	deploy?: ProviderDeployFn<any, any, any>;
+	allocateComponent?: ProviderAllocateFn<any, any>;
+	deallocateComponent?: ProviderDeallocateFn<any, any>;
+	upsertArtifacts?: ProviderUpsertArtifactsFn<any, any>;
 };
 export type ProviderRegistry = Partial<Record<CloudProvider, StoredProviderFns>>;
 /**
@@ -297,7 +350,7 @@ export declare class InfraComponent<CShape extends z.ZodRawShape, DShape extends
 	validationDeploymentInputSchema: z.ZodTypeAny;
 	private declaredConnectionInterfaces;
 	constructor(opts: InfraComponentOpts<CShape, DShape, OShape, ConnTypes>);
-	implement<SShape extends z.ZodRawShape = EmptyStateShape>(provider: CloudProvider, fns: ProviderFnsDef<InferZodType<CShape>, InferZodType<DShape>, InferOutputType<OShape>, SShape, keyof ConnTypes & string>): this;
+	implement<P extends CloudProvider, SShape extends z.ZodRawShape = EmptyStateShape>(provider: P, fns: ProviderFnsDef<InferZodType<CShape>, InferZodType<DShape>, InferOutputType<OShape>, SShape, keyof ConnTypes & string, P>): this;
 	/**
 	 * Get the schema for a specific connection interface.
 	 * Used by the orchestrator at runtime.

package/dist/index.js

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

package/package.json

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