sst 1.16.0 → 2.0.0-rc.0

package/src/constructs/util/apiGatewayV2Domain.ts

@@ -1,312 +0,0 @@
-import { Construct } from "constructs";
-import * as cdk from "aws-cdk-lib";
-import * as apig from "@aws-cdk/aws-apigatewayv2-alpha";
-import * as route53 from "aws-cdk-lib/aws-route53";
-import * as route53Targets from "aws-cdk-lib/aws-route53-targets";
-import * as acm from "aws-cdk-lib/aws-certificatemanager";
-
-export interface CustomDomainProps {
-  /**
-   * The domain to be assigned to the API endpoint (ie. api.domain.com)
-   */
-  domainName?: string;
-  /**
-   * The hosted zone in Route 53 that contains the domain. By default, SST will look for a hosted zone by stripping out the first part of the domainName that's passed in. So, if your domainName is api.domain.com. SST will default the hostedZone to domain.com.
-   */
-  hostedZone?: string;
-  /**
-   * The base mapping for the custom domain.
-   *
-   * For example, by setting the domainName to api.domain.com and the path to v1, the custom domain URL of the API will become https://api.domain.com/v1/. If the path is not set, the custom domain URL will be https://api.domain.com. Note the additional trailing slash in the former case.
-   */
-  path?: string;
-  /**
-   * Set this option if the domain is not hosted on Amazon Route 53.
-   */
-  isExternalDomain?: boolean;
-  cdk?: {
-    /**
-     * Override the internally created domain name
-     */
-    domainName?: apig.IDomainName;
-    /**
-     * Override the internally created hosted zone
-     */
-    hostedZone?: route53.IHostedZone;
-    /**
-     * Override the internally created certificate
-     */
-    certificate?: acm.ICertificate;
-  };
-}
-
-export interface CustomDomainData {
-  readonly apigDomain: apig.IDomainName;
-  readonly mappingKey?: string;
-  readonly certificate?: acm.ICertificate;
-  readonly isApigDomainCreated: boolean;
-  readonly isCertificatedCreated: boolean;
-  readonly url: string;
-}
-
-export function buildCustomDomainData(
-  scope: Construct,
-  customDomain: string | CustomDomainProps | undefined
-): CustomDomainData | undefined {
-  if (customDomain === undefined) {
-    return;
-  }
-  // customDomain is a string
-  else if (typeof customDomain === "string") {
-    return buildDataForStringInput(scope, customDomain);
-  }
-  // customDomain.domainName is a string
-  else if (customDomain.domainName) {
-    return customDomain.isExternalDomain
-      ? buildDataForExternalDomainInput(scope, customDomain)
-      : buildDataForInternalDomainInput(scope, customDomain);
-  }
-  // customDomain.domainName is a construct
-  else if (customDomain.cdk?.domainName) {
-    return buildDataForConstructInput(scope, customDomain);
-  }
-  // customDomain.domainName not exists
-  throw new Error(`Missing "domainName" in sst.Api's customDomain setting`);
-}
-
-function buildDataForStringInput(
-  scope: Construct,
-  customDomain: string
-): CustomDomainData {
-  // validate: customDomain is a TOKEN string
-  // ie. imported SSM value: ssm.StringParameter.valueForStringParameter()
-  if (cdk.Token.isUnresolved(customDomain)) {
-    throw new Error(
-      `You also need to specify the "hostedZone" if the "domainName" is passed in as a reference.`
-    );
-  }
-
-  assertDomainNameIsLowerCase(customDomain);
-
-  const domainName = customDomain;
-  const hostedZoneDomain = domainName.split(".").slice(1).join(".");
-  const hostedZone = lookupHostedZone(scope, hostedZoneDomain);
-  const certificate = createCertificate(scope, domainName, hostedZone);
-  const apigDomain = createApigDomain(scope, domainName, certificate);
-  createARecords(scope, hostedZone, domainName, apigDomain);
-
-  return {
-    apigDomain,
-    certificate,
-    isApigDomainCreated: true,
-    isCertificatedCreated: true,
-    url: buildDomainUrl(domainName),
-  };
-}
-
-function buildDataForInternalDomainInput(
-  scope: Construct,
-  customDomain: CustomDomainProps
-): CustomDomainData {
-  // If customDomain is a TOKEN string, "hostedZone" has to be passed in. This
-  // is because "hostedZone" cannot be parsed from a TOKEN value.
-  if (cdk.Token.isUnresolved(customDomain.domainName)) {
-    if (!customDomain.hostedZone && !customDomain.cdk?.hostedZone) {
-      throw new Error(
-        `You also need to specify the "hostedZone" if the "domainName" is passed in as a reference.`
-      );
-    }
-  }
-  // If domain is not a token, ensure it is lower case
-  else {
-    assertDomainNameIsLowerCase(customDomain.domainName!);
-  }
-  const domainName = customDomain.domainName!;
-
-  // Lookup hosted zone
-  // Note: Allow user passing in `hostedZone` object. The use case is when
-  //       there are multiple HostedZones with the same domain, but one is
-  //       public, and one is private.
-  let hostedZone: route53.IHostedZone;
-  if (customDomain.hostedZone) {
-    const hostedZoneDomain = customDomain.hostedZone;
-    hostedZone = lookupHostedZone(scope, hostedZoneDomain);
-  } else if (customDomain.cdk?.hostedZone) {
-    hostedZone = customDomain.cdk.hostedZone;
-  } else {
-    const hostedZoneDomain = domainName.split(".").slice(1).join(".");
-    hostedZone = lookupHostedZone(scope, hostedZoneDomain);
-  }
-
-  // Create certificate
-  // Note: Allow user passing in `certificate` object. The use case is for
-  //       user to create wildcard certificate or using an imported certificate.
-  let certificate: acm.ICertificate;
-  let isCertificatedCreated: boolean;
-  if (customDomain.cdk?.certificate) {
-    certificate = customDomain.cdk.certificate;
-    isCertificatedCreated = false;
-  } else {
-    certificate = createCertificate(scope, domainName, hostedZone);
-    isCertificatedCreated = true;
-  }
-
-  const apigDomain = createApigDomain(scope, domainName, certificate);
-  const mappingKey = customDomain.path;
-  createARecords(scope, hostedZone, domainName, apigDomain);
-
-  return {
-    apigDomain,
-    mappingKey,
-    certificate,
-    isApigDomainCreated: true,
-    isCertificatedCreated,
-    url: buildDomainUrl(domainName, mappingKey),
-  };
-}
-
-function buildDataForExternalDomainInput(
-  scope: Construct,
-  customDomain: CustomDomainProps
-): CustomDomainData {
-  // if it is external, then a certificate is required
-  if (!customDomain.cdk?.certificate) {
-    throw new Error(
-      `A valid certificate is required when "isExternalDomain" is set to "true".`
-    );
-  }
-  // if it is external, then the hostedZone is not required
-  if (customDomain.hostedZone || customDomain.cdk?.hostedZone) {
-    throw new Error(
-      `Hosted zones can only be configured for domains hosted on Amazon Route 53. Do not set the "hostedZone" when "isExternalDomain" is enabled.`
-    );
-  }
-
-  // If domain is not a token, ensure it is lower case
-  if (!cdk.Token.isUnresolved(customDomain.domainName)) {
-    assertDomainNameIsLowerCase(customDomain.domainName!);
-  }
-
-  const domainName = customDomain.domainName!;
-  const certificate = customDomain.cdk.certificate;
-  const apigDomain = createApigDomain(scope, domainName, certificate);
-  const mappingKey = customDomain.path;
-
-  return {
-    apigDomain,
-    mappingKey,
-    certificate,
-    isApigDomainCreated: true,
-    isCertificatedCreated: false,
-    url: buildDomainUrl(domainName, mappingKey),
-  };
-}
-
-function buildDataForConstructInput(
-  scope: Construct,
-  customDomain: CustomDomainProps
-): CustomDomainData {
-  //  Allow user passing in `apigDomain` object. The use case is a user creates
-  //  multiple API endpoints, and is mapping them under the same custom domain.
-  //  `sst.Api` needs to expose the `apigDomain` construct created in the first
-  //  Api, and lets user pass it in when creating the second Api.
-
-  if (customDomain.hostedZone || customDomain.cdk?.hostedZone) {
-    throw new Error(
-      `Cannot configure the "hostedZone" when the "domainName" is a construct`
-    );
-  }
-  if (customDomain.cdk?.certificate) {
-    throw new Error(
-      `Cannot configure the "certificate" when the "domainName" is a construct`
-    );
-  }
-
-  const apigDomain = customDomain.cdk?.domainName!;
-  const domainName = apigDomain.name;
-  const mappingKey = customDomain.path;
-
-  return {
-    apigDomain,
-    mappingKey,
-    certificate: undefined,
-    isApigDomainCreated: false,
-    isCertificatedCreated: false,
-    url: buildDomainUrl(domainName, mappingKey),
-  };
-}
-
-function lookupHostedZone(scope: Construct, hostedZoneDomain: string) {
-  return route53.HostedZone.fromLookup(scope, "HostedZone", {
-    domainName: hostedZoneDomain,
-  });
-}
-
-function createCertificate(
-  scope: Construct,
-  domainName: string,
-  hostedZone: route53.IHostedZone
-) {
-  return new acm.Certificate(scope, "Certificate", {
-    domainName,
-    validation: acm.CertificateValidation.fromDns(hostedZone),
-  });
-}
-
-function createApigDomain(
-  scope: Construct,
-  domainName: string,
-  certificate: acm.ICertificate
-) {
-  return new apig.DomainName(scope, "DomainName", {
-    domainName,
-    certificate,
-  });
-}
-
-function createARecords(
-  scope: Construct,
-  hostedZone: route53.IHostedZone,
-  domainName: string,
-  apigDomain: apig.IDomainName
-) {
-  // create DNS record
-  const recordProps = {
-    recordName: domainName,
-    zone: hostedZone,
-    target: route53.RecordTarget.fromAlias(
-      new route53Targets.ApiGatewayv2DomainProperties(
-        apigDomain.regionalDomainName,
-        apigDomain.regionalHostedZoneId
-      )
-    ),
-  };
-  const records = [
-    new route53.ARecord(scope, "AliasRecord", recordProps),
-    new route53.AaaaRecord(scope, "AliasRecordAAAA", recordProps),
-  ];
-  // note: If domainName is a TOKEN string ie. ${TOKEN..}, the route53.ARecord
-  //       construct will append ".${hostedZoneName}" to the end of the domain.
-  //       This is because the construct tries to check if the record name
-  //       ends with the domain name. If not, it will append the domain name.
-  //       So, we need remove this behavior.
-  if (cdk.Token.isUnresolved(domainName)) {
-    records.forEach((record) => {
-      const cfnRecord = record.node.defaultChild as route53.CfnRecordSet;
-      cfnRecord.name = domainName;
-    });
-  }
-}
-
-function buildDomainUrl(domainName: string, mappingKey?: string) {
-  // Note: If mapping key is set, the URL needs a trailing slash. Without the
-  //       trailing slash, the API fails with the error
-  //       {"message":"Not Found"}
-  return mappingKey ? `${domainName}/${mappingKey}/` : domainName;
-}
-
-function assertDomainNameIsLowerCase(domainName: string): void {
-  if (domainName !== domainName.toLowerCase()) {
-    throw new Error(`The domain name needs to be in lowercase`);
-  }
-}

