@causa/workspace-google 0.12.2 → 0.13.0-rc.2

package/dist/functions/project/push-artefact-cloud-functions.call.d.ts

@@ -0,0 +1,3 @@
+import type { WorkspaceContext } from '@causa/workspace';
+import type { ProjectPushArtefactForCloudFunctions } from './push-artefact-cloud-functions.js';
+export default function call(this: ProjectPushArtefactForCloudFunctions, context: WorkspaceContext): Promise<string>;

package/dist/functions/project/push-artefact-cloud-functions.call.js

@@ -0,0 +1,19 @@
+import { ArtefactAlreadyExistsError } from '@causa/workspace-core';
+import { rm } from 'fs/promises';
+import { CloudStorageService } from '../../services/storage.js';
+export default async function call(context) {
+    context.logger.info(`🚚 Pushing Cloud Functions archive to Cloud Storage.`);
+    const storageService = context.service(CloudStorageService);
+    const destination = storageService.getFileFromGsUri(this.destination);
+    if (!this.overwrite) {
+        const [exists] = await destination.exists();
+        if (exists) {
+            throw new ArtefactAlreadyExistsError(this.destination);
+        }
+    }
+    await destination.bucket.upload(this.artefact, { destination });
+    context.logger.info(`🚚 Successfully pushed archive to '${this.destination}'.`);
+    context.logger.debug(`🔥 Removing local artefact '${this.artefact}'.`);
+    await rm(this.artefact);
+    return this.destination;
+}

package/dist/functions/project/push-artefact-cloud-functions.js

