@geekmidas/cloud 10.0.0-alpha.36 → 10.0.0-alpha.38

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@geekmidas/cloud",
-  "version": "10.0.0-alpha.36",
+  "version": "10.0.0-alpha.38",
   "type": "module",
   "files": [
     "dist",
@@ -41,8 +41,8 @@
   },
   "dependencies": {
     "lodash.snakecase": "~4.1.1",
-    "@geekmidas/envkit": "10.0.0-alpha.36",
-    "@geekmidas/manifest": "10.0.0-alpha.36"
+    "@geekmidas/envkit": "10.0.0-alpha.38",
+    "@geekmidas/manifest": "10.0.0-alpha.38"
   },
   "devDependencies": {
     "@types/lodash.get": "~4.4.9",
@@ -58,10 +58,10 @@
     "@pulumi/aws": ">=7.47.0",
     "@pulumi/random": ">=4.21.2",
     "@pulumi/pulumi": ">=3.263.0",
-    "@geekmidas/manifest": "^10.0.0-alpha.36",
-    "@geekmidas/storage": "^10.0.0-alpha.36",
-    "@geekmidas/events": "^10.0.0-alpha.36",
-    "@geekmidas/db": "^10.0.0-alpha.36"
+    "@geekmidas/manifest": "^10.0.0-alpha.38",
+    "@geekmidas/storage": "^10.0.0-alpha.38",
+    "@geekmidas/events": "^10.0.0-alpha.38",
+    "@geekmidas/db": "^10.0.0-alpha.38"
   },
   "peerDependenciesMeta": {
     "@geekmidas/manifest": {

package/src/sst/__tests__/fromManifest.spec.ts

@@ -1,5 +1,5 @@
 import { resolveEnvKeys } from '@geekmidas/envkit/sst';
-import { providedKeyFor, provideKey } from '@geekmidas/manifest';
+import { NoUrlForStage, providedKeyFor, provideKey } from '@geekmidas/manifest';
 import { describe, expect, it } from 'vitest';
 import { ObjectStorage } from '../aws/ObjectStorage';
 import { type ProvidesMismatch, UnknownDeclarationKind } from '../errors';
@@ -249,18 +249,91 @@ describe('the key a provided role becomes', () => {
 describe('Credential', () => {
 	it('provides under the role the declaration named', async () => {
 		// The role *is* the contract: providing `value` against a declared
-		// `STRIPE_CREDENTIAL` supplies `STRIPE_VALUE`, and assertProvides
+		// `STRIPE_CREDENTIALS` supplies `STRIPE_VALUE`, and assertProvides
 		// rejects the stack at synth. Which is the check working.
 		const { Credential } = await import('../aws/Credential');
 
 		expect(
 			Object.keys(new Credential({} as never, 'Stripe').provides()),
-		).toEqual(['credential']);
+		).toEqual(['credentials']);
 	});
 
 	it('agrees with what the construct declares', () => {
-		expect(providedKeyFor('Stripe', 'credential', 'credential')).toBe(
-			'STRIPE_CREDENTIAL',
+		expect(providedKeyFor('Stripe', 'credential', 'credentials')).toBe(
+			'STRIPE_CREDENTIALS',
 		);
 	});
+
+	it('links under the key the construct reads, not the secret’s bare name', async () => {
+		const { Credential } = await import('../aws/Credential');
+		const stripe = new Credential({} as never, 'Stripe');
+
+		expect(resolveEnvKeys({ Stripe: { type: stripe._type } })).toEqual([
+			'STRIPE_CREDENTIALS',
+		]);
+		expect(stripe.getSSTLink().properties).toEqual(stripe.provides());
+	});
+
+	it('is what a function depending on it is linked to', async () => {
+		const { Credential } = await import('../aws/Credential');
+		const stripe = new Credential({} as never, 'Stripe');
+
+		const { link, envKeys } = resolveEdges(
+			[{ target: 'Stripe', kind: 'credential' }],
+			{ Stripe: stripe },
+		);
+
+		expect(link).toEqual([stripe]);
+		expect(envKeys).toEqual(['STRIPE_CREDENTIALS']);
+	});
+});
+
+describe('ExternalApi', () => {
+	const stack = (stage: string) => ({ stage }) as never;
+
+	it('provides the URL for its stage and its credentials, under the declared keys', async () => {
+		const { ExternalApi } = await import('../aws/ExternalApi');
+		const payfast = new ExternalApi(stack('production'), 'PayFast', {
+			url: {
+				production: 'https://www.payfast.co.za',
+				default: 'https://sandbox.payfast.co.za',
+			},
+		});
+
+		expect(payfast.provides().url).toBe('https://www.payfast.co.za');
+		expect(
+			Object.keys(payfast.provides()).map((role) =>
+				providedKeyFor('PayFast', 'external-api', role),
+			),
+		).toEqual(['PAY_FAST_URL', 'PAY_FAST_CREDENTIALS']);
+	});
+
+	it('falls back to the default URL for a stage it does not name', async () => {
+		const { ExternalApi } = await import('../aws/ExternalApi');
+		const payfast = new ExternalApi(stack('staging'), 'PayFast', {
+			url: {
+				production: 'https://www.payfast.co.za',
+				default: 'https://sandbox.payfast.co.za',
+			},
+		});
+
+		expect(payfast.provides().url).toBe('https://sandbox.payfast.co.za');
+	});
+
+	it('fails synth for a stage it has no URL for', async () => {
+		const { ExternalApi } = await import('../aws/ExternalApi');
+
+		expect(
+			() =>
+				new ExternalApi(stack('staging'), 'PayFast', {
+					url: { production: 'https://www.payfast.co.za' },
+				}),
+		).toThrow(NoUrlForStage);
+	});
+
+	it('flattens into the same keys at runtime', () => {
+		expect(
+			resolveEnvKeys({ PayFast: { type: 'gkm:aws:ExternalApi' } }).sort(),
+		).toEqual(['PAY_FAST_CREDENTIALS', 'PAY_FAST_URL']);
+	});
 });

package/src/sst/aws/Credential.ts

@@ -1,4 +1,5 @@
-import { Secret, type SecretProps } from './Secret';
+import { type GkmLinkable, ResourceType } from '../Linkable';
+import type { StackType } from '../Stack';
 
 /**
  * `Credential` — a third-party credential SST holds, and the infra half of the
@@ -8,21 +9,53 @@ import { Secret, type SecretProps } from './Secret';
  * the lifecycle rather than the mechanism: a secret is generated and rotated by
  * the platform, while a credential is issued by someone else and has a shape
  * the construct validates on the way in. Both are values you set out of band
- * with `sst secret set`.
+ * with `sst secret set`, under the construct's id.
  *
- * The role is `credential` rather than `value`, and that is not cosmetic. The
+ * The role is `credentials` rather than `value`, and that is not cosmetic. The
  * role *is* the contract — `providedKeyFor` turns it into the key the app
  * declared — so a credential providing `value` would supply `STRIPE_VALUE`
- * against a declared `STRIPE_CREDENTIAL`, and `assertProvides` would reject the
- * stack at synth. Which is the check working; renaming here is the fix.
+ * against a declared `STRIPE_CREDENTIALS`, and `assertProvides` would reject
+ * the stack at synth.
+ *
+ * It holds an `sst.Secret` rather than being one, and reports its own type,
+ * for the same reason one level down: the type decides the keys a link
+ * resolves to. As an SST secret it resolved to `STRIPE`, so a function that
+ * declared `STRIPE_CREDENTIALS` was linked to nothing.
  */
 export class Credential<
 	TStage extends string = string,
 	TDomain extends string = string,
-> extends Secret<TStage, TDomain> {
-	override provides(): Record<string, $util.Input<string>> {
-		return { credential: this.value };
+> implements GkmLinkable
+{
+	readonly _id: string;
+
+	private readonly secret: sst.Secret;
+
+	get _type() {
+		return ResourceType.Credential;
+	}
+
+	constructor(
+		_stack: StackType<TStage, TDomain>,
+		name: string,
+		props: CredentialProps = {},
+	) {
+		this._id = name;
+		// The id itself, as it always was: a value already set with
+		// `sst secret set Stripe …` is still the one read.
+		this.secret = new sst.Secret(name, props.placeholder);
+	}
+
+	provides(): Record<string, $util.Input<string>> {
+		return { credentials: this.secret.value };
+	}
+
+	getSSTLink() {
+		return { properties: { ...this.provides() } };
 	}
 }
 
-export interface CredentialProps extends SecretProps {}
+export interface CredentialProps {
+	/** A value until one is set, for a preview stage. */
+	placeholder?: string;
+}

package/src/sst/aws/ExternalApi.ts

@@ -0,0 +1,58 @@
+import { externalApiUrl } from '@geekmidas/manifest';
+import { type GkmLinkable, ResourceType } from '../Linkable';
+import type { StackType } from '../Stack';
+
+/**
+ * `ExternalApi` — the infra half of the `external-api` kind.
+ *
+ * Nothing is provisioned: the API is somebody else's. What this holds is the
+ * two facts a function needs to call it on this stage — the URL the
+ * declaration names for it, and the credentials the provider issued, kept as
+ * an SST secret and set out of band:
+ *
+ * ```
+ * sst secret set PolarCredentials '{"clientId":"…","clientSecret":"…"}' --stage prod
+ * ```
+ */
+export class ExternalApi<
+	TStage extends string = string,
+	TDomain extends string = string,
+> implements GkmLinkable
+{
+	readonly _id: string;
+
+	private readonly url: string;
+
+	private readonly credentials: sst.Secret;
+
+	get _type() {
+		return ResourceType.ExternalApi;
+	}
+
+	constructor(
+		stack: StackType<TStage, TDomain>,
+		name: string,
+		props: ExternalApiProps,
+	) {
+		this._id = name;
+		// Read at synth, so a stage the declaration has no URL for fails the
+		// deploy — with the stage named — rather than the first request.
+		this.url = externalApiUrl({ id: name, url: props.url }, stack.stage);
+		this.credentials = new sst.Secret(`${name}Credentials`, props.placeholder);
+	}
+
+	provides(): Record<string, $util.Input<string>> {
+		return { url: this.url, credentials: this.credentials.value };
+	}
+
+	getSSTLink() {
+		return { properties: { ...this.provides() } };
+	}
+}
+
+export interface ExternalApiProps {
+	/** The declaration's `url` — one for every stage, or one per stage name. */
+	url: string | Readonly<Record<string, string>>;
+	/** A value for the credentials secret until one is set, for a preview stage. */
+	placeholder?: string;
+}

package/src/sst/fromManifest.ts

@@ -45,6 +45,7 @@ import { Database, DatabaseNeedsVpc, type DatabaseProps } from './aws/Database';
 import { DatabaseBootstrap } from './aws/DatabaseBootstrap';
 import { DatabaseReader, DatabaseSchema } from './aws/DerivedDatabase';
 import { Email, EmailNeedsSender } from './aws/Email';
+import { ExternalApi, type ExternalApiProps } from './aws/ExternalApi';
 import { FileServer } from './aws/FileServer';
 import { ObjectStorage } from './aws/ObjectStorage';
 import { Queue } from './aws/Queue';
@@ -399,6 +400,19 @@ const PROVISIONERS: Partial<Record<DeclarationKind, Provisioner>> = {
 
 	// The same storage as a secret, under a different role — see the component.
 	credential: (stack, d, props) => new Credential(stack, d.id, props),
+
+	// Nothing to provision: the URL this stage calls, and the credentials kept
+	// as a secret.
+	'external-api': (stack, d, props) => {
+		if (d.kind !== 'external-api') {
+			throw new UnknownDeclarationKind(d.kind, []);
+		}
+
+		return new ExternalApi(stack, d.id, {
+			...(props as Partial<ExternalApiProps>),
+			url: d.url,
+		});
+	},
 };
 
 /**