@remotion/cloudrun 4.1.0-alpha2

package/dist/shared/validate-bucketname.d.ts

@@ -0,0 +1,8 @@
+import type { GcpRegion } from '../pricing/gcp-regions';
+export declare const validateBucketName: (bucketName: unknown, options: {
+    mustStartWithRemotion: boolean;
+}) => void;
+export declare const parseBucketName: (name: string) => {
+    region: GcpRegion | null;
+};
+export declare const makeBucketName: () => string;

package/dist/shared/validate-bucketname.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeBucketName = exports.parseBucketName = exports.validateBucketName = void 0;
+const regions_1 = require("../regions");
+const constants_1 = require("./constants");
+const random_hash_1 = require("./random-hash");
+const validateBucketName = (bucketName, options) => {
+    if (typeof bucketName !== 'string') {
+        throw new TypeError(`'bucketName' must be a string, but is ${JSON.stringify(bucketName)}`);
+    }
+    if (options.mustStartWithRemotion &&
+        !bucketName.startsWith(constants_1.REMOTION_BUCKET_PREFIX)) {
+        throw new Error(`The bucketName parameter must start with ${constants_1.REMOTION_BUCKET_PREFIX}.`);
+    }
+    if (!bucketName.match(/^(?=^.{3,63}$)(?!^(\d+\.)+\d+$)(^(([a-z0-9]|[a-z0-9][a-z0-9-]*[a-z0-9])\.)*([a-z0-9]|[a-z0-9][a-z0-9-]*[a-z0-9])$)/)) {
+        throw new Error(`The bucket ${bucketName} `);
+    }
+};
+exports.validateBucketName = validateBucketName;
+const parseBucketName = (name) => {
+    const parsed = name.match(new RegExp(`^${constants_1.REMOTION_BUCKET_PREFIX}(.*)-([a-z0-9A-Z]+)$`));
+    const region = parsed === null || parsed === void 0 ? void 0 : parsed[1];
+    if (!region) {
+        return { region: null };
+    }
+    const realRegionFound = regions_1.GCP_REGIONS.find((r) => r.replace(/-/g, '') === region);
+    return { region: realRegionFound !== null && realRegionFound !== void 0 ? realRegionFound : null };
+};
+exports.parseBucketName = parseBucketName;
+const makeBucketName = () => {
+    return `${constants_1.REMOTION_BUCKET_PREFIX}${(0, random_hash_1.randomHash)({
+        randomInTests: false,
+    })}`;
+};
+exports.makeBucketName = makeBucketName;

package/dist/shared/validate-cloudrun-url.d.ts

@@ -0,0 +1 @@
+export declare const validateCloudRunUrl: (cloudRunUrl: unknown) => void;

package/dist/shared/validate-cloudrun-url.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCloudRunUrl = void 0;
+const validateCloudRunUrl = (cloudRunUrl) => {
+    if (typeof cloudRunUrl !== 'string') {
+        throw new TypeError(`"cloudRunUrl" parameter must be a string, but is ${JSON.stringify(cloudRunUrl)}`);
+    }
+};
+exports.validateCloudRunUrl = validateCloudRunUrl;
+// To improve this, we could add an endpoint within the image that returns some message to confirm that this is a Cloud Run url

package/dist/shared/validate-gcp-codec.d.ts

@@ -0,0 +1,4 @@
+declare const cloudrunCodecs: readonly ["h264", "vp8", "vp9", "mp3", "aac", "wav", "gif", "prores"];
+export declare type CloudrunCodec = (typeof cloudrunCodecs)[number];
+export declare const validateCloudrunCodec: (codec: unknown) => CloudrunCodec;
+export {};

package/dist/shared/validate-gcp-codec.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateCloudrunCodec = void 0;
+const cloudrunCodecs = [
+    'h264',
+    'vp8',
+    'vp9',
+    'mp3',
+    'aac',
+    'wav',
+    'gif',
+    'prores',
+];
+const validateCloudrunCodec = (codec) => {
+    if (typeof codec !== 'string') {
+        throw new TypeError('"codec" must be a string ');
+    }
+    if (!cloudrunCodecs.includes(codec)) {
+        throw new TypeError("'" +
+            codec +
+            "' is not a valid codec for GCP Cloud Run. The following values are supported: " +
+            cloudrunCodecs.join(', '));
+    }
+    if (codec === 'h264-mkv') {
+        throw new Error('The "h264-mkv" codec for renderMediaOnCloudrun() is deprecated - it\'s now just "h264".');
+    }
+    return codec;
+};
+exports.validateCloudrunCodec = validateCloudrunCodec;

package/dist/shared/validate-gcp-region.d.ts

@@ -0,0 +1,2 @@
+import type { GcpRegion } from '../pricing/gcp-regions';
+export declare function validateGcpRegion(region: unknown): asserts region is GcpRegion;

package/dist/shared/validate-gcp-region.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateGcpRegion = void 0;
+const gcp_regions_1 = require("../pricing/gcp-regions");
+function validateGcpRegion(region) {
+    if (!gcp_regions_1.GCP_REGIONS.includes(region)) {
+        throw new TypeError(`${region} is not a valid GCP region. Must be one of: ${gcp_regions_1.GCP_REGIONS.join(', ')}`);
+    }
+}
+exports.validateGcpRegion = validateGcpRegion;

