@remotion/cloudrun 4.1.0-alpha10

package/dist/api/get-or-create-bucket.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOrCreateBucket = void 0;
+const constants_1 = require("../shared/constants");
+const validate_bucketname_1 = require("../shared/validate-bucketname");
+const create_bucket_1 = require("./create-bucket");
+const get_buckets_1 = require("./get-buckets");
+/**
+ * @description Creates a bucket for Remotion Cloud Run in your GCP Project, in a particular region. If one already exists, it will get returned instead.
+ * @link https://remotion.dev/docs/cloudrun/getorcreatebucket
+ * @param params.region The region in which you want your Storage bucket to reside in.
+ * @param params.updateBucketState A function that gets called whenever the state of the bucket changes. This is useful for CLI updates.
+ * @returns {Promise<GetOrCreateBucketOutput>} An object containing the `bucketName`.
+ */
+const getOrCreateBucket = async (params) => {
+    var _a, _b, _c;
+    const { remotionBuckets } = await (0, get_buckets_1.getRemotionStorageBuckets)(params.region);
+    if (remotionBuckets.length > 1) {
+        throw new Error(`You have multiple buckets (${remotionBuckets
+            .map((b) => b.name)
+            .join(', ')}) in your Cloud Storage region (${params.region}) starting with "${constants_1.REMOTION_BUCKET_PREFIX}". This is an error, please delete buckets so that you have one maximum.`);
+    }
+    if (remotionBuckets.length === 1) {
+        (_a = params === null || params === void 0 ? void 0 : params.updateBucketState) === null || _a === void 0 ? void 0 : _a.call(params, 'Using existing bucket');
+        return {
+            bucketName: remotionBuckets[0].name,
+            alreadyExisted: true,
+        };
+    }
+    if (params === null || params === void 0 ? void 0 : params.region) {
+        (_b = params.updateBucketState) === null || _b === void 0 ? void 0 : _b.call(params, 'Creating new bucket');
+        const bucketName = (0, validate_bucketname_1.makeBucketName)();
+        await (0, create_bucket_1.createBucket)({
+            bucketName,
+            region: params.region,
+        });
+        (_c = params.updateBucketState) === null || _c === void 0 ? void 0 : _c.call(params, 'Created bucket');
+        return { bucketName, alreadyExisted: false };
+    }
+    throw new Error('Bucket creation is required, but no region has been passed.');
+};
+exports.getOrCreateBucket = getOrCreateBucket;

package/dist/api/get-regions.d.ts

@@ -0,0 +1,7 @@
+import type { GcpRegion } from '../pricing/gcp-regions';
+/**
+ * @description Gets an array of all supported GCP regions of this release of Remotion Cloudrun.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getregions)
+ * @returns {GcpRegion[]} A list of GCP regions.
+ */
+export declare const getRegions: () => readonly GcpRegion[];

package/dist/api/get-regions.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRegions = void 0;
+const regions_1 = require("../regions");
+/**
+ * @description Gets an array of all supported GCP regions of this release of Remotion Cloudrun.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getregions)
+ * @returns {GcpRegion[]} A list of GCP regions.
+ */
+const getRegions = () => {
+    return regions_1.GCP_REGIONS;
+};
+exports.getRegions = getRegions;

package/dist/api/get-service-info.d.ts

@@ -0,0 +1,23 @@
+import type { GcpRegion } from '../pricing/gcp-regions';
+export declare type ServiceInfo = {
+    serviceName: string;
+    timeoutInSeconds: number;
+    memoryLimit: string;
+    cpuLimit: string;
+    remotionVersion: string | null;
+    uri: string;
+    region: GcpRegion;
+    consoleUrl: string;
+};
+export declare type GetServiceInfoInput = {
+    region: GcpRegion;
+    serviceName: string;
+};
+/**
+ * @description Given a region and service name, returns information about the service such as version, memory limit and timeout.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getserviceinfo)
+ * @param params.region The region in which the service resides in.
+ * @param params.serviceName The name of the service.
+ * @returns {Promise<ServiceInfo[]>} An array with the objects containing information about the deployed services.
+ */
+export declare const getServiceInfo: ({ region, serviceName, }: GetServiceInfoInput) => Promise<ServiceInfo>;