@@ -1,7 +1,5 @@
-import { WorkspaceContext } from '@causa/workspace';
-import { ArtefactAlreadyExistsError, ProjectPushArtefact, } from '@causa/workspace-core';
-import { rm } from 'fs/promises';
-import { CloudStorageService } from '../../services/index.js';
+import { callDeferred, WorkspaceContext } from '@causa/workspace';
+import { ProjectPushArtefact, } from '@causa/workspace-core';
 /**
  * Implements the {@link ProjectPushArtefact} function for Cloud Functions projects.
  * This copies the local archive of the Cloud Functions project to the Google Cloud Storage URI set in
@@ -9,20 +7,7 @@ import { CloudStorageService } from '../../services/index.js';
  */
 export class ProjectPushArtefactForCloudFunctions extends ProjectPushArtefact {
     async _call(context) {
-        context.logger.info(`🚚 Pushing Cloud Functions archive to Cloud Storage.`);
-        const storageService = context.service(CloudStorageService);
-        const destination = storageService.getFileFromGsUri(this.destination);
-        if (!this.overwrite) {
-            const [exists] = await destination.exists();
-            if (exists) {
-                throw new ArtefactAlreadyExistsError(this.destination);
-            }
-        }
-        await destination.bucket.upload(this.artefact, { destination });
-        context.logger.info(`🚚 Successfully pushed archive to '${this.destination}'.`);
-        context.logger.debug(`🔥 Removing local artefact '${this.artefact}'.`);
-        await rm(this.artefact);
-        return this.destination;
+        return await callDeferred(this, context, import.meta.url);
     }
     _supports(context) {
         const conf = context.asConfiguration();

package/dist/functions/secret/fetch-access-token.call.d.ts

@@ -0,0 +1,3 @@
+import type { WorkspaceContext } from '@causa/workspace';
+import { type SecretFetchForGoogleAccessToken } from './fetch-access-token.js';
+export default function call(this: SecretFetchForGoogleAccessToken, context: WorkspaceContext): Promise<string>;

package/dist/functions/secret/fetch-access-token.call.js

@@ -0,0 +1,10 @@
+import { GoogleApisService } from '../../services/google-apis.js';
+import { AuthClientResponseError, } from './fetch-access-token.js';
+export default async function call(context) {
+    const authClient = await context.service(GoogleApisService).getAuthClient();
+    const { token } = await authClient.getAccessToken();
+    if (!token) {
+        throw new AuthClientResponseError();
+    }
+    return token;
+}

package/dist/functions/secret/fetch-access-token.js

@@ -1,5 +1,4 @@
-import { SecretFetch, WorkspaceContext } from '@causa/workspace';
-import { GoogleApisService } from '../../services/index.js';
+import { callDeferred, SecretFetch, WorkspaceContext } from '@causa/workspace';
 /**
  * An error thrown when the auth client does not return a token.
  */
@@ -17,12 +16,7 @@ export class AuthClientResponseError extends Error {
  */
 export class SecretFetchForGoogleAccessToken extends SecretFetch {
     async _call(context) {
-        const authClient = await context.service(GoogleApisService).getAuthClient();
-        const { token } = await authClient.getAccessToken();
-        if (!token) {
-            throw new AuthClientResponseError();
-        }
-        return token;
+        return await callDeferred(this, context, import.meta.url);
     }
     _supports() {
         return this.backend === 'google.accessToken';

package/dist/functions/secret/fetch-secret-manager.call.d.ts

@@ -0,0 +1,3 @@
+import { type WorkspaceContext } from '@causa/workspace';
+import { type SecretFetchForGoogleSecretManager } from './fetch-secret-manager.js';
+export default function call(this: SecretFetchForGoogleSecretManager, context: WorkspaceContext): Promise<string>;

package/dist/functions/secret/fetch-secret-manager.call.js

@@ -0,0 +1,32 @@
+import { InvalidSecretDefinitionError, } from '@causa/workspace';
+import { GoogleSecretManagerService } from '../../services/secret-manager.js';
+import { UndefinedDefaultGcpProjectError, UnexpectedSecretValueError, } from './fetch-secret-manager.js';
+/**
+ * The regular expression used to match the (Secret Manager) secret ID/name, and possibly its version and project.
+ * [projects/<projectId>/secrets]<secretName>[/versions/<version>]
+ */
+const SECRET_ID_REGEX = /^(?:projects\/(?<projectId>[\w-]+)\/secrets\/)?(?<secretName>[\w-]+)(?:\/versions\/(?<version>(\d+|latest)))?$/;
+export default async function call(context) {
+    const id = this.configuration.id;
+    if (!id) {
+        throw new InvalidSecretDefinitionError(`Missing 'id' field that should reference the secret.`);
+    }
+    const match = id.match(SECRET_ID_REGEX);
+    const secretName = match?.groups?.secretName;
+    if (!secretName) {
+        throw new InvalidSecretDefinitionError(`Failed to parse secret reference '${id}'.`);
+    }
+    const { client, defaultProject } = context.service(GoogleSecretManagerService);
+    const project = match?.groups?.projectId ?? defaultProject;
+    const version = match?.groups?.version ?? 'latest';
+    if (!project) {
+        throw new UndefinedDefaultGcpProjectError();
+    }
+    const name = client.secretVersionPath(project, secretName, version);
+    const [value] = await client.accessSecretVersion({ name });
+    const bufferData = value.payload?.data;
+    if (!bufferData || typeof bufferData !== 'object') {
+        throw new UnexpectedSecretValueError();
+    }
+    return bufferData.toString();
+}

package/dist/functions/secret/fetch-secret-manager.js

@@ -1,10 +1,4 @@
-import { InvalidSecretDefinitionError, SecretFetch, WorkspaceContext, } from '@causa/workspace';
-import { GoogleSecretManagerService } from '../../services/index.js';
-/**
- * The regular expression used to match the (Secret Manager) secret ID/name, and possibly its version and project.
- * [projects/<projectId>/secrets]<secretName>[/versions/<version>]
- */
-const SECRET_ID_REGEX = /^(?:projects\/(?<projectId>[\w-]+)\/secrets\/)?(?<secretName>[\w-]+)(?:\/versions\/(?<version>(\d+|latest)))?$/;
+import { callDeferred, SecretFetch, WorkspaceContext } from '@causa/workspace';
 /**
  * An error thrown when the default GCP project is needed to look up a secret but it has not been defined.
  */
@@ -39,28 +33,7 @@ export class UnexpectedSecretValueError extends Error {
  */
 export class SecretFetchForGoogleSecretManager extends SecretFetch {
     async _call(context) {
-        const id = this.configuration.id;
-        if (!id) {
-            throw new InvalidSecretDefinitionError(`Missing 'id' field that should reference the secret.`);
-        }
-        const match = id.match(SECRET_ID_REGEX);
-        const secretName = match?.groups?.secretName;
-        if (!secretName) {
-            throw new InvalidSecretDefinitionError(`Failed to parse secret reference '${id}'.`);
-        }
-        const { client, defaultProject } = context.service(GoogleSecretManagerService);
-        const project = match?.groups?.projectId ?? defaultProject;
-        const version = match?.groups?.version ?? 'latest';
-        if (!project) {
-            throw new UndefinedDefaultGcpProjectError();
-        }
-        const name = client.secretVersionPath(project, secretName, version);
-        const [value] = await client.accessSecretVersion({ name });
-        const bufferData = value.payload?.data;
-        if (!bufferData || typeof bufferData !== 'object') {
-            throw new UnexpectedSecretValueError();
-        }
-        return bufferData.toString();
+        return await callDeferred(this, context, import.meta.url);
     }
     _supports() {
         return this.backend === 'google.secretManager';

package/dist/functions/typescript/get-decorator-renderer-google-firestore.d.ts

@@ -1,9 +1,9 @@
 import { WorkspaceContext } from '@causa/workspace';
-import { TypeScriptGetDecoratorRenderer, TypeScriptWithDecoratorsRenderer } from '@causa/workspace-typescript';
+import { TypeScriptGetDecoratorRenderer, type TypeScriptWithDecoratorsRendererType } from '@causa/workspace-typescript';
 /**
- * Implements {@link TypeScriptGetDecoratorRenderer} for the {@link GoogleFirestoreRenderer}.
+ * Implements {@link TypeScriptGetDecoratorRenderer} for the `GoogleFirestoreRenderer`.
  */
 export declare class TypeScriptGetDecoratorRendererForGoogleFirestore extends TypeScriptGetDecoratorRenderer {
-    _call(): new (...args: any[]) => TypeScriptWithDecoratorsRenderer;
+    _call(): Promise<TypeScriptWithDecoratorsRendererType>;
     _supports(context: WorkspaceContext): boolean;
 }

package/dist/functions/typescript/get-decorator-renderer-google-firestore.js

@@ -1,11 +1,11 @@
 import { WorkspaceContext } from '@causa/workspace';
-import { TypeScriptGetDecoratorRenderer, TypeScriptWithDecoratorsRenderer, } from '@causa/workspace-typescript';
-import { GoogleFirestoreRenderer } from '../../code-generation/index.js';
+import { TypeScriptGetDecoratorRenderer, } from '@causa/workspace-typescript';
 /**
- * Implements {@link TypeScriptGetDecoratorRenderer} for the {@link GoogleFirestoreRenderer}.
+ * Implements {@link TypeScriptGetDecoratorRenderer} for the `GoogleFirestoreRenderer`.
  */
 export class TypeScriptGetDecoratorRendererForGoogleFirestore extends TypeScriptGetDecoratorRenderer {
-    _call() {
+    async _call() {
+        const { GoogleFirestoreRenderer } = await import('../../code-generation/index.js');
         return GoogleFirestoreRenderer;
     }
     _supports(context) {

package/dist/functions/typescript/get-decorator-renderer-google-spanner.d.ts

@@ -1,9 +1,9 @@
 import { WorkspaceContext } from '@causa/workspace';
-import { TypeScriptGetDecoratorRenderer, TypeScriptWithDecoratorsRenderer } from '@causa/workspace-typescript';
+import { TypeScriptGetDecoratorRenderer, type TypeScriptWithDecoratorsRendererType } from '@causa/workspace-typescript';
 /**
- * Implements {@link TypeScriptGetDecoratorRenderer} for the {@link GoogleSpannerRenderer}.
+ * Implements {@link TypeScriptGetDecoratorRenderer} for the `GoogleSpannerRenderer`.
  */
 export declare class TypeScriptGetDecoratorRendererForGoogleSpanner extends TypeScriptGetDecoratorRenderer {
-    _call(): new (...args: any[]) => TypeScriptWithDecoratorsRenderer;
+    _call(): Promise<TypeScriptWithDecoratorsRendererType>;
     _supports(context: WorkspaceContext): boolean;
 }

package/dist/functions/typescript/get-decorator-renderer-google-spanner.js

@@ -1,11 +1,11 @@
 import { WorkspaceContext } from '@causa/workspace';
-import { TypeScriptGetDecoratorRenderer, TypeScriptWithDecoratorsRenderer, } from '@causa/workspace-typescript';
-import { GoogleSpannerRenderer } from '../../code-generation/index.js';
+import { TypeScriptGetDecoratorRenderer, } from '@causa/workspace-typescript';
 /**
- * Implements {@link TypeScriptGetDecoratorRenderer} for the {@link GoogleSpannerRenderer}.
+ * Implements {@link TypeScriptGetDecoratorRenderer} for the `GoogleSpannerRenderer`.
  */
 export class TypeScriptGetDecoratorRendererForGoogleSpanner extends TypeScriptGetDecoratorRenderer {
-    _call() {
+    async _call() {
+        const { GoogleSpannerRenderer } = await import('../../code-generation/index.js');
         return GoogleSpannerRenderer;
     }
     _supports(context) {

package/dist/index.d.ts

@@ -1,5 +1,4 @@
 import type { ModuleRegistrationFunction } from '@causa/workspace';
-export * from './configurations/index.js';
-export * from './services/index.js';
 declare const registerModule: ModuleRegistrationFunction;
+export * from './configurations/index.js';
 export default registerModule;

package/dist/index.js

@@ -1,7 +1,6 @@
 import { registerFunctions } from './functions/index.js';
-export * from './configurations/index.js';
-export * from './services/index.js';
 const registerModule = async (context) => {
     registerFunctions(context);
 };
+export * from './configurations/index.js';
 export default registerModule;

package/dist/services/firebase-emulator.d.ts

@@ -1,5 +1,5 @@
 import { WorkspaceContext } from '@causa/workspace';
-import { type DockerContainerPublish, DockerEmulatorService } from '@causa/workspace-core';
+import { type DockerContainerPublish, DockerEmulatorService } from '@causa/workspace-core/services';
 /**
  * Options when starting a Firebase emulator.
  */

package/dist/services/firebase-emulator.js

@@ -1,5 +1,5 @@
 import { WorkspaceContext } from '@causa/workspace';
-import { DockerEmulatorService, } from '@causa/workspace-core';
+import { DockerEmulatorService, } from '@causa/workspace-core/services';
 import { getLocalGcpProject, } from '../configurations/index.js';
 /**
  * The Docker image providing the `firebase` CLI.

package/dist/services/gcloud-emulator.d.ts

@@ -1,5 +1,5 @@
 import { WorkspaceContext } from '@causa/workspace';
-import { type DockerContainerMount, type DockerContainerPublish, DockerEmulatorService } from '@causa/workspace-core';
+import { type DockerContainerMount, type DockerContainerPublish, DockerEmulatorService } from '@causa/workspace-core/services';
 /**
  * Options when specifying an availability endpoint when starting an emulator.
  */

package/dist/services/gcloud-emulator.js

@@ -1,5 +1,5 @@
 import { WorkspaceContext } from '@causa/workspace';
-import { DockerEmulatorService, } from '@causa/workspace-core';
+import { DockerEmulatorService, } from '@causa/workspace-core/services';
 import { getLocalGcpProject, } from '../configurations/index.js';
 /**
  * The URI for the Dockerized `gcloud` command, provided by Google.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@causa/workspace-google",
-  "version": "0.12.2",
+  "version": "0.13.0-rc.2",
   "description": "The Causa workspace module providing many functionalities related to GCP and its services.",
   "repository": {
     "type": "git",
@@ -14,7 +14,8 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "exports": {
-    ".": "./dist/index.js"
+    ".": "./dist/index.js",
+    "./services": "./dist/services/index.js"
   },
   "files": [
     "dist/",
@@ -25,17 +26,19 @@
   "scripts": {
     "prebuild": "rimraf ./dist",
     "build": "tsc -p tsconfig.build.json",
-    "postbuild": "copyfiles -u 1 src/**/assets/**/* dist/",
+    "postbuild": "copyfiles -u 1 src/**/assets/**/* dist/ && node transform-schemas.mjs",
     "format": "prettier --write \"src/**/*.ts\"",
     "lint": "eslint \"src/**/*.ts\"",
     "test": "NODE_OPTIONS=\"--experimental-vm-modules --no-warnings=ExperimentalWarning\" jest",
-    "test:cov": "npm run test -- --coverage"
+    "test:cov": "npm run test -- --coverage",
+    "typecheck": "tsc --noEmit",
+    "generateConfigurationSchemas": "cs model genCode && perl -pi -e 's|\\@causa/runtime|\\@causa/workspace/validation|g' src/configurations/generated.ts"
   },
   "dependencies": {
-    "@causa/cli": ">= 0.6.4 < 1.0.0",
-    "@causa/workspace": ">= 0.19.2 < 1.0.0",
-    "@causa/workspace-core": ">= 0.26.0 < 1.0.0",
-    "@causa/workspace-typescript": ">= 0.16.0 < 1.0.0",
+    "@causa/cli": ">= 0.6.5 < 1.0.0",
+    "@causa/workspace": ">= 0.22.1 < 1.0.0",
+    "@causa/workspace-core": ">= 0.27.0-rc.2 < 1.0.0",
+    "@causa/workspace-typescript": ">= 0.17.0-rc.2 < 1.0.0",
     "@google-cloud/apikeys": "^2.2.1",
     "@google-cloud/bigquery": "^8.1.1",
     "@google-cloud/iam-credentials": "^4.2.1",
@@ -54,7 +57,7 @@
     "google-gax": "5.0.6",
     "googleapis": "^171.4.0",
     "micromatch": "^4.0.8",
-    "pino": "^10.3.0",
+    "pino": "^10.3.1",
     "quicktype-core": "^23.2.6"
   },
   "devDependencies": {
@@ -63,7 +66,7 @@
     "@tsconfig/node20": "^20.1.9",
     "@types/jest": "^30.0.0",
     "@types/micromatch": "^4.0.10",
-    "@types/node": "^22.19.9",
+    "@types/node": "^22.19.11",
     "copyfiles": "^2.4.1",
     "eslint": "^9.39.2",
     "eslint-config-prettier": "^10.1.8",
@@ -73,6 +76,6 @@
     "rimraf": "^6.1.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.54.0"
+    "typescript-eslint": "^8.55.0"
   }
 }