@sdlcworks/components 0.0.37 → 0.0.38

package/dist/index.d.ts

@@ -190,16 +190,13 @@ declare const InfraComponentOptsSchema: z.ZodObject<{
 	connectionTypes: z.ZodRecord<z.ZodString, z.ZodObject<{
 		description: z.ZodString;
 	}, z.core.$strip>>;
+	acceptedArtifactTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<typeof DeploymentArtifactType>>>;
 	configSchema: z.ZodCustom<z.ZodObject<Readonly<{
 		[k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
 	}>, z.core.$strip>, z.ZodObject<Readonly<{
 		[k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
 	}>, z.core.$strip>>;
-	deploymentInputSchema: z.ZodCustom<z.ZodObject<Readonly<{
-		[k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
-	}>, z.core.$strip>, z.ZodObject<Readonly<{
-		[k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
-	}>, z.core.$strip>>;
+	deploymentInputSchema: z.ZodCustom<z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>, z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>>;
 	outputSchema: z.ZodCustom<z.ZodObject<Readonly<{
 		[k: string]: z.core.$ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
 	}>, z.core.$strip>, z.ZodObject<Readonly<{
@@ -207,15 +204,20 @@ declare const InfraComponentOptsSchema: z.ZodObject<{
 	}>, z.core.$strip>>;
 }, z.core.$strip>;
 export type InfraComponentOptsBase = z.infer<typeof InfraComponentOptsSchema>;
-export type InfraComponentOpts<CShape extends z.ZodRawShape, DShape extends z.ZodRawShape, OShape extends z.ZodRawShape, ConnTypes extends Record<string, {
+export type InfraComponentOpts<CShape extends z.ZodRawShape, DSchema extends z.ZodTypeAny, OShape extends z.ZodRawShape, ConnTypes extends Record<string, {
 	description: string;
 }> = Record<string, {
 	description: string;
 }>> = Omit<InfraComponentOptsBase, "configSchema" | "deploymentInputSchema" | "outputSchema" | "connectionTypes"> & {
 	configSchema: z.ZodObject<CShape>;
-	deploymentInputSchema: z.ZodObject<DShape>;
+	deploymentInputSchema: DSchema;
 	outputSchema: z.ZodObject<OShape>;
 	connectionTypes: ConnTypes;
+	/**
+	 * Artifact types this infra component supports receiving.
+	 * Required when any provider implements `upsertArtifacts`.
+	 */
+	acceptedArtifactTypes?: DeploymentArtifactType[];
 };
 export type ArtifactInfo = {
 	artifact: {
@@ -319,6 +321,18 @@ export declare function connectionHandler<D extends ConnectionInterfaceDef>(entr
  * connectorComponentName and selfComponentName) via closure.
  */
 export type ConnectFn<S, ConnectionType extends string, P extends CloudProvider = CloudProvider> = (ctx: ConnectFnCtx<S, P>) => readonly ConnectionHandlerEntry<ConnectionType, any>[];
+/**
+ * Naming function for Pulumi resources. Used by all component types to generate
+ * deterministic, collision-free resource names scoped to the component's unique ID.
+ *
+ * Supports both tagged-template and plain-string invocation:
+ *   $`my-resource`
+ *   $("my-resource")
+ */
+export type NamingFn = {
+	(name: string, ...values: any[]): string;
+	(strings: TemplateStringsArray, ...values: any[]): string;
+};
 /**
  * Component entry in the URLRegister provision context.
  * Reference metadata for components, keyed by their original URI.
@@ -462,18 +476,18 @@ export type DeclaredConnectionInterfaces = Map<string, {
 	schema: z.ZodTypeAny;
 	data: any;
 }>;
-export declare class InfraComponent<CShape extends z.ZodRawShape, DShape extends z.ZodRawShape, OShape extends z.ZodRawShape = EmptyOutputShape, ConnTypes extends Record<string, {
+export declare class InfraComponent<CShape extends z.ZodRawShape, DSchema extends z.ZodTypeAny, OShape extends z.ZodRawShape = EmptyOutputShape, ConnTypes extends Record<string, {
 	description: string;
 }> = Record<string, {
 	description: string;
 }>> {
-	opts: InfraComponentOpts<CShape, DShape, OShape, ConnTypes>;
+	opts: InfraComponentOpts<CShape, DSchema, OShape, ConnTypes>;
 	providers: ProviderRegistry;
 	validationSchema: z.ZodTypeAny;
 	validationDeploymentInputSchema: z.ZodTypeAny;
 	private declaredConnectionInterfaces;
-	constructor(opts: InfraComponentOpts<CShape, DShape, OShape, ConnTypes>);
-	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;
+	constructor(opts: InfraComponentOpts<CShape, DSchema, OShape, ConnTypes>);
+	implement<P extends CloudProvider, SShape extends z.ZodRawShape = EmptyStateShape>(provider: P, fns: ProviderFnsDef<InferZodType<CShape>, z.infer<DSchema>, InferOutputType<OShape>, SShape, keyof ConnTypes & string, P>): this;
 	/**
 	 * Get the schema for a specific connection interface.
 	 * Used by the orchestrator at runtime.
@@ -568,5 +582,121 @@ export declare class URLRegister<TName extends string, TInterface extends Connec
 	 */
 	getProvision(): StoredProvisionFn;
 }
+/**
+ * Context passed to the ArtifactRegistry provision function.
+ * Called inside the Pulumi program (during stack:sync) to create cloud resources
+ * for the artifact registry (e.g., ECR repository, GCP Artifact Registry repo,
+ * CodeArtifact domain, etc.).
+ *
+ * @property config - Validated config from configSchema (e.g., registry URL, scope)
+ * @property state - Mutable state persisted across provision runs
+ * @property $ - Naming helper for Pulumi resource names
+ * @property getCredentials - Returns typed cloud credentials for the configured provider
+ */
+export type ArtifactRegistryProvisionCtx<TConfig, S, P extends CloudProvider = CloudProvider> = {
+	config: TConfig;
+	state: S;
+	$: NamingFn;
+	getCredentials: GetCredentialsFn<P>;
+};
+/**
+ * Context passed to the ArtifactRegistry publish function.
+ * Called outside Pulumi (like deploy/upsertArtifacts) to push a built artifact
+ * to the external registry under a versioned tag.
+ *
+ * @property componentName - Name of the app component being published
+ * @property artifact - The build artifact to publish (uri + type)
+ * @property version - The version string from the release command
+ * @property publishConfig - Per-component publish settings from registry_targets.publish_config
+ * @property state - Persisted state from provision (e.g., registry URL, repo name)
+ * @property getCredentials - Returns typed cloud credentials for the configured provider
+ */
+export type ArtifactRegistryPublishCtx<S, P extends CloudProvider = CloudProvider> = {
+	componentName: string;
+	artifact: {
+		uri: string;
+		type: DeploymentArtifactType;
+	};
+	version: string;
+	publishConfig: Record<string, any>;
+	state: S;
+	getCredentials: GetCredentialsFn<P>;
+};
+/**
+ * Type-erased storage for ArtifactRegistry provision function.
+ */
+export type StoredArtifactRegistryProvisionFn = (ctx: ArtifactRegistryProvisionCtx<any, any, any>) => Promise<void>;
+/**
+ * Type-erased storage for ArtifactRegistry publish function.
+ */
+export type StoredArtifactRegistryPublishFn = (ctx: ArtifactRegistryPublishCtx<any, any>) => Promise<void>;
+/**
+ * ArtifactRegistry component for publishing build artifacts to external package
+ * registries (npm, PyPI, Docker Hub, ECR, GAR, CodeArtifact, etc.).
+ *
+ * Provides two lifecycle functions:
+ * - **`provision`**: Called inside Pulumi to create cloud resources for the registry
+ *   (e.g., ECR repository, GAR repo, CodeArtifact domain). Runs during `stack:sync`.
+ * - **`publish`**: Called outside Pulumi to push a built artifact with a version tag.
+ *   Runs during the release flow via `sdlc-components-run publish`.
+ *
+ * App components reference artifact registries via `registry_targets` in the
+ * TechStackConfig, parallel to how `infra_targets` links components to infra.
+ *
+ * @param TName - Unique name for this ArtifactRegistry definition
+ * @param CShape - Zod shape for the config schema (provision-time settings)
+ * @param SShape - Zod shape for the state schema (persisted across runs, default: empty)
+ *
+ * @example
+ * const registry = new ArtifactRegistry({
+ *   name: "ecr-registry",
+ *   acceptedArtifactTypes: [DeploymentArtifactType.oci_spec_image],
+ *   configSchema: z.object({
+ *     repositoryPrefix: z.string(),
+ *     imageTagMutability: z.enum(["MUTABLE", "IMMUTABLE"]).default("IMMUTABLE"),
+ *   }),
+ *   stateSchema: z.object({
+ *     repositoryUrl: z.string(),
+ *   }),
+ *   provision: async ({ config, state, $, getCredentials }) => {
+ *     const repo = new aws.ecr.Repository($`repo`, {
+ *       name: config.repositoryPrefix,
+ *       imageTagMutability: config.imageTagMutability,
+ *     });
+ *     state.repositoryUrl = repo.repositoryUrl;
+ *   },
+ *   publish: async ({ componentName, artifact, version, state, getCredentials }) => {
+ *     // Push the OCI image from internal store to ECR with version tag
+ *     // e.g., docker tag + docker push to state.repositoryUrl
+ *   },
+ * });
+ */
+export declare class ArtifactRegistry<TName extends string, CShape extends z.ZodRawShape, SShape extends z.ZodRawShape = EmptyStateShape> {
+	readonly name: TName;
+	readonly acceptedArtifactTypes: DeploymentArtifactType[];
+	readonly configSchema: z.ZodObject<CShape>;
+	readonly stateSchema: z.ZodObject<SShape>;
+	readonly validationSchema: z.ZodTypeAny;
+	readonly initialState?: Partial<RuntimeState<SShape>>;
+	private readonly provisionFn;
+	private readonly publishFn;
+	constructor(opts: {
+		name: TName;
+		acceptedArtifactTypes: DeploymentArtifactType[];
+		configSchema: z.ZodObject<CShape>;
+		stateSchema?: z.ZodObject<SShape>;
+		initialState?: Partial<RuntimeState<SShape>>;
+		provision: (ctx: ArtifactRegistryProvisionCtx<InferZodType<CShape>, RuntimeState<SShape>, CloudProvider>) => Promise<void>;
+		publish: (ctx: ArtifactRegistryPublishCtx<RuntimeState<SShape>, CloudProvider>) => Promise<void>;
+	});
+	/**
+	 * Get the provision function (for orchestrator use during stack:sync).
+	 */
+	getProvision(): StoredArtifactRegistryProvisionFn;
+	/**
+	 * Get the publish function (for orchestrator use during release/publish).
+	 */
+	getPublish(): StoredArtifactRegistryPublishFn;
+}
 
 export {};

package/dist/index.js

@@ -1 +1 @@
-import{z as j}from"zod";import*as Z from"@pulumi/pulumi";var W;((M)=>{M.aws="aws";M.gcloud="gcloud";M.azure="azure";M.linode="linode";M.hetzner="hetzner";M.cloudflare="cloudflare"})(W||={});var X;((F)=>{F.oci_spec_image="oci_spec_image";F.file="file"})(X||={});var Y=new Map;function $(b){return b.replace(/([a-z])([A-Z])/g,"$1-$2").replace(/[_\s]+/g,"-").toLowerCase().replace(/-+/g,"-").replace(/^-|-$/g,"")}function q(b){let B=$(b);if(B.length===0)throw new Error("Connection interface name cannot be empty");let F=Y.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 Y.set(B,b),B}function E(b,B,F){return{name:q(b),schema:B,resultSchema:F}}function k(b,B){return b.schema.merge(B)}var x=E("public-http",j.object({})),I="@anonymous",R=j.object({});function H(b){if(b instanceof j.ZodObject){let B=b.shape,F={};for(let J in B)F[J]=H(B[J]);return j.object(F)}if(b instanceof j.ZodOptional)return H(b.unwrap()).optional();if(b instanceof j.ZodNullable)return H(b.unwrap()).nullable();if(b instanceof j.ZodDefault)return H(b._def.innerType).default(b._def.defaultValue);if(b instanceof j.ZodArray)return j.array(H(b.element));if(b instanceof j.ZodDiscriminatedUnion){let B=b._def.options.map((F)=>H(F));return j.discriminatedUnion(b._def.discriminator,B)}if(b instanceof j.ZodRecord){let B=b._def.keyType,F=b._def.valueType,J=B?H(B):j.string(),Q=F?H(F):j.any();return j.record(J,Q)}return j.union([b,j.custom((B)=>Z.Output.isInstance(B))])}var G=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 g(b){return b}var _=j.object({});class K{opts;providers;validationSchema;validationDeploymentInputSchema;declaredConnectionInterfaces=new Map;constructor(b){this.opts=G.parse(b),this.providers={},this.validationSchema=H(b.configSchema),this.validationDeploymentInputSchema=H(b.deploymentInputSchema)}implement(b,B){if(B.allocateComponent&&B.allocateWithPulumiCtx)throw new Error(`Provider '${b}' cannot define both 'allocateComponent' and 'allocateWithPulumiCtx'. These are mutually exclusive allocation strategies.`);return this.providers[b]={...B,stateSchema:B.stateSchema??_,initialState:B.initialState},this}getConnectionSchema(b){return b.schema}createDeclareConnectionInterfacesFn(){return(b)=>{this.declaredConnectionInterfaces=new Map;for(let B of b){let F=B.interface.schema,J=H(F),Q=J.safeParse(B.data);if(!Q.success)throw new Error(`Invalid data for connection interface '${B.interface.name}': ${Q.error.message}`);this.declaredConnectionInterfaces.set(B.interface.name,{schema:J,data:B.data})}}}getDeclaredInterfaces(){return this.declaredConnectionInterfaces}}var L=j.object({name:j.string().min(1),interface:j.custom(),configSchema:j.custom(),stateSchema:j.custom().optional(),provision:j.function()});class U{name;interface;configSchema;stateSchema;validationSchema;provisionFn;initialState;constructor(b){L.parse(b),this.name=b.name,this.interface=b.interface,this.configSchema=b.configSchema,this.stateSchema=b.stateSchema??_,this.validationSchema=H(b.configSchema),this.provisionFn=b.provision,this.initialState=b.initialState}getProvision(){return this.provisionFn}}export{$ as toCanonicalInterfaceName,k as extendSchema,E as defineConnectionInterface,g as connectionHandler,U as URLRegister,x as PublicHTTPCI,K as InfraComponent,X as DeploymentArtifactType,W as CloudProvider,I as ANONYMOUS_CONNECTION_TYPE};
+import{z as B}from"zod";import*as $ from"@pulumi/pulumi";var Z;((Q)=>{Q.aws="aws";Q.gcloud="gcloud";Q.azure="azure";Q.linode="linode";Q.hetzner="hetzner";Q.cloudflare="cloudflare"})(Z||={});var X;((H)=>{H.oci_spec_image="oci_spec_image";H.file="file"})(X||={});var _=new Map;function q(j){return j.replace(/([a-z])([A-Z])/g,"$1-$2").replace(/[_\s]+/g,"-").toLowerCase().replace(/-+/g,"-").replace(/^-|-$/g,"")}function E(j){let F=q(j);if(F.length===0)throw new Error("Connection interface name cannot be empty");let H=_.get(F);if(H!==void 0&&H!==j)throw new Error(`Connection interface name collision: '${j}' resolves to '${F}' which is already registered by '${H}'`);return _.set(F,j),F}function G(j,F,H){return{name:E(j),schema:F,resultSchema:H}}function I(j,F){return j.schema.merge(F)}var R=G("public-http",B.object({})),P="@anonymous",g=B.object({});function J(j){if(j instanceof B.ZodObject){let F=j.shape,H={};for(let M in F)H[M]=J(F[M]);return B.object(H)}if(j instanceof B.ZodOptional)return J(j.unwrap()).optional();if(j instanceof B.ZodNullable)return J(j.unwrap()).nullable();if(j instanceof B.ZodDefault)return J(j._def.innerType).default(j._def.defaultValue);if(j instanceof B.ZodArray)return B.array(J(j.element));if(j instanceof B.ZodDiscriminatedUnion){let F=j._def.options.map((H)=>J(H));return B.discriminatedUnion(j._def.discriminator,F)}if(j instanceof B.ZodRecord){let F=j._def.keyType,H=j._def.valueType,M=F?J(F):B.string(),W=H?J(H):B.any();return B.record(M,W)}return B.union([j,B.custom((F)=>$.Output.isInstance(F))])}var K=B.object({metadata:B.object({stateful:B.boolean(),proxiable:B.boolean()}),connectionTypes:B.record(B.string(),B.object({description:B.string().min(5)})),acceptedArtifactTypes:B.array(B.nativeEnum(X)).optional(),configSchema:B.custom(),deploymentInputSchema:B.custom(),outputSchema:B.custom()});function D(j){return j}var Y=B.object({});class L{opts;providers;validationSchema;validationDeploymentInputSchema;declaredConnectionInterfaces=new Map;constructor(j){this.opts=K.parse(j),this.providers={},this.validationSchema=J(j.configSchema),this.validationDeploymentInputSchema=J(j.deploymentInputSchema)}implement(j,F){if(F.allocateComponent&&F.allocateWithPulumiCtx)throw new Error(`Provider '${j}' cannot define both 'allocateComponent' and 'allocateWithPulumiCtx'. These are mutually exclusive allocation strategies.`);if(F.upsertArtifacts&&(!this.opts.acceptedArtifactTypes||this.opts.acceptedArtifactTypes.length===0))throw new Error(`Provider '${j}' defines 'upsertArtifacts' but the component is missing 'acceptedArtifactTypes'. Declare which artifact types this component supports (e.g. [DeploymentArtifactType.oci_spec_image]).`);return this.providers[j]={...F,stateSchema:F.stateSchema??Y,initialState:F.initialState},this}getConnectionSchema(j){return j.schema}createDeclareConnectionInterfacesFn(){return(j)=>{this.declaredConnectionInterfaces=new Map;for(let F of j){let H=F.interface.schema,M=J(H),W=M.safeParse(F.data);if(!W.success)throw new Error(`Invalid data for connection interface '${F.interface.name}': ${W.error.message}`);this.declaredConnectionInterfaces.set(F.interface.name,{schema:M,data:F.data})}}}getDeclaredInterfaces(){return this.declaredConnectionInterfaces}}var U=B.object({name:B.string().min(1),interface:B.custom(),configSchema:B.custom(),stateSchema:B.custom().optional(),provision:B.function()});class V{name;interface;configSchema;stateSchema;validationSchema;provisionFn;initialState;constructor(j){U.parse(j),this.name=j.name,this.interface=j.interface,this.configSchema=j.configSchema,this.stateSchema=j.stateSchema??Y,this.validationSchema=J(j.configSchema),this.provisionFn=j.provision,this.initialState=j.initialState}getProvision(){return this.provisionFn}}var b=B.object({name:B.string().min(1),acceptedArtifactTypes:B.array(B.nativeEnum(X)).min(1),configSchema:B.custom(),stateSchema:B.custom().optional(),provision:B.function(),publish:B.function()});class N{name;acceptedArtifactTypes;configSchema;stateSchema;validationSchema;initialState;provisionFn;publishFn;constructor(j){b.parse(j),this.name=j.name,this.acceptedArtifactTypes=j.acceptedArtifactTypes,this.configSchema=j.configSchema,this.stateSchema=j.stateSchema??Y,this.validationSchema=J(j.configSchema),this.initialState=j.initialState,this.provisionFn=j.provision,this.publishFn=j.publish}getProvision(){return this.provisionFn}getPublish(){return this.publishFn}}export{q as toCanonicalInterfaceName,I as extendSchema,G as defineConnectionInterface,D as connectionHandler,V as URLRegister,R as PublicHTTPCI,L as InfraComponent,X as DeploymentArtifactType,Z as CloudProvider,N as ArtifactRegistry,P as ANONYMOUS_CONNECTION_TYPE};

package/package.json

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