package/dist/api/get-service-info.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getServiceInfo = void 0;
+const get_cloud_run_client_1 = require("./helpers/get-cloud-run-client");
+const parse_service_name_1 = require("./helpers/parse-service-name");
+/**
+ * @description Given a region and service name, returns information about the service such as version, memory limit and timeout.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getserviceinfo)
+ * @param params.region The region in which the service resides in.
+ * @param params.serviceName The name of the service.
+ * @returns {Promise<ServiceInfo[]>} An array with the objects containing information about the deployed services.
+ */
+const getServiceInfo = async ({ region, serviceName, }) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    const cloudRunClient = (0, get_cloud_run_client_1.getCloudRunClient)();
+    const [service] = await cloudRunClient.getService({
+        name: `projects/${process.env.REMOTION_GCP_PROJECT_ID}/locations/${region}/services/${serviceName}`,
+    });
+    if (!service) {
+        throw new Error(`Service ${serviceName} not found`);
+    }
+    const { region: deployedRegion, remotionVersion, serviceName: deployedServiceName, } = (0, parse_service_name_1.parseServiceName)(service.name, region);
+    return {
+        serviceName: deployedServiceName,
+        timeoutInSeconds: (_b = (_a = service.template) === null || _a === void 0 ? void 0 : _a.timeout) === null || _b === void 0 ? void 0 : _b.seconds,
+        memoryLimit: (_f = (_e = (_d = (_c = service.template) === null || _c === void 0 ? void 0 : _c.containers) === null || _d === void 0 ? void 0 : _d[0].resources) === null || _e === void 0 ? void 0 : _e.limits) === null || _f === void 0 ? void 0 : _f.memory,
+        cpuLimit: (_k = (_j = (_h = (_g = service.template) === null || _g === void 0 ? void 0 : _g.containers) === null || _h === void 0 ? void 0 : _h[0].resources) === null || _j === void 0 ? void 0 : _j.limits) === null || _k === void 0 ? void 0 : _k.cpu,
+        remotionVersion,
+        uri: service.uri,
+        region: deployedRegion,
+        consoleUrl: `https://console.cloud.google.com/run/detail/${deployedRegion}/${deployedServiceName}/logs`,
+    };
+};
+exports.getServiceInfo = getServiceInfo;

package/dist/api/get-services.d.ts

@@ -0,0 +1,14 @@
+import type { GcpRegion } from '../pricing/gcp-regions';
+import type { ServiceInfo } from './get-service-info';
+export declare type GetServicesInput = {
+    region: GcpRegion;
+    compatibleOnly: boolean;
+};
+/**
+ * @description Lists Remotion Cloud Run render services deployed to GCP Cloud Run.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getservices)
+ * @param params.region The region of which the services should be listed.
+ * @param params.compatibleOnly Whether only services compatible with the installed version of Remotion Cloud Run should be returned.
+ * @returns {Promise<ServiceInfo[]>} An array with the objects containing information about the deployed services.
+ */
+export declare const getServices: (params: GetServicesInput) => Promise<ServiceInfo[]>;

