@jskit-ai/connectors-core 0.2.4 → 0.2.5

package/locales/en.json

@@ -27,6 +27,7 @@
         "schemaVersionUnsupported": "Use numeric schemaVersion 1; other versions require an explicit migration.",
         "scopeRequired": "Select at least one permission.",
         "scopeUnsupported": "A selected permission is not supported by this provider configuration.",
+        "secretReference": "Use a reference such as env:VARIABLE_NAME.",
         "serviceAccountPerUser": "A service account cannot connect as each app user.",
         "serviceAccountRegistration": "Service-account credentials do not use a browser OAuth registration.",
         "stableName": "Use a stable lowercase name containing letters, digits and hyphens.",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jskit-ai/connectors-core",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Portable integration configuration and server-side account connection runtime.",
   "type": "module",
   "scripts": {

package/src/shared/configuration.js

@@ -92,17 +92,23 @@ const FIELD_ERRORS = Object.freeze({
   clientId: { code: "connectors.configuration.clientId", message: "Check this provider's client identifier." },
   requiredScopes: { code: "connectors.configuration.requiredScopes", message: "Include this provider's required permissions." },
   scopeUnsupported: { code: "connectors.configuration.scopeUnsupported", message: "A selected permission is not supported by this provider configuration." },
-  scopeRequired: { code: "connectors.configuration.scopeRequired", message: "Select at least one permission." }
+  scopeRequired: { code: "connectors.configuration.scopeRequired", message: "Select at least one permission." },
+  secretReference: { code: "connectors.configuration.secretReference", message: "Use a reference such as env:VARIABLE_NAME." }
 });
 
-// A schema validation error's field errors with the codes the validator gave them.
+// A schema validation error's field errors with the codes the validator gave them. A
+// credential reference that fails secretReference's pattern says what a reference looks like.
 function schemaFieldErrors(error, fallback, prefix = "") {
   const messages = {};
   const codes = {};
   for (const [field, message] of Object.entries(error.fieldErrors || fallback)) {
-    messages[`${prefix}${field}`] = message;
     const coded = error.fieldErrorCodes?.[field];
-    if (coded) codes[`${prefix}${field}`] = coded;
+    if (coded?.code === "kernel.validation.field.pattern" && coded.params.pattern === secretReference.pattern) {
+      messages[`${prefix}${field}`] = FIELD_ERRORS.secretReference;
+    } else {
+      messages[`${prefix}${field}`] = message;
+      if (coded) codes[`${prefix}${field}`] = coded;
+    }
   }
   return { messages, codes };
 }

package/test/connectionService.test.js

@@ -12,6 +12,8 @@ import { googleCalendarProvider } from "../../connector-google-calendar/src/serv
 import { createConnectionService, createConnectorsFeature, createEnvironmentReferenceResolver } from "../src/server/index.js";
 import { integrationsSchema, parseIntegrationConfiguration, validateIntegrationConfiguration } from "../src/shared/configuration.js";
 import { clickhouseProvider } from "../../connectors-catalog/src/server/clickhouse.js";
+import { algoliaDefinition } from "../../connectors-catalog/src/shared/algolia.js";
+import { firebaseCloudMessagingDefinition, firebaseMessagingScope } from "../../connectors-catalog/src/shared/firebase-cloud-messaging.js";
 
 const listScope = "https://www.googleapis.com/auth/calendar.calendarlist.readonly";
 const eventsScope = "https://www.googleapis.com/auth/calendar.events.readonly";
@@ -489,6 +491,44 @@ test("reference fields reject pasted web URLs while preserving environment and c
   }
 });
 
+function assertReferenceFieldError(input, providers, field) {
+  assert.throws(() => validateIntegrationConfiguration(input, { providers }), (error) => {
+    assert.equal(error.fieldErrors[field], "Use a reference such as env:VARIABLE_NAME.", field);
+    assert.deepEqual(error.fieldErrorCodes[field], { code: "connectors.configuration.secretReference", params: {} }, field);
+    return true;
+  });
+}
+
+test("a secretRef that is not a reference says to use a reference such as env:VARIABLE_NAME", () => {
+  for (const value of ["https://x", "plain"]) {
+    assertReferenceFieldError(databaseConfiguration({ method: "api-key", secretRef: value }), [clickhouseProvider], "integrations.database.authentication.secretRef");
+  }
+});
+
+test("a registration clientSecretRef that is not a reference says to use a reference such as env:VARIABLE_NAME", () => {
+  for (const value of ["https://x", "plain"]) {
+    const input = configuration();
+    input.registrations.google.clientSecretRef = value;
+    assertReferenceFieldError(input, [googleCalendarProvider], "registrations.google.clientSecretRef");
+  }
+});
+
+test("a provider setting's reference says the same, while its other pattern failures keep the kernel's sentence", () => {
+  const input = { schemaVersion: 1, registrations: {}, integrations: {
+    search: { provider: "algolia", accountMode: "shared", scopes: [], authentication: { method: "api-key", secretRef: "env:ALGOLIA_KEY" },
+      settings: { applicationId: "APP1", publicApiKeyRef: "raw-search-key" } },
+    push: { provider: "firebase-cloud-messaging", accountMode: "shared", scopes: [firebaseMessagingScope], authentication: { method: "service-account", secretRef: "env:FCM" },
+      settings: { projectId: "push-project", clientMode: "web", apiKey: "not-a-key" } }
+  } };
+  const providers = [algoliaDefinition, firebaseCloudMessagingDefinition];
+  assertReferenceFieldError(input, providers, "integrations.search.settings.publicApiKeyRef");
+  assert.throws(() => validateIntegrationConfiguration(input, { providers }), (error) => {
+    assert.equal(error.fieldErrors["integrations.push.settings.apiKey"], "Value does not match the required pattern.");
+    assert.equal(error.fieldErrorCodes["integrations.push.settings.apiKey"].code, "kernel.validation.field.pattern");
+    return true;
+  });
+});
+
 test("the exported configuration contract enforces reference constraints for every credential field", async (t) => {
   const app = Fastify({ ajv: { plugins: [(ajv) => ajv.addKeyword("x-json-rest-schema")] } });
   t.after(() => app.close());