@google-cloud/kcmd 0.0.0-stage → 0.2.0

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

@@ -0,0 +1,63 @@
+import { AspectType, CatalogClient, Entry, EntryType } from '../gcp/dataplex';
+import { AiContext } from './ir';
+export interface CustomType {
+    id: string;
+    entryType: Omit<EntryType, 'name' | 'requiredAspects'>;
+    aspectType: Omit<AspectType, 'name'>;
+}
+export declare function aiContextField(index: number): Record<string, any>;
+export declare function aiContextAspectValue(ai: AiContext | undefined): Record<string, any> | undefined;
+export declare function aiContextFromAspect(value: any): AiContext | undefined;
+export declare const ACTION_TYPE_ID = "semantic-action";
+export declare const CONSTRAINT_TYPE_ID = "semantic-constraint";
+export declare const PUSH_STATE_LABEL = "kcmd-push-state";
+export declare const PUSH_WRITING = "writing";
+export declare const PUSH_FINISHED = "finished";
+export declare const CUSTOM_TYPES: readonly CustomType[];
+export declare function isCustomType(id: string): boolean;
+/**
+ * Collects the deduplicated list of `kcmd`-owned custom type IDs
+ * (`semantic-action`, `semantic-constraint`, etc.) used by `entries`.
+ */
+export declare function collectCustomTypes(entries: readonly Entry[]): string[];
+export declare function customTypeHome(dest: {
+    project: string;
+}): {
+    project: string;
+    location: string;
+};
+export declare function customEntryTypeName(id: string, dest: {
+    project: string;
+}): string;
+export declare function customAspectTypeName(id: string, dest: {
+    project: string;
+}): string;
+export declare function customAspectKey(id: string, dest: {
+    project: string;
+}): string;
+export interface ProvisionResult {
+    error?: string;
+    denied?: string;
+    warnings?: string[];
+}
+/**
+ * Creates every type in CUSTOM_TYPES in a destination.
+ *
+ * Called from `kcmd init --semantic-model`, beside the entry group it already
+ * provisions, so a push still writes nothing but entries. Each aspect type is
+ * created and then, if it is already there, patched: a project provisioned by
+ * an earlier version of kcmd holds an older template, and pushing a field that
+ * template lacks fails with an opaque parsing error. Dataplex rejects a
+ * backwards-incompatible change, so the patch only ever adds appended fields.
+ *
+ * Stops at the first hard failure. A refusal to patch a type that exists is
+ * a warning. A refusal to create a type does NOT stop it: the refusals
+ * differ per type and per operation -- patching a type that already exists
+ * needs `update`, creating one that does not needs `create` -- so a caller
+ * refused one type may well be allowed the next, and giving up early would
+ * leave a type uncreated that nothing was stopping. Every type is attempted
+ * and the first refusal is reported once they have been.
+ */
+export declare function provisionCustomTypes(cat: CatalogClient, dest: {
+    project: string;
+}): Promise<ProvisionResult>;