package/dist/api/get-services.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getServices = void 0;
+const constants_1 = require("../shared/constants");
+const service_version_string_1 = require("../shared/service-version-string");
+const get_cloud_run_client_1 = require("./helpers/get-cloud-run-client");
+const parse_service_name_1 = require("./helpers/parse-service-name");
+/**
+ * @description Lists Remotion Cloud Run render services deployed to GCP Cloud Run.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getservices)
+ * @param params.region The region of which the services should be listed.
+ * @param params.compatibleOnly Whether only services compatible with the installed version of Remotion Cloud Run should be returned.
+ * @returns {Promise<ServiceInfo[]>} An array with the objects containing information about the deployed services.
+ */
+const getServices = async (params) => {
+    const cloudRunClient = (0, get_cloud_run_client_1.getCloudRunClient)();
+    const parent = (0, parse_service_name_1.getGcpParent)(params.region);
+    const [services] = await cloudRunClient.listServices({
+        parent,
+    });
+    let remotionServices = [];
+    if (params.compatibleOnly) {
+        remotionServices = services.filter((s) => {
+            var _a;
+            return (_a = s.name) === null || _a === void 0 ? void 0 : _a.startsWith(`${parent}/services/${constants_1.RENDER_SERVICE_PREFIX}-${(0, service_version_string_1.serviceVersionString)()}-`);
+        });
+    }
+    else {
+        remotionServices = services.filter((s) => {
+            var _a;
+            return (_a = s.name) === null || _a === void 0 ? void 0 : _a.startsWith(`${parent}/services/${constants_1.RENDER_SERVICE_PREFIX}-`);
+        });
+    }
+    return remotionServices.map((service) => {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        const { consoleUrl, region, remotionVersion, serviceName } = (0, parse_service_name_1.parseServiceName)(service.name, params.region);
+        return {
+            consoleUrl,
+            region,
+            remotionVersion,
+            serviceName,
+            timeoutInSeconds: (_b = (_a = service.template) === null || _a === void 0 ? void 0 : _a.timeout) === null || _b === void 0 ? void 0 : _b.seconds,
+            memoryLimit: (_f = (_e = (_d = (_c = service.template) === null || _c === void 0 ? void 0 : _c.containers) === null || _d === void 0 ? void 0 : _d[0].resources) === null || _e === void 0 ? void 0 : _e.limits) === null || _f === void 0 ? void 0 : _f.memory,
+            cpuLimit: (_k = (_j = (_h = (_g = service.template) === null || _g === void 0 ? void 0 : _g.containers) === null || _h === void 0 ? void 0 : _h[0].resources) === null || _j === void 0 ? void 0 : _j.limits) === null || _k === void 0 ? void 0 : _k.cpu,
+            uri: service.uri,
+        };
+    });
+};
+exports.getServices = getServices;

package/dist/api/get-sites.d.ts

@@ -0,0 +1,23 @@
+import type { GcpRegion } from '../pricing/gcp-regions';
+export declare type Site = {
+    bucketName: string;
+    id: string;
+    serveUrl: string;
+    bucketRegion: GcpRegion;
+};
+export declare type BucketWithLocation = {
+    name: string;
+    creationDate: number;
+    region: GcpRegion;
+};
+export declare type GetSitesOutput = {
+    sites: Site[];
+    buckets: BucketWithLocation[];
+};
+/**
+ * @description Gets all the deployed sites for a certain GCP project, within the specified region.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getsites)
+ * @param {GcpRegion} params.region The GCP region that you want to query for.
+ * @returns {Promise<GetSitesOutput>} A Promise containing an object with `sites` and `bucket` keys. Consult documentation for details.
+ */
+export declare const getSites: (region: GcpRegion | 'all regions') => Promise<GetSitesOutput>;

package/dist/api/get-sites.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSites = void 0;
+const constants_1 = require("../shared/constants");
+const get_cloud_storage_client_1 = require("./helpers/get-cloud-storage-client");
+/**
+ * @description Gets all the deployed sites for a certain GCP project, within the specified region.
+ * @see [Documentation](https://remotion.dev/docs/cloudrun/getsites)
+ * @param {GcpRegion} params.region The GCP region that you want to query for.
+ * @returns {Promise<GetSitesOutput>} A Promise containing an object with `sites` and `bucket` keys. Consult documentation for details.
+ */
+const getSites = async (region) => {
+    var _a, _b;
+    const cloudStorageClient = (0, get_cloud_storage_client_1.getCloudStorageClient)();
+    const buckets = [];
+    const sites = [];
+    const [fetchedBuckets] = await cloudStorageClient.getBuckets();
+    for (const bucket of fetchedBuckets) {
+        if (((_a = bucket.name) === null || _a === void 0 ? void 0 : _a.startsWith(constants_1.REMOTION_BUCKET_PREFIX)) &&
+            (region === 'all regions' ||
+                bucket.metadata.location === region.toUpperCase())) {
+            const bucketObject = {
+                name: bucket.name,
+                creationDate: new Date((_b = bucket.metadata) === null || _b === void 0 ? void 0 : _b.timeCreated).getTime(),
+                region: bucket.metadata.location.toLowerCase(),
+            };
+            buckets.push(bucketObject);
+        }
+    }
+    for (const bucket of buckets) {
+        const [, , apiResponse] = await cloudStorageClient
+            .bucket(bucket.name)
+            .getFiles({ autoPaginate: false, delimiter: '/', prefix: 'sites/' });
+        if (!apiResponse.prefixes) {
+            continue; // no sites folder within bucket
+        }
+        for (const prefix of apiResponse.prefixes) {
+            const sitePath = prefix.split('/');
+            sites.push({
+                bucketName: bucket.name,
+                id: sitePath[1],
+                serveUrl: `https://storage.googleapis.com/${bucket.name}/${prefix}index.html`,
+                bucketRegion: bucket.region,
+            });
+        }
+    }
+    return { sites, buckets };
+};
+exports.getSites = getSites;

