@google-cloud/kcmd 0.2.0 → 0.2.1

package/build/ts/kcmd/semantic/osi_converter.js

@@ -83,15 +83,13 @@ exports.modelDocument = modelDocument;
 exports.compact = compact;
 exports.nonEmpty = nonEmpty;
 const yaml = __importStar(require("yaml"));
-const deployment_target_1 = require("./deployment_target");
 const ir_1 = require("./ir");
 const loader_1 = require("./loader");
 const names_1 = require("./names");
 const resolve_inheritance_1 = require("./resolve_inheritance");
 const resolve_profiles_1 = require("./resolve_profiles");
 // The vendor tag for Google-specific extension blocks on the IR (kept in sync
-// with loader.GOOGLE_VENDOR). In the Google flavor, a model-level deployment
-// target list rides in one as a folded shim alongside `model.deployments`.
+// with loader.GOOGLE_VENDOR).
 const GOOGLE_VENDOR = 'GOOGLE';
 // The dialect label for the IR's target/canonical `expression` when `dialects`
 // is absent and `stringForm` is not set. BIGQUERY is the loader's default
@@ -340,17 +338,16 @@ function modelDoc(model, warnings, logical, version) {
             `at least one and will not load until an entity is present.`);
     }
     const tableKey = isGoogleVersion ? 'entities' : 'datasets';
-    // Under GOOGLE_VERSION, deployments come from `model.deployments`, or from a
-    // GOOGLE `deploymentTargets` block when that is empty. Under OSSIE_VERSION,
-    // named deployments and profiles go in a GOOGLE block on the model.
+    // Under GOOGLE_VERSION, deployments come from `model.deployments`. Under
+    // OSSIE_VERSION, named deployments and profiles go in a GOOGLE block on the
+    // model.
     const namedDeployments = (model.deployments ?? []).map(d => compact({
         name: d.name,
         target: d.target,
         profile: d.profile
     }));
     const deployments = placement.model.deployments === 'native' ?
-        nonEmpty(namedDeployments.length ? namedDeployments :
-            deploymentsFromGoogleExtensions(model)) :
+        nonEmpty(namedDeployments) :
         undefined;
     const blockProfiles = placement.model.profiles === 'block' ?
         nonEmpty(profileDocuments(model, warnings).map(p => p.doc)) :
@@ -385,8 +382,7 @@ function modelDoc(model, warnings, logical, version) {
         constraints: placement.model.constraints === 'native' ?
             nonEmpty((model.constraints ?? []).map(c => constraintDoc(c))) :
             undefined,
-        custom_extensions: customExtensionsDoc(model.customExtensions, `model '${model.name}'`, isGoogleVersion, 
-        /* isModel= */ true, warnings, /* isField= */ false, blockPayload),
+        custom_extensions: customExtensionsDoc(model.customExtensions, `model '${model.name}'`, isGoogleVersion, warnings, /* isField= */ false, blockPayload),
     });
 }
 // Warns about each IR construct OSSIE_VERSION has no representation for,
@@ -449,8 +445,7 @@ function datasetDoc(entity, warnings, logical, version) {
         ai_context: aiContextDoc(entity.aiContext, isGoogleVersion),
         fields: nonEmpty((entity.fields ?? [])
             .map(f => fieldDoc(f, warnings, logical || (isGoogleVersion && !!entity.abstract), isGoogleVersion))),
-        custom_extensions: customExtensionsDoc(entity.customExtensions, `entity '${entity.name}'`, isGoogleVersion, 
-        /* isModel= */ false, warnings, /* isField= */ false, blockPayload),
+        custom_extensions: customExtensionsDoc(entity.customExtensions, `entity '${entity.name}'`, isGoogleVersion, warnings, /* isField= */ false, blockPayload),
     });
 }
 // Filters out the IR's `'Opaque'` placeholder so untyped fields and metrics
@@ -482,8 +477,7 @@ function fieldDoc(field, warnings, logical, isGoogleVersion) {
         dimension: dimensionDoc(field),
         description: field.description,
         ai_context: aiContextDoc(field.aiContext, isGoogleVersion),
-        custom_extensions: customExtensionsDoc(field.customExtensions, `field '${field.name}'`, isGoogleVersion, 
-        /* isModel= */ false, warnings, /* isField= */ true),
+        custom_extensions: customExtensionsDoc(field.customExtensions, `field '${field.name}'`, isGoogleVersion, warnings, /* isField= */ true),
     });
 }
 function metricDoc(metric, warnings, version) {
@@ -508,8 +502,7 @@ function metricDoc(metric, warnings, version) {
         datatype: datatypeDoc(metric.type),
         description: metric.description,
         ai_context: aiContextDoc(metric.aiContext, isGoogleVersion),
-        custom_extensions: customExtensionsDoc(metric.customExtensions, `metric '${metric.name}'`, isGoogleVersion, 
-        /* isModel= */ false, warnings, /* isField= */ false, blockPayload),
+        custom_extensions: customExtensionsDoc(metric.customExtensions, `metric '${metric.name}'`, isGoogleVersion, warnings, /* isField= */ false, blockPayload),
     });
 }
 // The `Concept.field` pairs this document will still resolve on reload. A
