@remotion/cloudrun 4.1.0-alpha10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (189) hide show
  1. package/.turbo/turbo-build.log +13 -0
  2. package/LICENSE.md +41 -0
  3. package/dist/admin/bundle-installer.d.ts +1 -0
  4. package/dist/admin/bundle-installer.js +32 -0
  5. package/dist/admin/bundle-renderLogic.d.ts +1 -0
  6. package/dist/admin/bundle-renderLogic.js +39 -0
  7. package/dist/api/check-if-service-exists.d.ts +18 -0
  8. package/dist/api/check-if-service-exists.js +49 -0
  9. package/dist/api/create-bucket.d.ts +13 -0
  10. package/dist/api/create-bucket.js +18 -0
  11. package/dist/api/delete-service.d.ts +12 -0
  12. package/dist/api/delete-service.js +19 -0
  13. package/dist/api/delete-site.d.ts +13 -0
  14. package/dist/api/delete-site.js +30 -0
  15. package/dist/api/deploy-service.d.ts +28 -0
  16. package/dist/api/deploy-service.js +90 -0
  17. package/dist/api/deploy-site.d.ts +35 -0
  18. package/dist/api/deploy-site.js +78 -0
  19. package/dist/api/download-file.d.ts +13 -0
  20. package/dist/api/download-file.js +30 -0
  21. package/dist/api/get-buckets.d.ts +10 -0
  22. package/dist/api/get-buckets.js +23 -0
  23. package/dist/api/get-or-create-bucket.d.ts +17 -0
  24. package/dist/api/get-or-create-bucket.js +42 -0
  25. package/dist/api/get-regions.d.ts +7 -0
  26. package/dist/api/get-regions.js +13 -0
  27. package/dist/api/get-service-info.d.ts +23 -0
  28. package/dist/api/get-service-info.js +34 -0
  29. package/dist/api/get-services.d.ts +14 -0
  30. package/dist/api/get-services.js +49 -0
  31. package/dist/api/get-sites.d.ts +23 -0
  32. package/dist/api/get-sites.js +49 -0
  33. package/dist/api/helpers/IService.d.ts +2 -0
  34. package/dist/api/helpers/IService.js +2 -0
  35. package/dist/api/helpers/construct-service-deploy-request.d.ts +32 -0
  36. package/dist/api/helpers/construct-service-deploy-request.js +36 -0
  37. package/dist/api/helpers/extract-mem-from-url.d.ts +1 -0
  38. package/dist/api/helpers/extract-mem-from-url.js +9 -0
  39. package/dist/api/helpers/extract-time-from-url.d.ts +1 -0
  40. package/dist/api/helpers/extract-time-from-url.js +13 -0
  41. package/dist/api/helpers/get-auth-client-for-url.d.ts +1 -0
  42. package/dist/api/helpers/get-auth-client-for-url.js +15 -0
  43. package/dist/api/helpers/get-cloud-logging-client.d.ts +1 -0
  44. package/dist/api/helpers/get-cloud-logging-client.js +15 -0
  45. package/dist/api/helpers/get-cloud-run-client.d.ts +2 -0
  46. package/dist/api/helpers/get-cloud-run-client.js +15 -0
  47. package/dist/api/helpers/get-cloud-storage-client.d.ts +2 -0
  48. package/dist/api/helpers/get-cloud-storage-client.js +14 -0
  49. package/dist/api/helpers/get-cloudrun-endpoint.d.ts +14 -0
  50. package/dist/api/helpers/get-cloudrun-endpoint.js +36 -0
  51. package/dist/api/helpers/get-resource-manager-client.d.ts +2 -0
  52. package/dist/api/helpers/get-resource-manager-client.js +15 -0
  53. package/dist/api/helpers/parse-service-name.d.ts +8 -0
  54. package/dist/api/helpers/parse-service-name.js +24 -0
  55. package/dist/api/iam-validation/testPermissions.d.ts +20 -0
  56. package/dist/api/iam-validation/testPermissions.js +48 -0
  57. package/dist/api/render-media-on-cloudrun.d.ts +78 -0
  58. package/dist/api/render-media-on-cloudrun.js +144 -0
  59. package/dist/api/render-still-on-cloudrun.d.ts +49 -0
  60. package/dist/api/render-still-on-cloudrun.js +76 -0
  61. package/dist/api/speculate-service-name.d.ts +13 -0
  62. package/dist/api/speculate-service-name.js +20 -0
  63. package/dist/api/test/service-names.test.d.ts +1 -0
  64. package/dist/api/test/service-names.test.js +28 -0
  65. package/dist/api/upload-dir.d.ts +18 -0
  66. package/dist/api/upload-dir.js +81 -0
  67. package/dist/cli/args.d.ts +19 -0
  68. package/dist/cli/args.js +11 -0
  69. package/dist/cli/commands/permissions.d.ts +2 -0
  70. package/dist/cli/commands/permissions.js +23 -0
  71. package/dist/cli/commands/regions.d.ts +2 -0
  72. package/dist/cli/commands/regions.js +10 -0
  73. package/dist/cli/commands/render/helpers/renderArgsCheck.d.ts +9 -0
  74. package/dist/cli/commands/render/helpers/renderArgsCheck.js +75 -0
  75. package/dist/cli/commands/render/index.d.ts +2 -0
  76. package/dist/cli/commands/render/index.js +228 -0
  77. package/dist/cli/commands/services/deploy.d.ts +2 -0
  78. package/dist/cli/commands/services/deploy.js +129 -0
  79. package/dist/cli/commands/services/index.d.ts +5 -0
  80. package/dist/cli/commands/services/index.js +64 -0
  81. package/dist/cli/commands/services/ls.d.ts +2 -0
  82. package/dist/cli/commands/services/ls.js +40 -0
  83. package/dist/cli/commands/services/rm.d.ts +2 -0
  84. package/dist/cli/commands/services/rm.js +63 -0
  85. package/dist/cli/commands/services/rmall.d.ts +2 -0
  86. package/dist/cli/commands/services/rmall.js +52 -0
  87. package/dist/cli/commands/sites/create.d.ts +2 -0
  88. package/dist/cli/commands/sites/create.js +138 -0
  89. package/dist/cli/commands/sites/index.d.ts +4 -0
  90. package/dist/cli/commands/sites/index.js +60 -0
  91. package/dist/cli/commands/sites/ls.d.ts +2 -0
  92. package/dist/cli/commands/sites/ls.js +40 -0
  93. package/dist/cli/commands/sites/rm.d.ts +2 -0
  94. package/dist/cli/commands/sites/rm.js +59 -0
  95. package/dist/cli/commands/sites/rmall.d.ts +2 -0
  96. package/dist/cli/commands/sites/rmall.js +38 -0
  97. package/dist/cli/commands/still.d.ts +2 -0
  98. package/dist/cli/commands/still.js +129 -0
  99. package/dist/cli/get-gcp-region.d.ts +2 -0
  100. package/dist/cli/get-gcp-region.js +19 -0
  101. package/dist/cli/help.d.ts +1 -0
  102. package/dist/cli/help.js +38 -0
  103. package/dist/cli/helpers/confirm.d.ts +4 -0
  104. package/dist/cli/helpers/confirm.js +12 -0
  105. package/dist/cli/helpers/date-string.d.ts +1 -0
  106. package/dist/cli/helpers/date-string.js +9 -0
  107. package/dist/cli/helpers/progress-bar.d.ts +23 -0
  108. package/dist/cli/helpers/progress-bar.js +81 -0
  109. package/dist/cli/helpers/quit.d.ts +1 -0
  110. package/dist/cli/helpers/quit.js +7 -0
  111. package/dist/cli/helpers/yes-or-no.d.ts +4 -0
  112. package/dist/cli/helpers/yes-or-no.js +44 -0
  113. package/dist/cli/index.d.ts +1 -0
  114. package/dist/cli/index.js +56 -0
  115. package/dist/cli/log.d.ts +26 -0
  116. package/dist/cli/log.js +5 -0
  117. package/dist/defaults.d.ts +1 -0
  118. package/dist/defaults.js +17 -0
  119. package/dist/functions/helpers/get-composition-from-body.d.ts +2 -0
  120. package/dist/functions/helpers/get-composition-from-body.js +27 -0
  121. package/dist/functions/helpers/io.d.ts +11 -0
  122. package/dist/functions/helpers/io.js +17 -0
  123. package/dist/functions/helpers/payloads.d.ts +300 -0
  124. package/dist/functions/helpers/payloads.js +104 -0
  125. package/dist/functions/index.d.ts +3 -0
  126. package/dist/functions/index.js +39 -0
  127. package/dist/functions/render-media-single-thread.d.ts +3 -0
  128. package/dist/functions/render-media-single-thread.js +103 -0
  129. package/dist/functions/render-still-single-thread.d.ts +3 -0
  130. package/dist/functions/render-still-single-thread.js +82 -0
  131. package/dist/index.d.ts +20 -0
  132. package/dist/index.js +31 -0
  133. package/dist/internals.d.ts +3 -0
  134. package/dist/internals.js +7 -0
  135. package/dist/pricing/gcp-regions.d.ts +5 -0
  136. package/dist/pricing/gcp-regions.js +77 -0
  137. package/dist/regions.d.ts +2 -0
  138. package/dist/regions.js +5 -0
  139. package/dist/shared/bundle-site.d.ts +2 -0
  140. package/dist/shared/bundle-site.js +5 -0
  141. package/dist/shared/constants.d.ts +13 -0
  142. package/dist/shared/constants.js +18 -0
  143. package/dist/shared/convert-to-serve-url.d.ts +4 -0
  144. package/dist/shared/convert-to-serve-url.js +14 -0
  145. package/dist/shared/docs-url.d.ts +1 -0
  146. package/dist/shared/docs-url.js +4 -0
  147. package/dist/shared/generate-service-name.d.ts +5 -0
  148. package/dist/shared/generate-service-name.js +20 -0
  149. package/dist/shared/get-etag.d.ts +1 -0
  150. package/dist/shared/get-etag.js +24 -0
  151. package/dist/shared/get-storage-operations.d.ts +10 -0
  152. package/dist/shared/get-storage-operations.js +36 -0
  153. package/dist/shared/make-storage-key.d.ts +1 -0
  154. package/dist/shared/make-storage-key.js +11 -0
  155. package/dist/shared/make-storage-url.d.ts +4 -0
  156. package/dist/shared/make-storage-url.js +7 -0
  157. package/dist/shared/random-hash.d.ts +3 -0
  158. package/dist/shared/random-hash.js +14 -0
  159. package/dist/shared/read-dir.d.ts +9 -0
  160. package/dist/shared/read-dir.js +57 -0
  161. package/dist/shared/sa-permissions.json +64 -0
  162. package/dist/shared/service-version-string.d.ts +1 -0
  163. package/dist/shared/service-version-string.js +8 -0
  164. package/dist/shared/validate-bucketname.d.ts +8 -0
  165. package/dist/shared/validate-bucketname.js +35 -0
  166. package/dist/shared/validate-cloudrun-url.d.ts +1 -0
  167. package/dist/shared/validate-cloudrun-url.js +10 -0
  168. package/dist/shared/validate-gcp-codec.d.ts +4 -0
  169. package/dist/shared/validate-gcp-codec.js +29 -0
  170. package/dist/shared/validate-gcp-region.d.ts +2 -0
  171. package/dist/shared/validate-gcp-region.js +10 -0
  172. package/dist/shared/validate-image-remotion-version.d.ts +1 -0
  173. package/dist/shared/validate-image-remotion-version.js +26 -0
  174. package/dist/shared/validate-privacy.d.ts +2 -0
  175. package/dist/shared/validate-privacy.js +12 -0
  176. package/dist/shared/validate-project-id.d.ts +1 -0
  177. package/dist/shared/validate-project-id.js +17 -0
  178. package/dist/shared/validate-region.d.ts +1 -0
  179. package/dist/shared/validate-region.js +15 -0
  180. package/dist/shared/validate-retries.d.ts +1 -0
  181. package/dist/shared/validate-retries.js +21 -0
  182. package/dist/shared/validate-serveurl.d.ts +1 -0
  183. package/dist/shared/validate-serveurl.js +30 -0
  184. package/dist/shared/validate-service-name.d.ts +1 -0
  185. package/dist/shared/validate-service-name.js +9 -0
  186. package/dist/shared/validate-site-name.d.ts +1 -0
  187. package/dist/shared/validate-site-name.js +17 -0
  188. package/package.json +57 -0
  189. package/readme.md +3 -0