package/dist/api/helpers/IService.d.ts

@@ -0,0 +1,2 @@
+import type { protos } from '@google-cloud/run';
+export declare type IService = protos.google.cloud.run.v2.IService;

package/dist/api/helpers/IService.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/api/helpers/construct-service-deploy-request.d.ts

@@ -0,0 +1,32 @@
+declare enum ExecutionEnvironment {
+    EXECUTION_ENVIRONMENT_UNSPECIFIED = 0,
+    EXECUTION_ENVIRONMENT_GEN1 = 1,
+    EXECUTION_ENVIRONMENT_GEN2 = 2
+}
+export declare const constructServiceTemplate: ({ memoryLimit, cpuLimit, timeoutSeconds, minInstances, maxInstances, }: {
+    memoryLimit: string;
+    cpuLimit: string;
+    timeoutSeconds: number;
+    minInstances: number;
+    maxInstances: number;
+}) => {
+    scaling: {
+        minInstanceCount: number;
+        maxInstanceCount: number;
+    };
+    timeout: {
+        seconds: number;
+    };
+    containers: {
+        image: string;
+        resources: {
+            limits: {
+                memory: string;
+                cpu: string;
+            };
+        };
+    }[];
+    maxInstanceRequestConcurrency: number;
+    executionEnvironment: ExecutionEnvironment;
+};
+export {};

package/dist/api/helpers/construct-service-deploy-request.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.constructServiceTemplate = void 0;
+const version_1 = require("remotion/version");
+// taken from within the @google-cloud/run package, can't import it directly
+var ExecutionEnvironment;
+(function (ExecutionEnvironment) {
+    ExecutionEnvironment[ExecutionEnvironment["EXECUTION_ENVIRONMENT_UNSPECIFIED"] = 0] = "EXECUTION_ENVIRONMENT_UNSPECIFIED";
+    ExecutionEnvironment[ExecutionEnvironment["EXECUTION_ENVIRONMENT_GEN1"] = 1] = "EXECUTION_ENVIRONMENT_GEN1";
+    ExecutionEnvironment[ExecutionEnvironment["EXECUTION_ENVIRONMENT_GEN2"] = 2] = "EXECUTION_ENVIRONMENT_GEN2";
+})(ExecutionEnvironment || (ExecutionEnvironment = {}));
+const constructServiceTemplate = ({ memoryLimit, cpuLimit, timeoutSeconds, minInstances, maxInstances, }) => {
+    return {
+        scaling: {
+            minInstanceCount: minInstances,
+            maxInstanceCount: maxInstances,
+        },
+        timeout: {
+            seconds: timeoutSeconds,
+        },
+        containers: [
+            {
+                image: `us-docker.pkg.dev/remotion-dev/production/render:${version_1.VERSION}`,
+                resources: {
+                    limits: {
+                        memory: memoryLimit,
+                        cpu: cpuLimit,
+                    },
+                },
+            },
+        ],
+        maxInstanceRequestConcurrency: 1,
+        executionEnvironment: ExecutionEnvironment.EXECUTION_ENVIRONMENT_GEN1,
+    };
+};
+exports.constructServiceTemplate = constructServiceTemplate;

package/dist/api/helpers/extract-mem-from-url.d.ts

@@ -0,0 +1 @@
+export declare function extractMemoryFromURL(url: string): string | undefined;

package/dist/api/helpers/extract-mem-from-url.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractMemoryFromURL = void 0;
+function extractMemoryFromURL(url) {
+    const regex = /mem(.*?)-/;
+    const match = url.match(regex);
+    return match ? match[1] : undefined;
+}
+exports.extractMemoryFromURL = extractMemoryFromURL;

package/dist/api/helpers/extract-time-from-url.d.ts

@@ -0,0 +1 @@
+export declare function extractTimeoutFromURL(url: string): number | undefined;