@@ -697,8 +690,7 @@ function relationshipDoc(rel, warnings, version) {
         description: placement.relationship.description === 'native' ? description :
             undefined,
         ai_context: aiContextDoc(rel.aiContext, isGoogleVersion),
-        custom_extensions: customExtensionsDoc(rel.customExtensions, `relationship '${rel.name}'`, isGoogleVersion, 
-        /* isModel= */ false, warnings, /* isField= */ false, blockPayload),
+        custom_extensions: customExtensionsDoc(rel.customExtensions, `relationship '${rel.name}'`, isGoogleVersion, warnings, /* isField= */ false, blockPayload),
     });
 }
 // Renders a field or metric `expression` for the target version. The IR comes
@@ -796,24 +788,14 @@ function aiContextDoc(ai, isGoogleVersion) {
     }
     return isGoogleVersion ? { ...base, custom } : { ...custom, ...base };
 }
-// The deployments a vanilla model lists only as targets in its GOOGLE blocks,
-// named as a pull names them. A block whose data is not valid JSON gives none,
-// and customExtensionsDoc warns that it was dropped. The other blocks still
-// give theirs.
-function deploymentsFromGoogleExtensions(model) {
-    const targets = (model.customExtensions ??
-        []).flatMap(ext => blockTargets(ext, model.name));
-    return (0, deployment_target_1.unnamedDeployments)(targets);
-}
 // Serializes `custom_extensions` for one IR element. Under OSSIE_VERSION,
 // third-party extensions are emitted, followed by a synthesized GOOGLE block
-// when `blockPayload` carries any keys. Any other raw GOOGLE block on the IR
+// when `blockPayload` carries any keys. Any raw GOOGLE block on the IR
 // is dropped with a warning so it cannot collide with the synthesized block or
 // write keys the loader rejects. Under GOOGLE_VERSION,
 // third-party extensions are written out unchanged without warning, while