package/dist/shared/validate-image-remotion-version.d.ts

@@ -0,0 +1 @@
+export declare const validateImageRemotionVersion: () => Promise<void>;

package/dist/shared/validate-image-remotion-version.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateImageRemotionVersion = void 0;
+const artifact_registry_1 = require("@google-cloud/artifact-registry");
+const version_1 = require("remotion/version");
+const validateImageRemotionVersion = async () => {
+    var _a;
+    const client = new artifact_registry_1.ArtifactRegistryClient({
+        projectId: process.env.REMOTION_GCP_PROJECT_ID,
+        credentials: {
+            client_email: process.env.REMOTION_GCP_CLIENT_EMAIL,
+            private_key: process.env.REMOTION_GCP_PRIVATE_KEY,
+        },
+    });
+    const listedTags = await client.listTags({
+        parent: 'projects/remotion-dev/locations/us/repositories/cloud-run/packages/render',
+    });
+    for (const tag of listedTags[0]) {
+        if (version_1.VERSION === ((_a = tag.name) === null || _a === void 0 ? void 0 : _a.split('/').pop())) {
+            // if match is found, exit the function
+            return;
+        }
+    }
+    throw new Error(`The tag for Remotion version ${version_1.VERSION} was not found in the Cloud run registry.`);
+};
+exports.validateImageRemotionVersion = validateImageRemotionVersion;

package/dist/shared/validate-privacy.d.ts

@@ -0,0 +1,2 @@
+import type { Privacy } from './constants';
+export declare function validatePrivacy(privacy: unknown): asserts privacy is Privacy;

package/dist/shared/validate-privacy.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validatePrivacy = void 0;
+function validatePrivacy(privacy) {
+    if (typeof privacy !== 'string') {
+        throw new TypeError('Privacy must be a string');
+    }
+    if (privacy !== 'private' && privacy !== 'public') {
+        throw new TypeError('Privacy must be either "private" or "public"');
+    }
+}
+exports.validatePrivacy = validatePrivacy;

package/dist/shared/validate-project-id.d.ts

@@ -0,0 +1 @@
+export declare const validateProjectID: (projectID: unknown) => void;

package/dist/shared/validate-project-id.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateProjectID = void 0;
+const validateProjectID = (projectID) => {
+    if (typeof projectID === 'undefined') {
+        throw new TypeError(`The 'project-id' argument must be provided, but is missing.`);
+    }
+    if (typeof projectID !== 'string') {
+        throw new TypeError(`The 'project-id' argument must be a string, but is ${JSON.stringify(projectID)}`);
+    }
+    if (!projectID.match(/^[a-zA-Z][a-zA-Z0-9-]{0,48}[a-zA-Z0-9]$/g)) {
+        throw new Error('The `project-id` must match the RegExp `/^[a-zA-Z][a-zA-Z0-9-]{0,48}[a-zA-Z0-9]$/g`. This means it may only start with a letter, end with a letter or number, and contain up to 49 lowercase letters, numbers or hyphens. You passed: ' +
+            projectID +
+            '. Check for invalid characters.');
+    }
+};
+exports.validateProjectID = validateProjectID;

package/dist/shared/validate-region.d.ts

@@ -0,0 +1 @@
+export declare const validateRegion: (region: unknown) => "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";

package/dist/shared/validate-region.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateRegion = void 0;
+const gcp_regions_1 = require("../pricing/gcp-regions");
+const validateRegion = (region) => {
+    if (typeof region !== 'string') {
+        throw new TypeError(`"region" parameter must be a string, but is ${JSON.stringify(region)}`);
+    }
+    // check region is part of GCP_REGIONS list
+    if (!gcp_regions_1.GCP_REGIONS.includes(region)) {
+        throw new TypeError(`"region" parameter must be one of ${gcp_regions_1.GCP_REGIONS.join(', ')}, but is ${JSON.stringify(region)}`);
+    }
+    return region;
+};
+exports.validateRegion = validateRegion;

package/dist/shared/validate-retries.d.ts

@@ -0,0 +1 @@
+export declare function validateMaxRetries(maxRetries: unknown): asserts maxRetries is number;

package/dist/shared/validate-retries.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateMaxRetries = void 0;
+function validateMaxRetries(maxRetries) {
+    if (typeof maxRetries !== 'number') {
+        throw new TypeError('maxRetries must be a number, but is ' + JSON.stringify(maxRetries));
+    }
+    if (!Number.isFinite(maxRetries)) {
+        throw new TypeError('maxRetries must be finite, but is ' + maxRetries);
+    }
+    if (Number.isNaN(maxRetries)) {
+        throw new TypeError('maxRetries is NaN');
+    }
+    if (maxRetries < 0) {
+        throw new TypeError(`maxRetries cannot be negative but is ${maxRetries}`);
+    }
+    if (maxRetries % 1 !== 0) {
+        throw new TypeError(`maxRetries should be an integer, but is ${maxRetries}.`);
+    }
+}
+exports.validateMaxRetries = validateMaxRetries;