package/dist/api/helpers/extract-time-from-url.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractTimeoutFromURL = void 0;
+function extractTimeoutFromURL(url) {
+    const firstTIndex = url.indexOf('-t');
+    if (firstTIndex !== -1) {
+        const substrAfterT = url.substring(firstTIndex + 2);
+        const numberStr = substrAfterT.split('-')[0];
+        return parseInt(numberStr, 10);
+    }
+    return undefined;
+}
+exports.extractTimeoutFromURL = extractTimeoutFromURL;

package/dist/api/helpers/get-auth-client-for-url.d.ts

@@ -0,0 +1 @@
+export declare const getAuthClientForUrl: (url: string) => Promise<import("google-auth-library").IdTokenClient>;

package/dist/api/helpers/get-auth-client-for-url.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAuthClientForUrl = void 0;
+const google_auth_library_1 = require("google-auth-library");
+const getAuthClientForUrl = async (url) => {
+    const auth = new google_auth_library_1.GoogleAuth({
+        credentials: {
+            client_email: process.env.REMOTION_GCP_CLIENT_EMAIL,
+            private_key: process.env.REMOTION_GCP_PRIVATE_KEY,
+        },
+    });
+    const client = await auth.getIdTokenClient(url);
+    return client;
+};
+exports.getAuthClientForUrl = getAuthClientForUrl;

package/dist/api/helpers/get-cloud-logging-client.d.ts

@@ -0,0 +1 @@
+export declare const getCloudLoggingClient: () => any;

package/dist/api/helpers/get-cloud-logging-client.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCloudLoggingClient = void 0;
+const logging_1 = require("@google-cloud/logging");
+const { LoggingServiceV2Client } = logging_1.v2;
+const getCloudLoggingClient = () => {
+    return new LoggingServiceV2Client({
+        projectId: process.env.REMOTION_GCP_PROJECT_ID,
+        credentials: {
+            client_email: process.env.REMOTION_GCP_CLIENT_EMAIL,
+            private_key: process.env.REMOTION_GCP_PRIVATE_KEY,
+        },
+    });
+};
+exports.getCloudLoggingClient = getCloudLoggingClient;

package/dist/api/helpers/get-cloud-run-client.d.ts

@@ -0,0 +1,2 @@
+import { v2 } from '@google-cloud/run';
+export declare const getCloudRunClient: () => v2.ServicesClient;

package/dist/api/helpers/get-cloud-run-client.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCloudRunClient = void 0;
+const run_1 = require("@google-cloud/run");
+const { ServicesClient } = run_1.v2;
+const getCloudRunClient = () => {
+    return new ServicesClient({
+        projectId: process.env.REMOTION_GCP_PROJECT_ID,
+        credentials: {
+            client_email: process.env.REMOTION_GCP_CLIENT_EMAIL,
+            private_key: process.env.REMOTION_GCP_PRIVATE_KEY,
+        },
+    });
+};
+exports.getCloudRunClient = getCloudRunClient;

package/dist/api/helpers/get-cloud-storage-client.d.ts

@@ -0,0 +1,2 @@
+import { Storage } from '@google-cloud/storage';
+export declare const getCloudStorageClient: () => Storage;

package/dist/api/helpers/get-cloud-storage-client.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCloudStorageClient = void 0;
+const storage_1 = require("@google-cloud/storage");
+const getCloudStorageClient = () => {
+    return new storage_1.Storage({
+        projectId: process.env.REMOTION_GCP_PROJECT_ID,
+        credentials: {
+            client_email: process.env.REMOTION_GCP_CLIENT_EMAIL,
+            private_key: process.env.REMOTION_GCP_PRIVATE_KEY,
+        },
+    });
+};
+exports.getCloudStorageClient = getCloudStorageClient;

package/dist/api/helpers/get-cloudrun-endpoint.d.ts

@@ -0,0 +1,14 @@
+export declare type getCloudrunEndpointInput = {
+    cloudRunUrl?: string;
+    serviceName?: string;
+    region?: string;
+};
+/**
+ * @description If the Cloud Run URL is passed, it will be validated and returned. If the service name is passed, the service will be looked up and the endpoint will be returned.
+ * @see [Documentation](https://remotion.dev/docs/lambda/renderMediaOnGcp)
+ * @param params.cloudRunUrl The url of the Cloud Run service
+ * @param params.serviceName The name of the Cloud Run service
+ * @param params.region The region of the service - required if the serviceName is passed.
+ * @returns {Promise<string>} Returns the endpoint of the Cloud Run service
+ */
+export declare const getCloudrunEndpoint: ({ cloudRunUrl, serviceName, region, }: getCloudrunEndpointInput) => Promise<string>;