package/src/constructs/util/appSyncApiDomain.ts

@@ -1,204 +0,0 @@
-import { Token, Lazy } from "aws-cdk-lib";
-import * as route53 from "aws-cdk-lib/aws-route53";
-import * as appsync from "@aws-cdk/aws-appsync-alpha";
-import * as acm from "aws-cdk-lib/aws-certificatemanager";
-import { AppSyncApi } from "../AppSyncApi";
-
-export interface CustomDomainProps {
-  /**
-   * The domain to be assigned to the API endpoint (ie. api.domain.com)
-   */
-  domainName?: string;
-  /**
-   * The hosted zone in Route 53 that contains the domain. By default, SST will look for a hosted zone by stripping out the first part of the domainName that's passed in. So, if your domainName is api.domain.com. SST will default the hostedZone to domain.com.
-   */
-  hostedZone?: string;
-  /**
-   * Set this option if the domain is not hosted on Amazon Route 53.
-   */
-  isExternalDomain?: boolean;
-  cdk?: {
-    /**
-     * Override the internally created hosted zone
-     */
-    hostedZone?: route53.IHostedZone;
-    /**
-     * Override the internally created certificate
-     */
-    certificate?: acm.ICertificate;
-  };
-}
-
-export function buildCustomDomainData(
-  scope: AppSyncApi,
-  customDomain: string | CustomDomainProps | undefined
-): appsync.DomainOptions | undefined {
-  if (customDomain === undefined) {
-    return;
-  }
-  // customDomain is a string
-  else if (typeof customDomain === "string") {
-    return buildDataForStringInput(scope, customDomain);
-  }
-  // customDomain.domainName is a string
-  else if (customDomain.domainName) {
-    return customDomain.isExternalDomain
-      ? buildDataForExternalDomainInput(scope, customDomain)
-      : buildDataForInternalDomainInput(scope, customDomain);
-  }
-  // customDomain.domainName not exists
-  throw new Error(
-    `Missing "domainName" in sst.AppSyncApi's customDomain setting`
-  );
-}
-
-function buildDataForStringInput(
-  scope: AppSyncApi,
-  customDomain: string
-): appsync.DomainOptions {
-  // validate: customDomain is a TOKEN string
-  // ie. imported SSM value: ssm.StringParameter.valueForStringParameter()
-  if (Token.isUnresolved(customDomain)) {
-    throw new Error(
-      `You also need to specify the "hostedZone" if the "domainName" is passed in as a reference.`
-    );
-  }
-
-  assertDomainNameIsLowerCase(customDomain);
-
-  const domainName = customDomain;
-  const hostedZoneDomain = domainName.split(".").slice(1).join(".");
-  const hostedZone = lookupHostedZone(scope, hostedZoneDomain);
-  const certificate = createCertificate(scope, domainName, hostedZone);
-  createRecord(scope, hostedZone, domainName);
-
-  return {
-    certificate,
-    domainName,
-  };
-}
-
-function buildDataForInternalDomainInput(
-  scope: AppSyncApi,
-  customDomain: CustomDomainProps
-): appsync.DomainOptions {
-  // If customDomain is a TOKEN string, "hostedZone" has to be passed in. This
-  // is because "hostedZone" cannot be parsed from a TOKEN value.
-  if (Token.isUnresolved(customDomain.domainName)) {
-    if (!customDomain.hostedZone) {
-      throw new Error(
-        `You also need to specify the "hostedZone" if the "domainName" is passed in as a reference.`
-      );
-    }
-  } else {
-    assertDomainNameIsLowerCase(customDomain.domainName as string);
-  }
-
-  const domainName = customDomain.domainName as string;
-
-  // Lookup hosted zone
-  // Note: Allow user passing in `hostedZone` object. The use case is when
-  //       there are multiple HostedZones with the same domain, but one is
-  //       public, and one is private.
-  let hostedZone: route53.IHostedZone;
-  if (customDomain.hostedZone) {
-    const hostedZoneDomain = customDomain.hostedZone;
-    hostedZone = lookupHostedZone(scope, hostedZoneDomain);
-  } else if (customDomain.cdk?.hostedZone) {
-    hostedZone = customDomain.cdk.hostedZone;
-  } else {
-    const hostedZoneDomain = domainName.split(".").slice(1).join(".");
-    hostedZone = lookupHostedZone(scope, hostedZoneDomain);
-  }
-
-  // Create certificate
-  // Note: Allow user passing in `certificate` object. The use case is for
-  //       user to create wildcard certificate or using an imported certificate.
-  const certificate = customDomain.cdk?.certificate
-    ? customDomain.cdk.certificate
-    : createCertificate(scope, domainName, hostedZone);
-
-  createRecord(scope, hostedZone, domainName);
-
-  return {
-    certificate,
-    domainName,
-  };
-}
-
-function buildDataForExternalDomainInput(
-  scope: AppSyncApi,
-  customDomain: CustomDomainProps
-): appsync.DomainOptions {
-  // if it is external, then a certificate is required
-  if (!customDomain.cdk?.certificate) {
-    throw new Error(
-      `A valid certificate is required when "isExternalDomain" is set to "true".`
-    );
-  }
-  // if it is external, then the hostedZone is not required
-  if (customDomain.hostedZone || customDomain.cdk?.hostedZone) {
-    throw new Error(
-      `Hosted zones can only be configured for domains hosted on Amazon Route 53. Do not set the "hostedZone" when "isExternalDomain" is enabled.`
-    );
-  }
-
-  const domainName = customDomain.domainName as string;
-  assertDomainNameIsLowerCase(domainName);
-  const certificate = customDomain.cdk.certificate;
-
-  return {
-    certificate,
-    domainName,
-  };
-}
-
-function lookupHostedZone(scope: AppSyncApi, hostedZoneDomain: string) {
-  return route53.HostedZone.fromLookup(scope, "HostedZone", {
-    domainName: hostedZoneDomain,
-  });
-}
-
-function createCertificate(
-  scope: AppSyncApi,
-  domainName: string,
-  hostedZone: route53.IHostedZone
-) {
-  return new acm.Certificate(scope, "Certificate", {
-    domainName,
-    validation: acm.CertificateValidation.fromDns(hostedZone),
-  });
-}
-
-function createRecord(
-  scope: AppSyncApi,
-  hostedZone: route53.IHostedZone,
-  domainName: string
-) {
-  // create DNS record
-  const record = new route53.CnameRecord(scope, "CnameRecord", {
-    recordName: domainName,
-    zone: hostedZone,
-    domainName: Lazy.string({
-      produce() {
-        return scope._cfnDomainName!.attrAppSyncDomainName;
-      },
-    }),
-  });
-
-  // note: If domainName is a TOKEN string ie. ${TOKEN..}, the route53.ARecord
-  //       construct will append ".${hostedZoneName}" to the end of the domain.
-  //       This is because the construct tries to check if the record name
-  //       ends with the domain name. If not, it will append the domain name.
-  //       So, we need remove this behavior.
-  if (Token.isUnresolved(domainName)) {
-    const cfnRecord = record.node.defaultChild as route53.CfnRecordSet;
-    cfnRecord.name = domainName;
-  }
-}
-
-function assertDomainNameIsLowerCase(domainName: string): void {
-  if (domainName !== domainName.toLowerCase()) {
-    throw new Error(`The domain name needs to be in lowercase`);
-  }
-}

