@gradientedge/cdk-utils 10.8.0 → 11.0.0

package/dist/src/lib/cloudflare/construct/pages-static-site/main.js

@@ -1,168 +0,0 @@
-import * as aws from '@pulumi/aws';
-import * as azure from '@pulumi/azure-native';
-import * as std from '@pulumi/std';
-import { CommonCloudflareConstruct } from '../../common/index.js';
-/**
- * @classdesc Provides a construct to create and deploy a cloudflare pages static site
- * @example
- * import { CloudflarePagesStaticSite, CloudflareStaticSiteProps } '@gradientedge/cdk-utils'
- * import { Construct } from 'constructs'
- *
- * class CustomConstruct extends CloudflarePagesStaticSite {
- *   constructor(parent: Construct, id: string, props: CloudflareStaticSiteProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.id = id
- *     this.initResources()
- *   }
- * }
- */
-export class CloudflarePagesStaticSite extends CommonCloudflareConstruct {
-    /* static site resources */
-    sitePagesCnameRecord;
-    sitePagesDomain;
-    sitePagesProject;
-    siteZone;
-    sitePagesEnvironmentVariables;
-    sitePagesPreviewEnvironmentVariables;
-    sitePagesSecrets;
-    sitePagesPreviewSecrets;
-    siteDeploymentDependsOn;
-    constructor(id, props, options) {
-        super(id, props);
-        this.props = props;
-        this.options = options;
-        this.id = id;
-    }
-    /**
-     * @summary Initialise and provision resources
-     */
-    initResources() {
-        this.resolveZone();
-        this.resolveSecrets();
-        this.resolveEnvironmentVariables();
-        this.createProject();
-        this.createDomain();
-        this.createRecord();
-        this.deploySite();
-    }
-    /**
-     * @summary Resolve the zone to use for the static site
-     */
-    resolveZone() {
-        if (this.props.useExistingZone) {
-            this.siteZone = this.zoneManager.resolveZone(`${this.id}-zone`, this);
-        }
-        else {
-            this.siteZone = this.zoneManager.createZone(`${this.id}-zone`, this, this.props.siteZone);
-        }
-    }
-    /**
-     * @summary Resolve the secrets to use for the static site
-     */
-    resolveSecrets() {
-        this.props.sitePagesProject = {
-            ...this.props.sitePagesProject,
-            deploymentConfigs: {
-                preview: {
-                    envVars: this.sitePagesPreviewSecrets,
-                },
-                production: {
-                    envVars: this.sitePagesSecrets,
-                },
-            },
-        };
-    }
-    /**
-     * @summary Resolve the environment variables to use for the static site
-     */
-    resolveEnvironmentVariables() {
-        this.props.sitePagesProject = {
-            ...this.props.sitePagesProject,
-            deploymentConfigs: {
-                preview: {
-                    envVars: this.sitePagesPreviewEnvironmentVariables,
-                },
-                production: {
-                    envVars: this.sitePagesEnvironmentVariables,
-                },
-            },
-        };
-    }
-    /**
-     * @summary Resolve secrets from AWS Secrets Manager
-     * @param secretName the secret name
-     * @param secretKey the secret key
-     * @returns the secret value
-     */
-    resolveSecretFromAWS(secretName, secretKey) {
-        if (this.config.require('secretsProvider') !== 'aws')
-            return;
-        const secret = aws.secretsmanager.getSecretOutput({ name: secretName });
-        const secretVersion = aws.secretsmanager.getSecretVersionOutput({ secretId: secret.id });
-        if (!secretVersion)
-            throw new Error(`Unable to resolve secret:${secretName}`);
-        return std.jsondecodeOutput({ input: secretVersion.secretString });
-    }
-    /**
-     * @summary Resolve secrets from Azure Key Vault
-     *
-     * @param resourceGroupName the resource group name where the key vault is located
-     * @param keyVaultName the key vault name
-     * @param secretKey the secret key
-     * @returns the secret value
-     */
-    resolveSecretFromAzure(resourceGroupName, keyVaultName, secretKey) {
-        if (this.config.require('secretsProvider') !== 'azure')
-            return;
-        const secretValueData = azure.keyvault.getSecretOutput({
-            resourceGroupName,
-            secretName: secretKey,
-            vaultName: keyVaultName,
-        });
-        if (!secretValueData)
-            throw new Error(`Unable to resolve secret:${secretKey}`);
-        return secretValueData.properties?.value;
-    }
-    /**
-     * @summary Create the pages project
-     */
-    createProject() {
-        this.sitePagesProject = this.pageManager.createPagesProject(`${this.id}-site-project`, this, this.props.sitePagesProject);
-    }
-    /**
-     * @summary Create the pages domain
-     */
-    createDomain() {
-        this.sitePagesDomain = this.pageManager.createPagesDomain(`${this.id}-site-domain`, this, {
-            accountId: this.props.accountId,
-            name: `${this.props.siteSubDomain}.${this.props.domainName}`,
-            projectName: this.sitePagesProject.name,
-        });
-    }
-    /**
-     * @summary Create the pages cname record
-     */
-    createRecord() {
-        this.sitePagesCnameRecord = this.recordManager.createRecord(`${this.id}-site-record`, this, {
-            ...this.props.siteCnameRecord,
-            name: this.props.siteSubDomain,
-            data: {
-                ...this.props.siteCnameRecord.data,
-                value: `${this.sitePagesProject.name}.pages.dev`,
-            },
-        });
-    }
-    /**
-     * @summary Deploy the pages project
-     */
-    deploySite() {
-        this.pageManager.deployPagesProject(`${this.id}-deploy`, this, {
-            branch: this.props.siteBranch ?? 'main',
-            directory: this.props.siteAssetDir,
-            message: this.props.siteDeployMessage,
-            projectName: String(this.sitePagesProject.name),
-            dependsOn: this.siteDeploymentDependsOn,
-        });
-    }
-}