@@ -0,0 +1,10 @@
1
+ import type { File } from '@google-cloud/storage';
2
+ export declare const getStorageDiffOperations: ({ objects, bundle, prefix, }: {
3
+ objects: File[];
4
+ bundle: string;
5
+ prefix: string;
6
+ }) => Promise<{
7
+ toDelete: File[];
8
+ toUpload: string[];
9
+ existingCount: number;
10
+ }>;
@@ -0,0 +1,36 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.getStorageDiffOperations = void 0;
4
+ const read_dir_1 = require("./read-dir");
5
+ const getStorageDiffOperations = async ({ objects, bundle, prefix, }) => {
6
+ const dir = await (0, read_dir_1.readDirectory)({
7
+ dir: bundle,
8
+ etags: {},
9
+ originalDir: bundle,
10
+ });
11
+ const filesOnStorageButNotLocal = objects.filter((fileOnStorage) => {
12
+ var _a;
13
+ const key = (_a = fileOnStorage.name) === null || _a === void 0 ? void 0 : _a.substring(prefix.length);
14
+ return !dir[key];
15
+ });
16
+ const localFilesNotOnStorage = Object.keys(dir).filter((d) => {
17
+ return !objects.find((o) => {
18
+ var _a;
19
+ const key = (_a = o.name) === null || _a === void 0 ? void 0 : _a.substring(prefix.length);
20
+ return key === d && o.metadata.etag === dir[d];
21
+ });
22
+ });
23
+ const existing = Object.keys(dir).filter((d) => {
24
+ return objects.find((o) => {
25
+ var _a;
26
+ const key = (_a = o.name) === null || _a === void 0 ? void 0 : _a.substring(prefix.length);
27
+ return key === d && o.metadata.etag === dir[d];
28
+ });
29
+ });
30
+ return {
31
+ toDelete: filesOnStorageButNotLocal,
32
+ toUpload: localFilesNotOnStorage,
33
+ existingCount: existing.length,
34
+ };
35
+ };
36
+ exports.getStorageDiffOperations = getStorageDiffOperations;
@@ -0,0 +1 @@
1
+ export declare const makeStorageKey: (folder: string, dir: string, filePath: string) => string;
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.makeStorageKey = void 0;
7
+ const path_1 = __importDefault(require("path"));
8
+ const makeStorageKey = (folder, dir, filePath) => {
9
+ return `${folder}/${path_1.default.relative(dir, filePath).split(path_1.default.sep).join('/')}`;
10
+ };
11
+ exports.makeStorageKey = makeStorageKey;
@@ -0,0 +1,4 @@
1
+ export declare const makeStorageServeUrl: ({ bucketName, subFolder, }: {
2
+ bucketName: string;
3
+ subFolder: string;
4
+ }) => string;
@@ -0,0 +1,7 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.makeStorageServeUrl = void 0;
4
+ const makeStorageServeUrl = ({ bucketName, subFolder, }) => {
5
+ return `https://storage.googleapis.com/${bucketName}/${subFolder}/index.html`;
6
+ };
7
+ exports.makeStorageServeUrl = makeStorageServeUrl;
@@ -0,0 +1,3 @@
1
+ export declare const randomHash: (_options?: {
2
+ randomInTests: boolean;
3
+ }) => string;
@@ -0,0 +1,14 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.randomHash = void 0;
4
+ const alphabet = 'abcdefghijklmnopqrstuvwxyz0123456789';
5
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
6
+ const randomHash = (_options) => {
7
+ return new Array(10)
8
+ .fill(1)
9
+ .map(() => {
10
+ return alphabet[Math.floor(Math.random() * alphabet.length)];
11
+ })
12
+ .join('');
13
+ };
14
+ exports.randomHash = randomHash;
@@ -0,0 +1,9 @@
1
+ export declare function readDirectory({ dir, etags, originalDir, }: {
2
+ dir: string;
3
+ etags: {
4
+ [key: string]: string;
5
+ };
6
+ originalDir: string;
7
+ }): Promise<{
8
+ [key: string]: string;
9
+ }>;
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
+ Object.defineProperty(o, "default", { enumerable: true, value: v });
15
+ }) : function(o, v) {
16
+ o["default"] = v;
17
+ });
18
+ var __importStar = (this && this.__importStar) || function (mod) {
19
+ if (mod && mod.__esModule) return mod;
20
+ var result = {};
21
+ if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
+ __setModuleDefault(result, mod);
23
+ return result;
24
+ };
25
+ Object.defineProperty(exports, "__esModule", { value: true });
26
+ exports.readDirectory = void 0;
27
+ const fs = __importStar(require("fs"));
28
+ const path = __importStar(require("path"));
29
+ const get_etag_1 = require("./get-etag");
30
+ // Function to recursively read a directory and return a list of files
31
+ // with their etags and file names
32
+ async function readDirectory({ dir, etags, originalDir, }) {
33
+ const files = fs.readdirSync(dir);
34
+ for (const file of files) {
35
+ if (file.startsWith('.DS_Store'))
36
+ continue;
37
+ const filePath = path.join(dir, file);
38
+ if (fs.lstatSync(filePath).isDirectory()) {
39
+ etags = {
40
+ ...etags,
41
+ ...(await readDirectory({ dir: filePath, etags, originalDir })),
42
+ };
43
+ continue;
44
+ }
45
+ // eslint-disable-next-line no-lonely-if
46
+ if (fs.lstatSync(filePath).isSymbolicLink()) {
47
+ const realPath = fs.realpathSync(filePath);
48
+ etags[path.relative(originalDir, filePath)] = await (0, get_etag_1.getEtagOfFile)(realPath);
49
+ }
50
+ else {
51
+ etags[path.relative(originalDir, filePath)] = await (0, get_etag_1.getEtagOfFile)(filePath);
52
+ }
53
+ }
54
+ // Return the list of files with their etags and file names
55
+ return etags;
56
+ }
57
+ exports.readDirectory = readDirectory;
@@ -0,0 +1,64 @@
1
+ {
2
+ "list": [
3
+ {
4
+ "name": "iam.serviceAccounts.actAs",
5
+ "reason": "When deploying, act as the default service account, which will grant further permissions required during deployment."
6
+ },
7
+ {
8
+ "name": "run.operations.get",
9
+ "reason": "Required during deployment to confirm that deployment was successful."
10
+ },
11
+ {
12
+ "name": "run.routes.invoke",
13
+ "reason": "Invoke the deployed Cloud Run services to perform a render."
14
+ },
15
+ {
16
+ "name": "run.services.create",
17
+ "reason": "Deploy new, and edit existing, Cloud Run services."
18
+ },
19
+ {
20
+ "name": "run.services.get",
21
+ "reason": ""
22
+ },
23
+ {
24
+ "name": "run.services.delete",
25
+ "reason": ""
26
+ },
27
+ {
28
+ "name": "run.services.list",
29
+ "reason": "Get a list of existing Cloud Run services, to ensure no unintended overwriting."
30
+ },
31
+ {
32
+ "name": "run.services.update",
33
+ "reason": "Update a Cloud Run service, for example providing it with more memory or CPU."
34
+ },
35
+ {
36
+ "name": "storage.buckets.create",
37
+ "reason": "Create the storage bucket to store the bundled site and render output."
38
+ },
39
+ {
40
+ "name": "storage.buckets.get",
41
+ "reason": ""
42
+ },
43
+ {
44
+ "name": "storage.buckets.list",
45
+ "reason": "Get a list of existing Cloud Storage resources, to ensure no unintended overwriting of storage buckets."
46
+ },
47
+ {
48
+ "name": "storage.objects.create",
49
+ "reason": "Create new objects in storage. This could be bundled sites, or renders, or logs."
50
+ },
51
+ {
52
+ "name": "storage.objects.delete",
53
+ "reason": ""
54
+ },
55
+ {
56
+ "name": "storage.objects.list",
57
+ "reason": ""
58
+ },
59
+ {
60
+ "name": "logging.logEntries.list",
61
+ "reason": "Used by the CLI to fetch recent logs if the Cloud Run service crashes, to assist in debugging the root cause."
62
+ }
63
+ ]
64
+ }
@@ -0,0 +1 @@
1
+ export declare const serviceVersionString: () => string;
@@ -0,0 +1,8 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.serviceVersionString = void 0;
4
+ const version_1 = require("remotion/version");
5
+ const serviceVersionString = () => {
6
+ return version_1.VERSION.replace(/\./g, '-').replace(/\+/g, '-');
7
+ };
8
+ exports.serviceVersionString = serviceVersionString;
@@ -0,0 +1,8 @@
1
+ import type { GcpRegion } from '../pricing/gcp-regions';
2
+ export declare const validateBucketName: (bucketName: unknown, options: {
3
+ mustStartWithRemotion: boolean;
4
+ }) => void;
5
+ export declare const parseBucketName: (name: string) => {
6
+ region: GcpRegion | null;
7
+ };
8
+ export declare const makeBucketName: () => string;
@@ -0,0 +1,35 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.makeBucketName = exports.parseBucketName = exports.validateBucketName = void 0;
4
+ const regions_1 = require("../regions");
5
+ const constants_1 = require("./constants");
6
+ const random_hash_1 = require("./random-hash");
7
+ const validateBucketName = (bucketName, options) => {
8
+ if (typeof bucketName !== 'string') {
9
+ throw new TypeError(`'bucketName' must be a string, but is ${JSON.stringify(bucketName)}`);
10
+ }
11
+ if (options.mustStartWithRemotion &&
12
+ !bucketName.startsWith(constants_1.REMOTION_BUCKET_PREFIX)) {
13
+ throw new Error(`The bucketName parameter must start with ${constants_1.REMOTION_BUCKET_PREFIX}.`);
14
+ }
15
+ 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])$)/)) {
16
+ throw new Error(`The bucket ${bucketName} `);
17
+ }
18
+ };
19
+ exports.validateBucketName = validateBucketName;
20
+ const parseBucketName = (name) => {
21
+ const parsed = name.match(new RegExp(`^${constants_1.REMOTION_BUCKET_PREFIX}(.*)-([a-z0-9A-Z]+)$`));
22
+ const region = parsed === null || parsed === void 0 ? void 0 : parsed[1];
23
+ if (!region) {
24
+ return { region: null };
25
+ }
26
+ const realRegionFound = regions_1.GCP_REGIONS.find((r) => r.replace(/-/g, '') === region);
27
+ return { region: realRegionFound !== null && realRegionFound !== void 0 ? realRegionFound : null };
28
+ };
29
+ exports.parseBucketName = parseBucketName;
30
+ const makeBucketName = () => {
31
+ return `${constants_1.REMOTION_BUCKET_PREFIX}${(0, random_hash_1.randomHash)({
32
+ randomInTests: false,
33
+ })}`;
34
+ };
35
+ exports.makeBucketName = makeBucketName;
@@ -0,0 +1 @@
1
+ export declare const validateCloudRunUrl: (cloudRunUrl: unknown) => void;
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateCloudRunUrl = void 0;
4
+ const validateCloudRunUrl = (cloudRunUrl) => {
5
+ if (typeof cloudRunUrl !== 'string') {
6
+ throw new TypeError(`"cloudRunUrl" parameter must be a string, but is ${JSON.stringify(cloudRunUrl)}`);
7
+ }
8
+ };
9
+ exports.validateCloudRunUrl = validateCloudRunUrl;
10
+ // To improve this, we could add an endpoint within the image that returns some message to confirm that this is a Cloud Run url
@@ -0,0 +1,4 @@
1
+ declare const cloudrunCodecs: readonly ["h264", "vp8", "vp9", "mp3", "aac", "wav", "gif", "prores"];
2
+ export declare type CloudrunCodec = (typeof cloudrunCodecs)[number];
3
+ export declare const validateCloudrunCodec: (codec: unknown) => CloudrunCodec;
4
+ export {};
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateCloudrunCodec = void 0;
4
+ const cloudrunCodecs = [
5
+ 'h264',
6
+ 'vp8',
7
+ 'vp9',
8
+ 'mp3',
9
+ 'aac',
10
+ 'wav',
11
+ 'gif',
12
+ 'prores',
13
+ ];
14
+ const validateCloudrunCodec = (codec) => {
15
+ if (typeof codec !== 'string') {
16
+ throw new TypeError('"codec" must be a string ');
17
+ }
18
+ if (!cloudrunCodecs.includes(codec)) {
19
+ throw new TypeError("'" +
20
+ codec +
21
+ "' is not a valid codec for GCP Cloud Run. The following values are supported: " +
22
+ cloudrunCodecs.join(', '));
23
+ }
24
+ if (codec === 'h264-mkv') {
25
+ throw new Error('The "h264-mkv" codec for renderMediaOnCloudrun() is deprecated - it\'s now just "h264".');
26
+ }
27
+ return codec;
28
+ };
29
+ exports.validateCloudrunCodec = validateCloudrunCodec;
@@ -0,0 +1,2 @@
1
+ import type { GcpRegion } from '../pricing/gcp-regions';
2
+ export declare function validateGcpRegion(region: unknown): asserts region is GcpRegion;
@@ -0,0 +1,10 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateGcpRegion = void 0;
4
+ const gcp_regions_1 = require("../pricing/gcp-regions");
5
+ function validateGcpRegion(region) {
6
+ if (!gcp_regions_1.GCP_REGIONS.includes(region)) {
7
+ throw new TypeError(`${region} is not a valid GCP region. Must be one of: ${gcp_regions_1.GCP_REGIONS.join(', ')}`);
8
+ }
9
+ }
10
+ exports.validateGcpRegion = validateGcpRegion;
@@ -0,0 +1 @@
1
+ export declare const validateImageRemotionVersion: () => Promise<void>;
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateImageRemotionVersion = void 0;
4
+ const artifact_registry_1 = require("@google-cloud/artifact-registry");
5
+ const version_1 = require("remotion/version");
6
+ const validateImageRemotionVersion = async () => {
7
+ var _a;
8
+ const client = new artifact_registry_1.ArtifactRegistryClient({
9
+ projectId: process.env.REMOTION_GCP_PROJECT_ID,
10
+ credentials: {
11
+ client_email: process.env.REMOTION_GCP_CLIENT_EMAIL,
12
+ private_key: process.env.REMOTION_GCP_PRIVATE_KEY,
13
+ },
14
+ });
15
+ const listedTags = await client.listTags({
16
+ parent: 'projects/remotion-dev/locations/us/repositories/production/packages/render',
17
+ });
18
+ for (const tag of listedTags[0]) {
19
+ if (version_1.VERSION === ((_a = tag.name) === null || _a === void 0 ? void 0 : _a.split('/').pop())) {
20
+ // if match is found, exit the function
21
+ return;
22
+ }
23
+ }
24
+ throw new Error(`The tag for Remotion version ${version_1.VERSION} was not found in the Cloud run registry.`);
25
+ };
26
+ exports.validateImageRemotionVersion = validateImageRemotionVersion;
@@ -0,0 +1,2 @@
1
+ import type { Privacy } from './constants';
2
+ export declare function validatePrivacy(privacy: unknown): asserts privacy is Privacy;
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validatePrivacy = void 0;
4
+ function validatePrivacy(privacy) {
5
+ if (typeof privacy !== 'string') {
6
+ throw new TypeError('Privacy must be a string');
7
+ }
8
+ if (privacy !== 'private' && privacy !== 'public') {
9
+ throw new TypeError('Privacy must be either "private" or "public"');
10
+ }
11
+ }
12
+ exports.validatePrivacy = validatePrivacy;
@@ -0,0 +1 @@
1
+ export declare const validateProjectID: (projectID: unknown) => void;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateProjectID = void 0;
4
+ const validateProjectID = (projectID) => {
5
+ if (typeof projectID === 'undefined') {
6
+ throw new TypeError(`The 'project-id' argument must be provided, but is missing.`);
7
+ }
8
+ if (typeof projectID !== 'string') {
9
+ throw new TypeError(`The 'project-id' argument must be a string, but is ${JSON.stringify(projectID)}`);
10
+ }
11
+ if (!projectID.match(/^[a-zA-Z][a-zA-Z0-9-]{0,48}[a-zA-Z0-9]$/g)) {
12
+ 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: ' +
13
+ projectID +
14
+ '. Check for invalid characters.');
15
+ }
16
+ };
17
+ exports.validateProjectID = validateProjectID;
@@ -0,0 +1 @@
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";
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateRegion = void 0;
4
+ const gcp_regions_1 = require("../pricing/gcp-regions");
5
+ const validateRegion = (region) => {
6
+ if (typeof region !== 'string') {
7
+ throw new TypeError(`"region" parameter must be a string, but is ${JSON.stringify(region)}`);
8
+ }
9
+ // check region is part of GCP_REGIONS list
10
+ if (!gcp_regions_1.GCP_REGIONS.includes(region)) {
11
+ throw new TypeError(`"region" parameter must be one of ${gcp_regions_1.GCP_REGIONS.join(', ')}, but is ${JSON.stringify(region)}`);
12
+ }
13
+ return region;
14
+ };
15
+ exports.validateRegion = validateRegion;
@@ -0,0 +1 @@
1
+ export declare function validateMaxRetries(maxRetries: unknown): asserts maxRetries is number;
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateMaxRetries = void 0;
4
+ function validateMaxRetries(maxRetries) {
5
+ if (typeof maxRetries !== 'number') {
6
+ throw new TypeError('maxRetries must be a number, but is ' + JSON.stringify(maxRetries));
7
+ }
8
+ if (!Number.isFinite(maxRetries)) {
9
+ throw new TypeError('maxRetries must be finite, but is ' + maxRetries);
10
+ }
11
+ if (Number.isNaN(maxRetries)) {
12
+ throw new TypeError('maxRetries is NaN');
13
+ }
14
+ if (maxRetries < 0) {
15
+ throw new TypeError(`maxRetries cannot be negative but is ${maxRetries}`);
16
+ }
17
+ if (maxRetries % 1 !== 0) {
18
+ throw new TypeError(`maxRetries should be an integer, but is ${maxRetries}.`);
19
+ }
20
+ }
21
+ exports.validateMaxRetries = validateMaxRetries;
@@ -0,0 +1 @@
1
+ export declare const validateServeUrl: (serveUrl: unknown) => Promise<void>;
@@ -0,0 +1,30 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateServeUrl = void 0;
4
+ const get_cloud_storage_client_1 = require("../api/helpers/get-cloud-storage-client");
5
+ const validateServeUrl = async (serveUrl) => {
6
+ if (typeof serveUrl !== 'string') {
7
+ throw new TypeError(`"serveURL" parameter must be a string, but is ${JSON.stringify(serveUrl)}`);
8
+ }
9
+ // if GCP Storage URL, validate that file exists
10
+ if (serveUrl.startsWith('https://storage.googleapis.com')) {
11
+ const cloudStorageClient = (0, get_cloud_storage_client_1.getCloudStorageClient)();
12
+ const bucketName = serveUrl.split('/')[3];
13
+ const fileName = serveUrl.split('/').slice(4).join('/');
14
+ const siteName = serveUrl.split('/')[5];
15
+ const [exists] = await cloudStorageClient
16
+ .bucket(bucketName)
17
+ .file(fileName)
18
+ .exists();
19
+ if (!exists) {
20
+ throw new Error('serveURL ERROR. File "' +
21
+ fileName +
22
+ '" not found in bucket "' +
23
+ bucketName +
24
+ '". Is your site name correct - "' +
25
+ siteName +
26
+ '"?');
27
+ }
28
+ }
29
+ };
30
+ exports.validateServeUrl = validateServeUrl;
@@ -0,0 +1 @@
1
+ export declare const validateServiceName: (serviceName: unknown) => void;
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateServiceName = void 0;
4
+ const validateServiceName = (serviceName) => {
5
+ if (typeof serviceName !== 'string') {
6
+ throw new TypeError(`"serviceName" parameter must be a string, but is ${JSON.stringify(serviceName)}`);
7
+ }
8
+ };
9
+ exports.validateServiceName = validateServiceName;
@@ -0,0 +1 @@
1
+ export declare const validateSiteName: (siteName: unknown) => void;
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.validateSiteName = void 0;
4
+ const validateSiteName = (siteName) => {
5
+ if (typeof siteName === 'undefined') {
6
+ return;
7
+ }
8
+ if (typeof siteName !== 'string') {
9
+ throw new TypeError(`The 'projectName' argument must be a string if provided, but is ${JSON.stringify(siteName)}`);
10
+ }
11
+ if (!siteName.match(/([0-9a-zA-Z-!_.*'()]+)/g)) {
12
+ throw new Error("The `siteName` must match the RegExp `/([0-9a-zA-Z-!_.*'()]+)/g`. You passed: " +
13
+ siteName +
14
+ '. Check for invalid characters.');
15
+ }
16
+ };
17
+ exports.validateSiteName = validateSiteName;
package/package.json ADDED
@@ -0,0 +1,57 @@
1
+ {
2
+ "name": "@remotion/cloudrun",
3
+ "version": "4.1.0-alpha10",
4
+ "description": "GCP Cloud Run alternative to lambda rendering",
5
+ "main": "dist/index.js",
6
+ "dependencies": {
7
+ "@google-cloud/artifact-registry": "^2.2.2",
8
+ "@google-cloud/functions-framework": "^3.1.3",
9
+ "@google-cloud/run": "^0.4.0",
10
+ "@google-cloud/storage": "^6.9.1",
11
+ "@google-cloud/resource-manager": "^4.3.0",
12
+ "@google-cloud/logging": "^10.5.0",
13
+ "google-auth-library": "^8.7.0",
14
+ "zod": "^3.21.4",
15
+ "@remotion/bundler": "4.1.0-alpha10",
16
+ "@remotion/cli": "4.1.0-alpha10",
17
+ "remotion": "4.1.0-alpha10",
18
+ "@remotion/renderer": "4.1.0-alpha10"
19
+ },
20
+ "devDependencies": {
21
+ "@jonny/eslint-config": "3.0.266",
22
+ "@types/node": "^18.11.2",
23
+ "@types/minimist": "1.2.2",
24
+ "eslint": "8.42.0",
25
+ "prettier": "^2.7.1",
26
+ "prettier-plugin-organize-imports": "^3.2.2",
27
+ "ts-node": "^10.8.0",
28
+ "typescript": "4.7.2",
29
+ "vitest": "0.24.3",
30
+ "@remotion/compositor-linux-x64-gnu": "4.1.0-alpha10"
31
+ },
32
+ "exports": {
33
+ "./package.json": "./package.json",
34
+ ".": "./dist/index.js",
35
+ "./defaults": "./dist/defaults.js",
36
+ "./regions": "./dist/regions.js",
37
+ "./permissions.json": "./dist/shared/sa-permissions.json"
38
+ },
39
+ "typesVersions": {
40
+ ">=1.0": {
41
+ "defaults": [
42
+ "dist/defaults.d.ts"
43
+ ],
44
+ "regions": [
45
+ "dist/regions.d.ts"
46
+ ]
47
+ }
48
+ },
49
+ "scripts": {
50
+ "build": "tsc -d && cp src/shared/sa-permissions.json dist/shared/sa-permissions.json && pnpm run buildContainer && pnpm run tarInstaller",
51
+ "buildContainer": "ts-node src/admin/bundle-renderLogic.ts",
52
+ "tarInstaller": "ts-node src/admin/bundle-installer.ts",
53
+ "watch": "tsc -w",
54
+ "lint": "eslint src --ext ts,tsx",
55
+ "test": "vitest --run"
56
+ }
57
+ }
package/readme.md ADDED
@@ -0,0 +1,3 @@
1
+ # @remotion/cloudrun
2
+
3
+ This package provides Node.JS APIs and a CLI for rendering Remotion videos on GCP Cloud Run. See https://remotion.dev/docs/cloudrun for documentation.