package/src/constructs/util/builder.ts

@@ -1,17 +0,0 @@
-export function addExtensionToHandler(
-  handler: string,
-  extension: string
-): string {
-  return handler.replace(/\.[\w\d]+$/, extension);
-}
-
-export function getHandlerFullPosixPath(
-  srcPath: string,
-  handler: string
-): string {
-  return srcPath === "." ? handler : `${srcPath}/${handler}`;
-}
-
-export function getHandlerHash(posixPath: string): string {
-  return `${posixPath.replace(/[\\/.]/g, "-")}-${Date.now()}`;
-}

package/src/constructs/util/duration.ts

@@ -1,27 +0,0 @@
-import { Duration as CDKDuration } from "aws-cdk-lib";
-export type Duration = `${number} ${
-  | "second"
-  | "seconds"
-  | "minute"
-  | "minutes"
-  | "hour"
-  | "hours"
-  | "day"
-  | "days"}`;
-
-export function toCdkDuration(duration: Duration): CDKDuration {
-  const [count, unit] = duration.split(" ");
-  const countNum = parseInt(count);
-  const unitLower = unit.toLowerCase();
-  if (unitLower.startsWith("second")) {
-    return CDKDuration.seconds(countNum);
-  } else if (unitLower.startsWith("minute")) {
-    return CDKDuration.minutes(countNum);
-  } else if (unitLower.startsWith("hour")) {
-    return CDKDuration.hours(countNum);
-  } else if (unitLower.startsWith("day")) {
-    return CDKDuration.days(countNum);
-  }
-
-  return CDKDuration.days(0);
-}