package/dist/src/lib/cloudflare/construct/pages-static-site/types.d.ts

@@ -1,11 +0,0 @@
-import { CommonCloudflareStackProps } from '../../common/index.js';
-import { PagesProjectProps, DnsRecordProps, ZoneProps } from '../../services/index.js';
-export interface CloudflarePagesStaticSiteProps extends CommonCloudflareStackProps {
-    siteAssetDir: string;
-    siteBranch?: string;
-    siteCnameRecord: DnsRecordProps;
-    siteDeployMessage: string;
-    sitePagesProject: PagesProjectProps;
-    siteSubDomain: string;
-    siteZone: ZoneProps;
-}

package/dist/src/lib/cloudflare/construct/pages-static-site/types.js

@@ -1 +0,0 @@
-export {};

package/dist/src/lib/cloudflare/construct/worker-site/index.d.ts

@@ -1,2 +0,0 @@
-export * from './main.js';
-export * from './types.js';

package/dist/src/lib/cloudflare/construct/worker-site/index.js

@@ -1,2 +0,0 @@
-export * from './main.js';
-export * from './types.js';

package/dist/src/lib/cloudflare/construct/worker-site/main.d.ts

@@ -1,76 +0,0 @@
-import { Ruleset, WorkersCustomDomain, WorkersScript, Zone, ZoneSetting } from '@pulumi/cloudflare';
-import { WorkersScriptBinding } from '@pulumi/cloudflare/types/input.js';
-import { ComponentResourceOptions } from '@pulumi/pulumi';
-import * as std from '@pulumi/std';
-import { CommonCloudflareConstruct } from '../../common/index.js';
-import { CloudflareWorkerSiteProps } from './types.js';
-/**
- * @classdesc Provides a construct to create and deploy a cloudflare worker site
- * @example
- * import { CloudflareWorkerSite, CloudflareWorkerSiteProps } '@gradientedge/cdk-utils'
- * import { Construct } from 'constructs'
- *
- * class CustomConstruct extends CloudflareWorkerSite {
- *   constructor(parent: Construct, id: string, props: CloudflareWorkerSiteProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.id = id
- *     this.initResources()
- *   }
- * }
- */
-export declare class CloudflareWorkerSite extends CommonCloudflareConstruct {
-    props: CloudflareWorkerSiteProps;
-    siteZone: Zone;
-    siteWorkerScript: WorkersScript;
-    siteWorkerDomain: WorkersCustomDomain;
-    siteRuleSet: Ruleset;
-    siteZoneSetting: ZoneSetting;
-    workerPlainTextBindingEnvironmentVariables: WorkersScriptBinding[];
-    workerSecretTextBindingEnvironmentVariables: WorkersScriptBinding[];
-    constructor(id: string, props: CloudflareWorkerSiteProps, options?: ComponentResourceOptions);
-    /**
-     * @summary Initialise and provision resources
-     */
-    protected initResources(): void;
-    /**
-     * @summary Resolve the zone to use for the worker site
-     */
-    protected resolveZone(): void;
-    /**
-     * @summary Resolve the environment variables to use for the static site
-     */
-    protected resolveEnvironmentVariables(): void;
-    /**
-     * @summary Create the worker
-     */
-    protected createWorker(): void;
-    /**
-     * @summary Create the worker domain
-     */
-    protected createWorkerDomain(): void;
-    /**
-     * @summary Resolve secrets from AWS Secrets Manager
-     * @param secretName the secret name
-     * @param secretKey the secret key
-     * @returns the secret value
-     */
-    protected resolveSecretFromAWS(secretName: string, secretKey: string): import("@pulumi/pulumi").Output<std.JsondecodeResult> | undefined;
-    /**
-     * @summary Resolve secrets from Azure Key Vault
-     *
-     * @param resourceGroupName the resource group name where the key vault is located
-     * @param keyVaultName the key vault name
-     * @param secretKey the secret key
-     * @returns the secret value
-     */
-    protected resolveSecretFromAzure(resourceGroupName: string, keyVaultName: string, secretKey: string): import("@pulumi/pulumi").OutputInstance<string | undefined> | undefined;
-    /**
-     * @summary Create the rules
-     */
-    protected createRuleset(): void;
-    /**
-     * @summary Create zone settings override
-     */
-    protected createZoneSetting(): void;
-}

