firebase-contract 0.1.0-rc.13 → 0.1.0-rc.14

package/README.md

@@ -200,6 +200,14 @@ typo like `optionnal:` must not quietly turn into a required field. There is
 no `version:` field: nothing consumes one, so accepting it would only fake a
 compatibility mechanism that does not exist.
 
+**Out-of-vocabulary values are errors too.** A value outside a field's fixed
+set is `INVALID_VALUE` rather than a silent coercion: `auth: PUBILC` does not
+quietly become `NO_ACCESS`, `dir: Dsec` does not become `ASC`, and a mistyped
+`action` / `single` / `keyArg` / `style.*` is not dropped. The one exception is
+`where.op`, which is warned (`UNKNOWN_WHERE_OP`) not errored — it is emitted
+verbatim into GraphQL and the recognized-operator list may lag Data Connect, so
+a typo is surfaced without rejecting a valid-but-unlisted operator.
+
 ```yaml
 imports:
   - ./apps/shop/data-connect/schema.yml

package/dist/lib/_internal/ir/build-ir.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build-ir.d.ts","sourceRoot":"","sources":["../../../../src/lib/_internal/ir/build-ir.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAS,MAAM,mBAAmB,CAAA;AACrD,OAAO,EAGL,WAAW,EAIZ,MAAM,2BAA2B,CAAA;AAElC,OAAO,EAGL,EAAE,EAgBH,MAAM,SAAS,CAAA;AAEhB,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,EAAE,CAAA;IACN,WAAW,EAAE,UAAU,EAAE,CAAA;CAC1B;AAqLD;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,GAAI,WAAW,WAAW,EAAE,KAAG,aAkQlD,CAAA"}
+{"version":3,"file":"build-ir.d.ts","sourceRoot":"","sources":["../../../../src/lib/_internal/ir/build-ir.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAkB,MAAM,mBAAmB,CAAA;AAC9D,OAAO,EAGL,WAAW,EAIZ,MAAM,2BAA2B,CAAA;AAElC,OAAO,EAGL,EAAE,EAgBH,MAAM,SAAS,CAAA;AAEhB,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,EAAE,CAAA;IACN,WAAW,EAAE,UAAU,EAAE,CAAA;CAC1B;AAyPD;;;;;;;;GAQG;AACH,eAAO,MAAM,OAAO,GAAI,WAAW,WAAW,EAAE,KAAG,aAkQlD,CAAA"}

package/dist/lib/_internal/ir/build-ir.js

@@ -1,4 +1,4 @@
-import { error } from '../diagnostics.js';
+import { error, warning } from '../diagnostics.js';
 import { isScalarType, } from './ir.js';
 const resolveTypeRef = (typeName, enumNames, modelNames) => {
     if (isScalarType(typeName)) {
@@ -58,6 +58,42 @@ const OPERATION_TYPES = new Set(['query', 'mutation']);
 const MUTATION_ACTIONS = new Set(['insert', 'update', 'upsert', 'delete']);
 const AUTH_LEVELS = new Set(['NO_ACCESS', 'PUBLIC', 'USER']);
 const API_KINDS = new Set(['callable', 'https', 'task', 'pubsub']);
+const ORDER_DIRS = new Set(['ASC', 'DESC']);
+const SINGLE_KINDS = new Set(['key', 'id']);
+/** Per-key valid values for an operation's `style:` block. */
+const STYLE_VALUES = {
+    signature: new Set(['inline', 'multi']),
+    args: new Set(['inline', 'multi']),
+    data: new Set(['inline', 'multi', 'compact']),
+    orderBy: new Set(['bare', 'array']),
+    auth: new Set(['inline', 'newline']),
+    key: new Set(['inline', 'multi']),
+    and: new Set(['inline', 'multi']),
+    where: new Set(['inline', 'multi']),
+};
+/**
+ * Data Connect scalar/list filter operators. A `where.op` outside this set is
+ * warned (not errored): the value is emitted verbatim into GraphQL, so a typo
+ * ships broken schema, but the list may lag DC additions — a warning surfaces
+ * typos without rejecting a valid-but-unlisted operator.
+ */
+const WHERE_OPS = new Set([
+    'eq', 'ne', 'gt', 'ge', 'lt', 'le', 'in', 'nin', 'isNull',
+    'contains', 'startsWith', 'endsWith',
+    'includes', 'excludes', 'includesAll', 'includesAny', 'excludesAll', 'excludesAny',
+]);
+/**
+ * The contract is the single source of truth, so an out-of-vocabulary *value* is
+ * as much a defect as an unknown key: it is silently coerced to a default or
+ * dropped, and the generated output no longer reflects what was written. These
+ * checks turn that silent coercion into a diagnostic at the coercion site (the
+ * raw value is still in hand here; it is lost once the IR is built).
+ */
+const checkValue = (diagnostics, file, path, key, value, valid) => {
+    if (value !== undefined && !valid.has(value)) {
+        diagnostics.push(error('INVALID_VALUE', `Invalid ${key} "${value}" — expected one of ${[...valid].join(' | ')}`, { file, path }));
+    }
+};
 const buildSelect = (entries) => entries.map(entry => ({
     field: entry.field,
     ...(entry.select !== undefined ? { select: buildSelect(entry.select) } : {}),
@@ -65,7 +101,27 @@ const buildSelect = (entries) => entries.map(entry => ({
     ...(entry.alias !== undefined ? { alias: entry.alias } : {}),
     ...(entry.args !== undefined ? { args: entry.args } : {}),
 }));
-const buildOperation = (name, raw, sourceFile) => {
+const buildOperation = (name, raw, sourceFile, diagnostics) => {
+    const path = `operations.${name}`;
+    checkValue(diagnostics, sourceFile, `${path}.type`, 'type', raw.type, OPERATION_TYPES);
+    checkValue(diagnostics, sourceFile, `${path}.auth`, 'auth', raw.auth, AUTH_LEVELS);
+    checkValue(diagnostics, sourceFile, `${path}.action`, 'action', raw.action, MUTATION_ACTIONS);
+    checkValue(diagnostics, sourceFile, `${path}.single`, 'single', raw.single, SINGLE_KINDS);
+    checkValue(diagnostics, sourceFile, `${path}.keyArg`, 'keyArg', raw.keyArg, SINGLE_KINDS);
+    for (const o of raw.orderBy ?? [])
+        checkValue(diagnostics, sourceFile, `${path}.orderBy`, 'orderBy dir', o.dir, ORDER_DIRS);
+    for (const [k, v] of Object.entries(raw.style ?? {})) {
+        if (STYLE_VALUES[k])
+            checkValue(diagnostics, sourceFile, `${path}.style.${k}`, `style.${k}`, v, STYLE_VALUES[k]);
+    }
+    for (const w of raw.where ?? []) {
+        if (w.op !== undefined && !WHERE_OPS.has(w.op)) {
+            diagnostics.push(warning('UNKNOWN_WHERE_OP', `Unknown where operator "${w.op}" on ${path} — emitted verbatim into GraphQL; verify it is a valid Data Connect operator`, {
+                file: sourceFile,
+                path: `${path}.where`,
+            }));
+        }
+    }
     const op = {
         name,
         operationType: (OPERATION_TYPES.has(raw.type) ? raw.type : 'query'),
@@ -129,7 +185,8 @@ const buildApiPayload = (raw, enumNames, modelNames) => {
         payload.model = raw.model;
     return payload;
 };
-const buildApi = (name, raw, sourceFile, enumNames, modelNames) => {
+const buildApi = (name, raw, sourceFile, enumNames, modelNames, diagnostics) => {
+    checkValue(diagnostics, sourceFile, `apis.${name}.kind`, 'kind', raw.kind, API_KINDS);
     const api = {
         name,
         kind: (API_KINDS.has(raw.kind) ? raw.kind : 'callable'),
@@ -316,11 +373,11 @@ export const buildIr = (documents) => {
     }
     const operations = [];
     for (const { name, doc } of operationEntries) {
-        operations.push(buildOperation(name, doc.operations[name], doc.filePath));
+        operations.push(buildOperation(name, doc.operations[name], doc.filePath, diagnostics));
     }
     const apis = [];
     for (const [name, doc] of apiSources) {
-        apis.push(buildApi(name, doc.apis[name], doc.filePath, enumNames, modelNames));
+        apis.push(buildApi(name, doc.apis[name], doc.filePath, enumNames, modelNames, diagnostics));
     }
     const unionSources = new Map();
     for (const doc of documents) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "firebase-contract",
-  "version": "0.1.0-rc.13",
+  "version": "0.1.0-rc.14",
   "type": "module",
   "bin": {
     "firebase-contract": "./dist/lib/cli/index.js",