package/src/constructs/util/functionBinding.ts

@@ -1,102 +0,0 @@
-import * as ssm from "aws-cdk-lib/aws-ssm";
-import { SSTConstruct } from "../Construct.js";
-import { App } from "../App.js";
-import { Config } from "../../config.js";
-
-export const ENVIRONMENT_PLACEHOLDER = "__FETCH_FROM_SSM__";
-
-export interface FunctionBindingProps {
-  clientPackage: string;
-  permissions: Record<string, string[]>;
-  variables: Record<
-    string,
-    {
-      // environments are used for 2 purposes:
-      //  - pass binding values to the function (ie. bucket name)
-      //  - pass placeholder value to the function (ie. secret)
-      environment: string;
-      parameter?: string;
-    }
-  >;
-}
-
-export function bindEnvironment(c: SSTConstruct) {
-  const binding = c.getFunctionBinding();
-
-  const environment: Record<string, string> = {};
-  if (binding) {
-    Object.entries(binding.variables).forEach(([prop, variable]) => {
-      const envName = getEnvironmentKey(c, prop);
-      environment[envName] = variable.environment;
-    });
-  }
-
-  return environment;
-}
-
-export function bindParameters(c: SSTConstruct) {
-  const binding = c.getFunctionBinding();
-  if (!binding) {
-    return;
-  }
-
-  const app = c.node.root as App;
-  Object.entries(binding.variables)
-    .filter(([, variable]) => variable.parameter)
-    .forEach(([prop, variable]) => {
-      const resId = `Parameter_${prop}`;
-      if (!c.node.tryFindChild(resId)) {
-        new ssm.StringParameter(c, resId, {
-          // Parameters, Secrets, and Jobs do not have a name
-          parameterName: getParameterPath(c, prop),
-          stringValue: variable.parameter!,
-        });
-      }
-    });
-}
-
-export function bindPermissions(c: SSTConstruct) {
-  return c.getFunctionBinding()?.permissions || {};
-}
-
-export function bindType(c: SSTConstruct) {
-  const binding = c.getFunctionBinding();
-  if (!binding) {
-    return;
-  }
-
-  return {
-    clientPackage: binding.clientPackage,
-    variables: Object.keys(binding.variables),
-  };
-}
-
-export function getEnvironmentKey(c: SSTConstruct, prop: string): string {
-  return Config.envFor({
-    type: c.constructor.name,
-    id: c.id,
-    prop: prop,
-  });
-}
-
-export function getParameterPath(c: SSTConstruct, prop: string): string {
-  const construct = c.constructor.name;
-  return Config.pathFor({
-    id: c.id,
-    type: construct,
-    prop: prop,
-  });
-}
-
-export function getParameterFallbackPath(
-  c: SSTConstruct,
-  prop: string
-): string {
-  const construct = c.constructor.name;
-  return Config.pathFor({
-    id: c.id,
-    type: construct,
-    prop: prop,
-    fallback: true,
-  });
-}