package/dist/api/helpers/get-cloudrun-endpoint.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCloudrunEndpoint = void 0;
+const validate_cloudrun_url_1 = require("../../shared/validate-cloudrun-url");
+const validate_region_1 = require("../../shared/validate-region");
+const validate_service_name_1 = require("../../shared/validate-service-name");
+const get_service_info_1 = require("../get-service-info");
+/**
+ * @description If the Cloud Run URL is passed, it will be validated and returned. If the service name is passed, the service will be looked up and the endpoint will be returned.
+ * @see [Documentation](https://remotion.dev/docs/lambda/renderMediaOnGcp)
+ * @param params.cloudRunUrl The url of the Cloud Run service
+ * @param params.serviceName The name of the Cloud Run service
+ * @param params.region The region of the service - required if the serviceName is passed.
+ * @returns {Promise<string>} Returns the endpoint of the Cloud Run service
+ */
+const getCloudrunEndpoint = async ({ cloudRunUrl, serviceName, region, }) => {
+    if (!cloudRunUrl && !serviceName)
+        throw new Error('Either cloudRunUrl or serviceName must be provided');
+    if (cloudRunUrl && serviceName)
+        throw new Error('Either cloudRunUrl or serviceName must be provided, not both');
+    let cloudRunEndpoint = '';
+    if (cloudRunUrl) {
+        (0, validate_cloudrun_url_1.validateCloudRunUrl)(cloudRunUrl);
+        cloudRunEndpoint = cloudRunUrl;
+    }
+    if (serviceName) {
+        if (!region)
+            throw new Error('If determining Cloudrun Url from serviceName, region must be provided');
+        (0, validate_service_name_1.validateServiceName)(serviceName);
+        const validatedRegion = (0, validate_region_1.validateRegion)(region);
+        const { uri } = await (0, get_service_info_1.getServiceInfo)({ serviceName, region: validatedRegion });
+        cloudRunEndpoint = uri;
+    }
+    return cloudRunEndpoint;
+};
+exports.getCloudrunEndpoint = getCloudrunEndpoint;

package/dist/api/helpers/get-resource-manager-client.d.ts

@@ -0,0 +1,2 @@
+import { v3 } from '@google-cloud/resource-manager';
+export declare const getResourceManagerClient: () => v3.ProjectsClient;

package/dist/api/helpers/get-resource-manager-client.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getResourceManagerClient = void 0;
+const resource_manager_1 = require("@google-cloud/resource-manager");
+const { ProjectsClient } = resource_manager_1.v3;
+const getResourceManagerClient = () => {
+    return new ProjectsClient({
+        projectId: process.env.REMOTION_GCP_PROJECT_ID,
+        credentials: {
+            client_email: process.env.REMOTION_GCP_CLIENT_EMAIL,
+            private_key: process.env.REMOTION_GCP_PRIVATE_KEY,
+        },
+    });
+};
+exports.getResourceManagerClient = getResourceManagerClient;

package/dist/api/helpers/parse-service-name.d.ts

@@ -0,0 +1,8 @@
+import type { GcpRegion } from '../../pricing/gcp-regions';
+export declare const getGcpParent: (region: GcpRegion) => string;
+export declare const parseServiceName: (fullServiceName: string, region: GcpRegion) => {
+    serviceName: string;
+    remotionVersion: string;
+    region: "asia-east1" | "asia-east2" | "asia-northeast1" | "asia-northeast2" | "asia-northeast3" | "asia-south1" | "asia-south2" | "asia-southeast1" | "asia-southeast2" | "australia-southeast1" | "australia-southeast2" | "europe-central2" | "europe-north1" | "europe-southwest1" | "europe-west1" | "europe-west2" | "europe-west3" | "europe-west4" | "europe-west6" | "europe-west8" | "europe-west9" | "me-west1" | "northamerica-northeast1" | "northamerica-northeast2" | "southamerica-east1" | "southamerica-west1" | "us-central1" | "us-east1" | "us-east4" | "us-east5" | "us-south1" | "us-west1" | "us-west2" | "us-west3" | "us-west4";
+    consoleUrl: string;
+};