-// `GOOGLE` blocks are skipped (silently for the model's `deploymentTargets`
-// block, and with a warning for any other `GOOGLE` block).
-function customExtensionsDoc(exts, where, isGoogleVersion, isModel, warnings, isField = false, blockPayload) {
+// `GOOGLE` blocks are skipped with a warning.
+function customExtensionsDoc(exts, where, isGoogleVersion, warnings, isField = false, blockPayload) {
     const payload = blockPayload ? { ...blockPayload } : {};
     if (!exts?.length && Object.keys(payload).length === 0)
         return undefined;
@@ -825,12 +807,6 @@ function customExtensionsDoc(exts, where, isGoogleVersion, isModel, warnings, is
                 kept.push({ vendor_name: e.vendorName, data: e.data });
                 continue;
             }
-            // The loader's copy of the model's `deployments`, which the GOOGLE
-            // block below writes in their own form.
-            if (isModel && payload.deployments !== undefined &&
-                isDeploymentTargetsBlock(e)) {
-                continue;
-            }
             droppedGoogle += 1;
         }
         if (droppedGoogle > 0) {
@@ -859,8 +835,6 @@ function customExtensionsDoc(exts, where, isGoogleVersion, isModel, warnings, is
             kept.push({ vendor_name: ext.vendorName, data: ext.data });
             continue;
         }
-        if (isModel && blockTargets(ext, '').length > 0)
-            continue;
         droppedGoogle += 1;
     }
     if (droppedGoogle > 0) {
@@ -869,30 +843,6 @@ function customExtensionsDoc(exts, where, isGoogleVersion, isModel, warnings, is
     }
     return nonEmpty(kept);
 }
-/**
- * Returns true if `e.data` is a JSON object with a `'deploymentTargets'`
- * property.
- *
- * The loader folds a Google-flavor model's `deployments` into such a block.
- */
-function isDeploymentTargetsBlock(e) {
-    try {
-        const d = JSON.parse(e.data);
-        return !!d && typeof d === 'object' &&
-            Object.hasOwn(d, 'deploymentTargets');
-    }
-    catch {
-        return false;
-    }
-}
-function blockTargets(ext, modelName) {
-    try {
-        return (0, deployment_target_1.googleBlockTargets)([ext], modelName);
-    }
-    catch {
-        return [];
-    }
-}
 // Drops undefined-valued keys so the emitted YAML only shows fields the model
 // actually set (matching the emitters' `compact` convention).
 function compact(obj) {

package/build/ts/kcmd/semantic/runtime/runtime.d.ts

@@ -23,17 +23,15 @@ export interface SemanticRuntime {
      * profile's several targets may leave the store ambiguous, the model may
      * bind a table outside its Spanner or AlloyDB store, or finding how to
      * connect may fail, such as the lookup of an AlloyDB cluster's primary
-     * instance. Also set when a GOOGLE block's data is not valid JSON, so its
-     * targets cannot be read. `storeError` says why.
+     * instance. `storeError` says why.
      */
     storeFailed?: boolean;
     /**
      * Set with `storeFailed` when the model's deployments give no store
      * whatever the model is used for. One such case is a target in
-     * no accepted form in any deployment. Another is a GOOGLE block that is not
-     * valid JSON. A third is several targets for the profile with no single
-     * store. A table bound outside the store and a failed AlloyDB lookup are
-     * not such cases.
+     * no accepted form in any deployment. Another is several targets for the
+     * profile with no single store. A table bound outside the store and a failed
+     * AlloyDB lookup are not such cases.
      */
     deploymentsRejected?: boolean;
     /** Which binding profile produced this. Provenance, for messages. */

package/build/ts/kcmd/semantic/runtime/store.d.ts

@@ -50,13 +50,13 @@ export type ChosenStore = SpannerStore | AlloyDbDatabase | BigQueryStore;
  * `named` is set when the model's deployments name a target and still no
  * store results, so a caller that runs against the store fails. `rejected` is
  * set with it when the deployments give no store whatever the model is used
- * for: a target in no accepted form in any deployment, a GOOGLE block whose
- * data is not valid JSON, or several targets for the profile. `named` alone
- * means the model binds a table outside its Spanner or AlloyDB store.
+ * for: a target in no accepted form in any deployment, or several targets for
+ * the profile. `named` alone means the model binds a table outside its Spanner
+ * or AlloyDB store.
  *
  * Neither is set when the profile names no store, unless a target is in no
- * accepted form, or a GOOGLE block is not valid JSON. Neither is set either
- * when a BigQuery model binds a table outside the graph's dataset.
+ * accepted form. Neither is set either when a BigQuery model binds a table
+ * outside the graph's dataset.
  */
 export interface StoreError {
     error: string;
@@ -67,21 +67,18 @@ export interface StoreError {
  * The store a model runs against under binding profile `profile`, which
  * defaults to `default`, the model file's own bindings. It is the one the
  * deployments for that profile name: those that name it in `profile`, or that
- * name none or `default` for `default`. A model with no `deployments` list
- * names no profile for any of its targets, so they are all for `default`.
- * With several targets, the store is the single operational one, Spanner or
- * AlloyDB.
+ * name none or `default` for `default`. With several targets, the store is the
+ * single operational one, Spanner or AlloyDB.
  *
- * Fails six ways:
+ * Fails five ways:
  *
- * 1. A GOOGLE block's data is not valid JSON, so its targets cannot be read.
- * 2. A target names no supported destination. Push checks the target of every
+ * 1. A target names no supported destination. Push checks the target of every
  *    deployment, so this fails the store under every profile.
- * 3. No deployment uses the profile.
- * 4. There are several targets and no single operational one, so which store
+ * 2. No deployment uses the profile.
+ * 3. There are several targets and no single operational one, so which store
  *    is meant is ambiguous.
- * 5. There is no target, so there is nothing to run against.
- * 6. The model binds a table outside the store. For a Spanner or AlloyDB
+ * 4. There is no target, so there is nothing to run against.
+ * 5. The model binds a table outside the store. For a Spanner or AlloyDB
  *    store, a write would land in the wrong place, and the error is named. A
  *    BigQuery graph may read tables in any dataset, so
  *    for a BigQuery store the error is not named.
@@ -89,9 +86,7 @@ export interface StoreError {
 export declare function resolveStore(model: SemanticModel, profile?: string): ChosenStore | StoreError;
 /**
  * The targets binding profile `profile` uses, as resolveStore reads them: its
- * deployments' targets, or every target in a GOOGLE block for `default` when
- * the model has no `deployments` list. Empty when no deployment is for the
- * profile. Throws when a GOOGLE block's data is not valid JSON.
+ * deployments' targets. Empty when no deployment is for the profile.
  */
 export declare function profileTargets(model: SemanticModel, profile: string): string[];
 /**

package/build/ts/kcmd/semantic/runtime/store.js

@@ -101,21 +101,18 @@ function strayBindings(model, store) {
  * The store a model runs against under binding profile `profile`, which
  * defaults to `default`, the model file's own bindings. It is the one the
  * deployments for that profile name: those that name it in `profile`, or that
- * name none or `default` for `default`. A model with no `deployments` list
- * names no profile for any of its targets, so they are all for `default`.
- * With several targets, the store is the single operational one, Spanner or
- * AlloyDB.
+ * name none or `default` for `default`. With several targets, the store is the
+ * single operational one, Spanner or AlloyDB.
  *
- * Fails six ways:
+ * Fails five ways:
  *
- * 1. A GOOGLE block's data is not valid JSON, so its targets cannot be read.
- * 2. A target names no supported destination. Push checks the target of every
+ * 1. A target names no supported destination. Push checks the target of every
  *    deployment, so this fails the store under every profile.
- * 3. No deployment uses the profile.
- * 4. There are several targets and no single operational one, so which store
+ * 2. No deployment uses the profile.
+ * 3. There are several targets and no single operational one, so which store
  *    is meant is ambiguous.
- * 5. There is no target, so there is nothing to run against.
- * 6. The model binds a table outside the store. For a Spanner or AlloyDB
+ * 4. There is no target, so there is nothing to run against.
+ * 5. The model binds a table outside the store. For a Spanner or AlloyDB
  *    store, a write would land in the wrong place, and the error is named. A
  *    BigQuery graph may read tables in any dataset, so
  *    for a BigQuery store the error is not named.
@@ -123,15 +120,7 @@ function strayBindings(model, store) {
 function resolveStore(model, profile = resolve_profiles_1.DEFAULT_PROFILE) {
     // Push checks the target of every deployment the model declares, so the
     // targets of every deployment are read before the profile's are picked.
-    let all;
-    try {
-        all = (0, deployment_target_1.googleDeploymentTargets)(model);
-    }
-    catch (err) {
-        // It throws when a GOOGLE block's data is not valid JSON. Push reports
-        // that as an error, so the store fails.
-        return { error: `${err?.message || err}`, named: true, rejected: true };
-    }
+    const all = (0, deployment_target_1.googleDeploymentTargets)(model);
     // The loader reads a vanilla model's `deployments` out of its GOOGLE block,
     // so a message names the block's `deployments`, as push does.
     const vanilla = model.version === loader_1.OSSIE_VERSION;
@@ -141,17 +130,19 @@ function resolveStore(model, profile = resolve_profiles_1.DEFAULT_PROFILE) {
     // A target in no accepted form is reported, alone or beside one that gives
     // a store, whichever profile its deployment is for.
     if (all.malformed.length) {
-        const unparsed = model.deployments?.find(d => d.target === all.malformed[0]);
-        const error = unparsed ? (0, deployment_target_1.deploymentTargetError)(model, unparsed) :
-            (0, deployment_target_1.googleBlockTargetError)(model, all.malformed[0]);
-        return { error, named: true, rejected: true };
+        const unparsed = model.deployments.find(d => d.target === all.malformed[0]);
+        return {
+            error: (0, deployment_target_1.deploymentTargetError)(model, unparsed),
+            named: true,
+            rejected: true,
+        };
     }
     const used = deploymentsFor(model, profile);
     if ('error' in used)
         return used;
     const scoped = used.model;
-    // The profile's targets are among those read above. So this does not
-    // throw, and none of them is in no accepted form.
+    // The profile's targets are among those read above, so none of them is in no
+    // accepted form.
     const targets = (0, deployment_target_1.googleDeploymentTargets)(scoped);
     const { spanner, alloyDb, bigQuery } = targets;
     const declared = spanner.length + alloyDb.length + bigQuery.length;
@@ -202,9 +193,7 @@ function resolveStore(model, profile = resolve_profiles_1.DEFAULT_PROFILE) {
     return store;
 }
 // The model with only the deployments `profile` uses, or why there are none.
-// A model with no `deployments` list keeps every target in its GOOGLE block
-// for `default`. An empty list names no deployment. Either way, any other
-// profile has none.
+// A model with no or empty `deployments` list names no deployment.
 function deploymentsFor(model, profile) {
     const nothingToRun = `so there is no database to run it against`;
     const namedProfile = `binding profile '${profile}' is a named profile, ` +
@@ -235,21 +224,16 @@ function deploymentsFor(model, profile) {
 }
 /**
  * The targets binding profile `profile` uses, as resolveStore reads them: its
- * deployments' targets, or every target in a GOOGLE block for `default` when
- * the model has no `deployments` list. Empty when no deployment is for the
- * profile. Throws when a GOOGLE block's data is not valid JSON.
+ * deployments' targets. Empty when no deployment is for the profile.
  */
 function profileTargets(model, profile) {
     const used = deploymentsFor(model, profile);
     return 'error' in used ? [] : (0, deployment_target_1.googleDeploymentTargets)(used.model).uris;
 }
-// The deployments whose targets are `uris`, for a message, or nothing when
-// the targets come from a GOOGLE block, which names none. `profile` is the
+// The deployments whose targets are `uris`, for a message. `profile` is the
 // profile they are for.
 function deploymentNames(model, uris, profile) {
-    const deployments = model.deployments;
-    if (!deployments)
-        return '';
+    const deployments = model.deployments ?? [];
     const names = uris.map(uri => deployments.find(d => d.target === uri)?.name ?? uri);
     return ` for profile '${profile}' (${names.join(', ')})`;
 }

package/build/ts/kcmd/semantic/validate.js

@@ -7,8 +7,7 @@
 // empty array means valid); push prints them and aborts, and `kcmd import`
 // reports them. Kept separate from the loader -- which validates a document
 // against the schema -- because these are deployment requirements, not schema
-// rules, and they read the GOOGLE deployment-target extension the BigQuery leg
-// owns.
+// rules.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validatePushRequirements = validatePushRequirements;
 exports.validateDeployments = validateDeployments;
@@ -60,18 +59,7 @@ function validatePushRequirements(models, opts = {}) {
     const errors = [];
     for (const { document, model } of models) {
         errors.push(...nameAndDescriptionErrors(model, document, !!opts.v2Aspects));
-        let deployInfo;
-        try {
-            // One pass over the model's GOOGLE extension(s): both checks below read
-            // the same parse rather than re-parsing the JSON per reader.
-            deployInfo = (0, deploy_bigquery_1.googleDeploymentTargets)(model);
-        }
-        catch (err) {
-            // Malformed GOOGLE extension JSON: surface it as a validation error here
-            // rather than letting it throw out of a later leg as an uncaught stack.
-            errors.push(`${err.message || err} (${document})`);
-            continue;
-        }
+        const deployInfo = (0, deploy_bigquery_1.googleDeploymentTargets)(model);
         // A model that targets a graph (BigQuery OR Spanner) must have every
         // relationship's join columns bound. The loader accepts a column-less
         // relationship so a purely logical model (an OWL import) loads and pushes
@@ -2089,16 +2077,8 @@ async function validateBigQueryDataSources(models, bq, defaultProject, graph) {
 // bills to: the project of the model's first BigQuery Graph deployment target
 // (where the CREATE PROPERTY GRAPH runs), falling back to the scope's default
 // project when the model declares no parseable BigQuery Graph target.
-// googleDeploymentTargets is safe here: validatePushRequirements ran first and
-// already rejected a malformed GOOGLE extension.
 function billingProject(model, defaultProject) {
-    try {
-        return (0, deploy_bigquery_1.googleDeploymentTargets)(model).bigQuery[0]?.project ??
-            defaultProject;
-    }
-    catch {
-        return defaultProject;
-    }
+    return (0, deploy_bigquery_1.googleDeploymentTargets)(model).bigQuery[0]?.project ?? defaultProject;
 }
 // A source that can be probed as a BigQuery table: the canonical `dataSource`,
 // trimmed, or null when it is empty or a non-BigQuery resource URI. Unlike a
@@ -2181,13 +2161,7 @@ async function validateSpannerActionStatements(models, spanner) {
         // The database an action writes to is the one this profile deploys its
         // graph to: on Spanner the published graph and the operational rows live in
         // the same database. A model with no Spanner target contributes nothing.
-        let target;
-        try {
-            target = (0, deployment_target_1.spannerGraphTargets)(loaded.model).targets[0];
-        }
-        catch {
-            continue;
-        }
+        const target = (0, deployment_target_1.spannerGraphTargets)(loaded.model).targets[0];
         if (!target)
             continue;
         const key = `${target.project}/${target.instance}/${target.database}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/kcmd",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Google Knowledge Catalog Metadata as Code Library, CLI and MCP Server",
   "repository": {
     "type": "git",