package/dist/shared/validate-serveurl.d.ts

@@ -0,0 +1 @@
+export declare const validateServeUrl: (serveUrl: unknown) => Promise<void>;

package/dist/shared/validate-serveurl.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateServeUrl = void 0;
+const get_cloud_storage_client_1 = require("../api/helpers/get-cloud-storage-client");
+const validateServeUrl = async (serveUrl) => {
+    if (typeof serveUrl !== 'string') {
+        throw new TypeError(`"serveURL" parameter must be a string, but is ${JSON.stringify(serveUrl)}`);
+    }
+    // if GCP Storage URL, validate that file exists
+    if (serveUrl.startsWith('https://storage.googleapis.com')) {
+        const cloudStorageClient = (0, get_cloud_storage_client_1.getCloudStorageClient)();
+        const bucketName = serveUrl.split('/')[3];
+        const fileName = serveUrl.split('/').slice(4).join('/');
+        const siteName = serveUrl.split('/')[5];
+        const [exists] = await cloudStorageClient
+            .bucket(bucketName)
+            .file(fileName)
+            .exists();
+        if (!exists) {
+            throw new Error('serveURL ERROR. File "' +
+                fileName +
+                '" not found in bucket "' +
+                bucketName +
+                '". Is your site name correct - "' +
+                siteName +
+                '"?');
+        }
+    }
+};
+exports.validateServeUrl = validateServeUrl;

package/dist/shared/validate-service-name.d.ts

@@ -0,0 +1 @@
+export declare const validateServiceName: (serviceName: unknown) => void;

package/dist/shared/validate-service-name.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateServiceName = void 0;
+const validateServiceName = (serviceName) => {
+    if (typeof serviceName !== 'string') {
+        throw new TypeError(`"serviceName" parameter must be a string, but is ${JSON.stringify(serviceName)}`);
+    }
+};
+exports.validateServiceName = validateServiceName;

package/dist/shared/validate-site-name.d.ts

@@ -0,0 +1 @@
+export declare const validateSiteName: (siteName: unknown) => void;

package/dist/shared/validate-site-name.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateSiteName = void 0;
+const validateSiteName = (siteName) => {
+    if (typeof siteName === 'undefined') {
+        return;
+    }
+    if (typeof siteName !== 'string') {
+        throw new TypeError(`The 'projectName' argument must be a string if provided, but is ${JSON.stringify(siteName)}`);
+    }
+    if (!siteName.match(/([0-9a-zA-Z-!_.*'()]+)/g)) {
+        throw new Error("The `siteName` must match the RegExp `/([0-9a-zA-Z-!_.*'()]+)/g`. You passed: " +
+            siteName +
+            '. Check for invalid characters.');
+    }
+};
+exports.validateSiteName = validateSiteName;

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@remotion/cloudrun",
+  "version": "4.1.0-alpha2",
+  "description": "GCP Cloud Run alternative to lambda rendering",
+  "main": "dist/index.js",
+  "dependencies": {
+    "@google-cloud/artifact-registry": "^2.2.2",
+    "@google-cloud/functions-framework": "^3.1.3",
+    "@google-cloud/run": "^0.4.0",
+    "@google-cloud/storage": "^6.9.1",
+    "@google-cloud/resource-manager": "^4.3.0",
+    "google-auth-library": "^8.7.0",
+    "zod": "^3.21.4",
+    "@remotion/bundler": "4.1.0-alpha2",
+    "@remotion/cli": "4.1.0-alpha2",
+    "@remotion/renderer": "4.1.0-alpha2",
+    "remotion": "4.1.0-alpha2"
+  },
+  "devDependencies": {
+    "@jonny/eslint-config": "3.0.266",
+    "@types/node": "^18.11.2",
+    "@types/minimist": "1.2.2",
+    "eslint": "8.25.0",
+    "prettier": "^2.7.1",
+    "prettier-plugin-organize-imports": "^3.2.2",
+    "ts-node": "^10.8.0",
+    "typescript": "4.7.2",
+    "vitest": "0.24.3",
+    "@remotion/compositor-linux-x64-gnu": "4.1.0-alpha2"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": "./dist/index.js",
+    "./defaults": "./dist/defaults.js",
+    "./regions": "./dist/regions.js",
+    "./permissions.json": "./dist/shared/sa-permissions.json"
+  },
+  "typesVersions": {
+    ">=1.0": {
+      "defaults": [
+        "dist/defaults.d.ts"
+      ],
+      "regions": [
+        "dist/regions.d.ts"
+      ]
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -d && cp src/shared/sa-permissions.json dist/shared/sa-permissions.json && pnpm run buildContainer && pnpm run tarInstaller",
+    "buildContainer": "ts-node src/admin/bundle-renderLogic.ts",
+    "tarInstaller": "ts-node src/admin/bundle-installer.ts",
+    "start": "functions-framework --target=TypescriptFunction",
+    "watch": "tsc -w",
+    "lint": "eslint src --ext ts,tsx"
+  }
+}