@keboola/api-client 25.0.0 → 29.0.0

package/dist/types-DebL68-g.d.ts

@@ -0,0 +1,148 @@
+import { i as CreateMetaObjectInput } from "./types-Z-vUwgym.js";
+import { n as createMetastoreClient } from "./index-BthgbVdd.js";
+//#region src/sdks/semanticLayer/types.d.ts
+type MetastoreClient = ReturnType<typeof createMetastoreClient>;
+type SemanticFieldRole = 'key' | 'dimension' | 'measure' | 'timestamp';
+type SemanticAiMetadata = {
+  synonyms?: string[];
+  keywords?: string[];
+  antiKeywords?: string[];
+  hints?: string[];
+  warnings?: string[];
+};
+type SemanticModelData = {
+  name: string;
+  description?: string;
+  sql_dialect: string;
+};
+type SemanticFieldData = {
+  name: string;
+  description?: string;
+  type?: string;
+  role?: SemanticFieldRole;
+  values?: string[];
+  ai?: SemanticAiMetadata;
+};
+type SemanticDatasetData = {
+  modelUUID: string;
+  name: string;
+  tableId: string;
+  fqn: string;
+  description?: string;
+  grain?: string;
+  primaryKey?: string[];
+  fields?: SemanticFieldData[];
+  ai?: SemanticAiMetadata;
+};
+type SemanticMetricData = {
+  modelUUID: string;
+  name: string;
+  sql: string;
+  dataset?: string;
+  description?: string;
+};
+type SemanticRelationshipData = {
+  modelUUID: string;
+  name?: string;
+  from: string;
+  to: string;
+  on: string;
+  type?: 'left' | 'inner';
+};
+type SemanticGlossaryData = {
+  modelUUID: string;
+  term: string;
+  definition: string;
+  seeAlso?: string[];
+};
+type SemanticConstraintType = 'inequality' | 'equality' | 'range' | 'composition' | 'exclusion' | 'temporal' | 'conditional';
+type SemanticConstraintScope = 'global' | 'per_location' | 'per_date' | 'per_category';
+type SemanticRuleOperator = '<' | '<=' | '=' | '>=' | '>' | '!=' | 'between' | 'in' | 'sum_equals' | 'ratio_between';
+type SemanticRuleExpression = {
+  operator?: SemanticRuleOperator;
+  left?: string;
+  right?: string;
+  bounds?: {
+    min?: number;
+    max?: number;
+  };
+};
+type SemanticValidationQuery = {
+  default?: string;
+  snowflake?: string;
+  bigquery?: string;
+};
+type SemanticConstraintData = {
+  modelUUID: string;
+  name: string;
+  displayName?: string;
+  description?: string;
+  constraintType: SemanticConstraintType;
+  metrics: string[];
+  datasets?: string[];
+  rule: string;
+  ruleExpression?: SemanticRuleExpression;
+  validationQuery?: SemanticValidationQuery;
+  severity?: 'error' | 'warning' | 'info';
+  errorMessage?: string;
+  remediation?: string;
+  isActive?: boolean;
+  scope?: SemanticConstraintScope;
+  owner?: string;
+  tags?: string[];
+};
+type SemanticChildObjectDataMap = {
+  'semantic-dataset': SemanticDatasetData;
+  'semantic-metric': SemanticMetricData;
+  'semantic-relationship': SemanticRelationshipData;
+  'semantic-glossary': SemanticGlossaryData;
+  'semantic-constraint': SemanticConstraintData;
+};
+type SemanticChildObjectType = keyof SemanticChildObjectDataMap;
+type SemanticObjectType = SemanticChildObjectType | 'semantic-model';
+type SemanticObjectMeta = {
+  name?: string;
+  branch?: string;
+  projectId?: number;
+  organizationId?: string;
+  revision?: number;
+  schemaVersion?: string;
+  createdAt?: string;
+  lastUpdated?: string;
+  revisionCreatedAt?: string;
+};
+/**
+ * Normalized metastore object as returned by this SDK. Matches the live metastore
+ * envelope ({ type, id, attributes: <data payload>, meta: {...} }), which differs
+ * from the legacy wrapper types in clients/metastore/repository/types.ts.
+ */
+type SemanticObject<TData> = {
+  uuid: string;
+  data: TData;
+  meta: SemanticObjectMeta;
+};
+type CreateSemanticObjectMeta = Omit<CreateMetaObjectInput, 'data' | 'objectType'>;
+/**
+ * Meta for a CONTENT update. `scope` is deliberately absent: a scope change is a separate PATCH
+ * shape the metastore refuses to combine with name/data (see UpdateMetaObjectInput's union), and
+ * it used to be accepted here — compiling fine and failing with a 400 on every live call.
+ */
+type UpdateSemanticObjectMeta = {
+  name?: string;
+};
+/**
+ * One child of a model as `listModelChildren` reports it: enough to address it (type + UUID)
+ * and to label it for a user (`name` is the display label, see `deriveObjectLabel`).
+ */
+type SemanticModelChildRef = {
+  objectType: SemanticChildObjectType;
+  objectUUID: string;
+  name: string | undefined;
+};
+/** A child `deleteModel` tried and failed to delete, with the error that delete rejected with. */
+type SemanticModelChildDeleteFailure = SemanticModelChildRef & {
+  error: unknown;
+};
+//#endregion
+export { SemanticValidationQuery as C, SemanticRuleOperator as S, SemanticObject as _, SemanticChildObjectType as a, SemanticRelationshipData as b, SemanticConstraintType as c, SemanticFieldRole as d, SemanticGlossaryData as f, SemanticModelData as g, SemanticModelChildRef as h, SemanticChildObjectDataMap as i, SemanticDatasetData as l, SemanticModelChildDeleteFailure as m, MetastoreClient as n, SemanticConstraintData as o, SemanticMetricData as p, SemanticAiMetadata as r, SemanticConstraintScope as s, CreateSemanticObjectMeta as t, SemanticFieldData as u, SemanticObjectMeta as v, UpdateSemanticObjectMeta as w, SemanticRuleExpression as x, SemanticObjectType as y };
+//# sourceMappingURL=types-DebL68-g.d.ts.map