package/dist/src/lib/cloudflare/construct/worker-site/main.js

@@ -1,139 +0,0 @@
-import * as aws from '@pulumi/aws';
-import * as azure from '@pulumi/azure-native';
-import * as std from '@pulumi/std';
-import fs from 'fs';
-import { CommonCloudflareConstruct } from '../../common/index.js';
-/**
- * @classdesc Provides a construct to create and deploy a cloudflare worker site
- * @example
- * import { CloudflareWorkerSite, CloudflareWorkerSiteProps } '@gradientedge/cdk-utils'
- * import { Construct } from 'constructs'
- *
- * class CustomConstruct extends CloudflareWorkerSite {
- *   constructor(parent: Construct, id: string, props: CloudflareWorkerSiteProps) {
- *     super(parent, id, props)
- *     this.props = props
- *     this.id = id
- *     this.initResources()
- *   }
- * }
- */
-export class CloudflareWorkerSite extends CommonCloudflareConstruct {
-    /* worker site resources */
-    siteZone;
-    siteWorkerScript;
-    siteWorkerDomain;
-    siteRuleSet;
-    siteZoneSetting;
-    workerPlainTextBindingEnvironmentVariables = [];
-    workerSecretTextBindingEnvironmentVariables = [];
-    constructor(id, props, options) {
-        super(id, props);
-        this.props = props;
-        this.options = options;
-        this.id = id;
-    }
-    /**
-     * @summary Initialise and provision resources
-     */
-    initResources() {
-        this.resolveZone();
-        this.resolveEnvironmentVariables();
-        this.createWorker();
-        this.createWorkerDomain();
-        this.createRuleset();
-        this.createZoneSetting();
-    }
-    /**
-     * @summary Resolve the zone to use for the worker site
-     */
-    resolveZone() {
-        if (this.props.useExistingZone) {
-            this.siteZone = this.zoneManager.resolveZone(`${this.id}-zone`, this);
-        }
-        else {
-            this.siteZone = this.zoneManager.createZone(`${this.id}-zone`, this, this.props.siteZone);
-        }
-    }
-    /**
-     * @summary Resolve the environment variables to use for the static site
-     */
-    resolveEnvironmentVariables() {
-        this.props.siteWorkerScript = {
-            ...this.props.siteWorkerScript,
-            bindings: this.workerPlainTextBindingEnvironmentVariables.concat(this.workerSecretTextBindingEnvironmentVariables),
-        };
-    }
-    /**
-     * @summary Create the worker
-     */
-    createWorker() {
-        const workerContent = fs.readFileSync(this.props.siteWorkerAsset, 'utf-8');
-        this.siteWorkerScript = this.workerManager.createWorkerScript(`${this.id}-worker-script`, this, {
-            ...this.props.siteWorkerScript,
-            content: workerContent,
-        });
-    }
-    /**
-     * @summary Create the worker domain
-     */
-    createWorkerDomain() {
-        this.siteWorkerDomain = this.workerManager.createWorkerDomain(`${this.id}-worker-domain`, this, {
-            ...this.props.siteWorkerDomain,
-            environment: this.props.siteWorkerDomain.environment ?? 'production',
-            hostname: `${this.props.siteSubDomain}.${this.props.domainName}`,
-            service: this.siteWorkerScript.scriptName,
-        });
-    }
-    /**
-     * @summary Resolve secrets from AWS Secrets Manager
-     * @param secretName the secret name
-     * @param secretKey the secret key
-     * @returns the secret value
-     */
-    resolveSecretFromAWS(secretName, secretKey) {
-        if (this.config.require('secretsProvider') !== 'aws')
-            return;
-        const secret = aws.secretsmanager.getSecretOutput({ name: secretName });
-        const secretVersion = aws.secretsmanager.getSecretVersionOutput({ secretId: secret.id });
-        if (!secretVersion)
-            throw new Error(`Unable to resolve secret:${secretName}`);
-        return std.jsondecodeOutput({ input: secretVersion.secretString });
-    }
-    /**
-     * @summary Resolve secrets from Azure Key Vault
-     *
-     * @param resourceGroupName the resource group name where the key vault is located
-     * @param keyVaultName the key vault name
-     * @param secretKey the secret key
-     * @returns the secret value
-     */
-    resolveSecretFromAzure(resourceGroupName, keyVaultName, secretKey) {
-        if (this.config.require('secretsProvider') !== 'azure')
-            return;
-        const secretValueData = azure.keyvault.getSecretOutput({
-            resourceGroupName,
-            secretName: secretKey,
-            vaultName: keyVaultName,
-        });
-        if (!secretValueData)
-            throw new Error(`Unable to resolve secret:${secretKey}`);
-        return secretValueData.properties?.value;
-    }
-    /**
-     * @summary Create the rules
-     */
-    createRuleset() {
-        if (!this.props.siteRuleSet)
-            return;
-        this.siteRuleSet = this.ruleSetManager.createRuleSet(`${this.id}-rule`, this, this.props.siteRuleSet);
-    }
-    /**
-     * @summary Create zone settings override
-     */
-    createZoneSetting() {
-        if (!this.props.siteZoneSetting)
-            return;
-        this.siteZoneSetting = this.zoneManager.createZoneSetting(`${this.id}-zone-setting`, this, this.props.siteZoneSetting);
-    }
-}