package/dist/api/helpers/parse-service-name.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseServiceName = exports.getGcpParent = void 0;
+const getGcpParent = (region) => {
+    const parent = `projects/${process.env.REMOTION_GCP_PROJECT_ID}/locations/${region}`;
+    return parent;
+};
+exports.getGcpParent = getGcpParent;
+const parseServiceName = (fullServiceName, region) => {
+    const parent = (0, exports.getGcpParent)(region);
+    const shortServiceName = fullServiceName.replace(parent + '/services/', '');
+    const deployedRegion = fullServiceName.split('/')[3];
+    const matched = shortServiceName.match(/remotion-(.*)-mem([0-9])/);
+    if (!matched) {
+        throw new Error(`Could not parse service name ${shortServiceName}`);
+    }
+    return {
+        serviceName: shortServiceName,
+        remotionVersion: matched[1],
+        region: deployedRegion,
+        consoleUrl: `https://console.cloud.google.com/run/detail/${deployedRegion}/${shortServiceName}/logs`,
+    };
+};
+exports.parseServiceName = parseServiceName;

package/dist/api/iam-validation/testPermissions.d.ts

@@ -0,0 +1,20 @@
+export declare const logPermissionOutput: (output: TestResult) => string;
+declare type TestResult = {
+    decision: true | false;
+    permissionName: string;
+};
+declare type TestPermissionsInput = {
+    onTest: (result: TestResult) => void;
+};
+declare type TestPermissionsOutput = {
+    results: TestResult[];
+};
+/**
+ * @description Test the permissions on the service account match the permissions required.
+ * @see [Remotion-Documentation](http://remotion.dev/docs/cloudrun/testpermissions)
+ * @see [Cloudrun-Documentation](https://cloud.google.com/resource-manager/reference/rest/v3/projects/testIamPermissions)
+ * @param {(result: TestResult) => void} params.onTest Function to run on each test result
+ * @returns {Promise<TestPermissionsOutput>} Returns array of TestResult objects
+ */
+export declare const testPermissions: (params?: TestPermissionsInput) => Promise<TestPermissionsOutput>;
+export {};

package/dist/api/iam-validation/testPermissions.js

@@ -0,0 +1,48 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.testPermissions = exports.logPermissionOutput = void 0;
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const get_resource_manager_client_1 = require("../helpers/get-resource-manager-client");
+const logPermissionOutput = (output) => {
+    return [output.decision ? '✅' : '❌', output.permissionName].join(' ');
+};
+exports.logPermissionOutput = logPermissionOutput;
+/**
+ * @description Test the permissions on the service account match the permissions required.
+ * @see [Remotion-Documentation](http://remotion.dev/docs/cloudrun/testpermissions)
+ * @see [Cloudrun-Documentation](https://cloud.google.com/resource-manager/reference/rest/v3/projects/testIamPermissions)
+ * @param {(result: TestResult) => void} params.onTest Function to run on each test result
+ * @returns {Promise<TestPermissionsOutput>} Returns array of TestResult objects
+ */
+const testPermissions = async (params) => {
+    const resourceManagerClient = (0, get_resource_manager_client_1.getResourceManagerClient)();
+    const saPermissions = JSON.parse(fs_1.default.readFileSync(path_1.default.join(__dirname, '../../shared/sa-permissions.json'), 'utf-8'));
+    const permissionList = saPermissions.list.map((permission) => permission.name);
+    const response = await resourceManagerClient.testIamPermissions({
+        resource: `projects/${process.env.REMOTION_GCP_PROJECT_ID}`,
+        permissions: permissionList,
+    });
+    const returnedPermissions = response[0].permissions;
+    if (!returnedPermissions) {
+        throw new Error('No permissions returned from the testIamPermissions call.');
+    }
+    const results = [];
+    saPermissions.list.forEach((permission) => {
+        if (returnedPermissions.includes(permission.name)) {
+            const thisResult = { decision: true, permissionName: permission.name };
+            results.push(thisResult);
+            params === null || params === void 0 ? void 0 : params.onTest(thisResult);
+        }
+        else {
+            const thisResult = { decision: false, permissionName: permission.name };
+            results.push(thisResult);
+            params === null || params === void 0 ? void 0 : params.onTest(thisResult);
+        }
+    });
+    return { results };
+};
+exports.testPermissions = testPermissions;