package/dist/src/lib/cloudflare/construct/worker-site/types.d.ts

@@ -1,11 +0,0 @@
-import { CommonCloudflareStackProps } from '../../common/index.js';
-import { WorkerDomainProps, WorkerScriptProps, RulesetProps, ZoneProps, ZoneSettingProps } from '../../services/index.js';
-export interface CloudflareWorkerSiteProps extends CommonCloudflareStackProps {
-    siteSubDomain: string;
-    siteZone: ZoneProps;
-    siteWorkerScript: WorkerScriptProps;
-    siteWorkerDomain: WorkerDomainProps;
-    siteWorkerAsset: string;
-    siteRuleSet: RulesetProps;
-    siteZoneSetting: ZoneSettingProps;
-}

package/dist/src/lib/cloudflare/construct/worker-site/types.js

@@ -1 +0,0 @@
-export {};

package/dist/src/lib/cloudflare/index.d.ts

@@ -1,4 +0,0 @@
-export * from './common/index.js';
-export * from './construct/index.js';
-export * from './services/index.js';
-export * from './types/index.js';

package/dist/src/lib/cloudflare/index.js

@@ -1,4 +0,0 @@
-export * from './common/index.js';
-export * from './construct/index.js';
-export * from './services/index.js';
-export * from './types/index.js';

package/dist/src/lib/cloudflare/services/access/index.d.ts

@@ -1,2 +0,0 @@
-export * from './main.js';
-export * from './types.js';

package/dist/src/lib/cloudflare/services/access/index.js

@@ -1,2 +0,0 @@
-export * from './main.js';
-export * from './types.js';

package/dist/src/lib/cloudflare/services/access/main.d.ts

@@ -1,108 +0,0 @@
-import { CommonCloudflareConstruct } from '../../common/construct.js';
-import { AccessRuleProps, ZeroTrustAccessApplicationProps, ZeroTrustAccessCustomPageProps, ZeroTrustAccessGroupProps, ZeroTrustAccessIdentityProviderProps, ZeroTrustAccessMtlsCertificateProps, ZeroTrustAccessPolicyProps, ZeroTrustAccessServiceTokenProps, ZeroTrustAccessShortLivedCertificateProps, ZeroTrustAccessTagProps, ZeroTrustOrganizationProps } from './types.js';
-/**
- * @classdesc Provides operations on Cloudflare Access
- * - A new instance of this class is injected into {@link CommonCloudflareComponent} constructor.
- * - If a custom component extends {@link CommonCloudflareComponent}, an instance is available within the context.
- * @example
- * ```
- * import { CommonCloudflareComponent, CloudflareAccessManager } from '@gradientedge/cdk-utils'
- *
- * class CustomComponent extends CommonCloudflareComponent {
- *   constructor(name: string, args: any, opts?: pulumi.ComponentResourceOptions) {
- *     super(name, args, opts)
- *     this.accessManager.createAccessApplication('MyAppAccess', this, props)
- *   }
- * }
- * ```
- */
-export declare class CloudflareAccessManager {
-    /**
-     * @summary Method to create a new Cloudflare Application Access
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props access application properties
-     * @see [Pulumi Cloudflare Access Application]{@link https://www.pulumi.com/registry/packages/cloudflare/api-docs/zerotrustaccessapplication/}
-     */
-    createAccessApplication(id: string, scope: CommonCloudflareConstruct, props: ZeroTrustAccessApplicationProps): import("@pulumi/cloudflare/zeroTrustAccessApplication.js").ZeroTrustAccessApplication;
-    /**
-     * @summary Method to create a new Cloudflare Application Access Short Lived Certificate
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props access short lived certificate properties
-     * @see [Pulumi Cloudflare Access Short Lived Certificate]{@link https://www.pulumi.com/registry/packages/cloudflare/api-docs/zerotrustaccessshortlivedcertificate/}
-     */
-    createAccessShortLivedCertificate(id: string, scope: CommonCloudflareConstruct, props: ZeroTrustAccessShortLivedCertificateProps): import("@pulumi/cloudflare/zeroTrustAccessShortLivedCertificate.js").ZeroTrustAccessShortLivedCertificate;
-    /**
-     * @summary Method to create a new Cloudflare Application Access Custom Page
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props access custom page properties
-     * @see [Pulumi Cloudflare Access Custom Page]{@link https://www.pulumi.com/registry/packages/cloudflare/api-docs/zerotrustaccesscustompage/}
-     */
-    createAccessCustomPage(id: string, scope: CommonCloudflareConstruct, props: ZeroTrustAccessCustomPageProps): import("@pulumi/cloudflare/zeroTrustAccessCustomPage.js").ZeroTrustAccessCustomPage;
-    /**
-     * @summary Method to create a new Cloudflare Application Access Group
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props access group properties
-     * @see [Pulumi Cloudflare Access Group]{@link https://www.pulumi.com/registry/packages/cloudflare/api-docs/zerotrustaccessgroup/}
-     */
-    createAccessGroup(id: string, scope: CommonCloudflareConstruct, props: ZeroTrustAccessGroupProps): import("@pulumi/cloudflare/zeroTrustAccessGroup.js").ZeroTrustAccessGroup;
-    /**
-     * @summary Method to create a new Cloudflare Application Access Identity Provider
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props access identity provider properties
-     * @see [Pulumi Cloudflare Access Identity Provider]{@link https://www.pulumi.com/registry/packages/cloudflare/api-docs/zerotrustaccessidentityprovider/}
-     */
-    createAccessIdentityProvider(id: string, scope: CommonCloudflareConstruct, props: ZeroTrustAccessIdentityProviderProps): import("@pulumi/cloudflare/zeroTrustAccessIdentityProvider.js").ZeroTrustAccessIdentityProvider;
-    /**
-     * @summary Method to create a new Cloudflare Application Access Mutual Tls Certificate
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props access mutual tls certificate properties
-     * @see [Pulumi Cloudflare Access Mutual Tls Certificate]{@link https://www.pulumi.com/registry/packages/cloudflare/api-docs/zerotrustaccessmtlscertificate/}
-     */
-    createAccessMutualTlsCertificate(id: string, scope: CommonCloudflareConstruct, props: ZeroTrustAccessMtlsCertificateProps): import("@pulumi/cloudflare/zeroTrustAccessMtlsCertificate.js").ZeroTrustAccessMtlsCertificate;
-    /**
-     * @summary Method to create a new Cloudflare Application Access Organisation
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props access organisation properties
-     * @see [Pulumi Cloudflare Zero Trust Organization]{@link https://www.pulumi.com/registry/packages/cloudflare/api-docs/zerotrustorganization/}
-     */
-    createAccessOrganization(id: string, scope: CommonCloudflareConstruct, props: ZeroTrustOrganizationProps): import("@pulumi/cloudflare/zeroTrustOrganization.js").ZeroTrustOrganization;
-    /**
-     * @summary Method to create a new Cloudflare Application Access Policy
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props access policy properties
-     * @see [Pulumi Cloudflare Access Policy]{@link https://www.pulumi.com/registry/packages/cloudflare/api-docs/zerotrustaccesspolicy/}
-     */
-    createAccessPolicy(id: string, scope: CommonCloudflareConstruct, props: ZeroTrustAccessPolicyProps): import("@pulumi/cloudflare/zeroTrustAccessPolicy.js").ZeroTrustAccessPolicy;
-    /**
-     * @summary Method to create a new Cloudflare Application Access Rule
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props access rule properties
-     * @see [Pulumi Cloudflare Access Rule]{@link https://www.pulumi.com/registry/packages/cloudflare/api-docs/accessrule/}
-     */
-    createAccessRule(id: string, scope: CommonCloudflareConstruct, props: AccessRuleProps): import("@pulumi/cloudflare/accessRule.js").AccessRule;
-    /**
-     * @summary Method to create a new Cloudflare Application Access Service Token
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props access service token properties
-     * @see [Pulumi Cloudflare Access Service Token]{@link https://www.pulumi.com/registry/packages/cloudflare/api-docs/zerotrustaccessservicetoken/}
-     */
-    createAccessServiceToken(id: string, scope: CommonCloudflareConstruct, props: ZeroTrustAccessServiceTokenProps): import("@pulumi/cloudflare/zeroTrustAccessServiceToken.js").ZeroTrustAccessServiceToken;
-    /**
-     * @summary Method to create a new Cloudflare Application Access Tag
-     * @param id scoped id of the resource
-     * @param scope scope in which this resource is defined
-     * @param props access tag properties
-     * @see [Pulumi Cloudflare Access Tag]{@link https://www.pulumi.com/registry/packages/cloudflare/api-docs/zerotrustaccesstag/}
-     */
-    createAccessTag(id: string, scope: CommonCloudflareConstruct, props: ZeroTrustAccessTagProps): import("@pulumi/cloudflare/zeroTrustAccessTag.js").ZeroTrustAccessTag;
-}