@keboola/api-client 27.0.0 → 29.0.0

package/dist/{types-D6dnnju2.d.ts → types-DMvU4kZ2.d.cts}

@@ -1,10 +1,9 @@
-import { d as OpenapiPathType, O as OpenapiBodyType, b as OpenapiReturnType } from './types-f8dUjMX4.js';
-
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType } from "./index-CLPrlyIz.cjs";
+//#region src/clients/metastore/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/': {
     parameters: {
@@ -1429,25 +1428,23 @@ type components = {
   headers: never;
   pathItems: never;
 };
-
-type GetSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}']['get']>;
-type GetVersionedSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}/{version}']['get']>;
-
+//#endregion
+//#region src/clients/metastore/repository/types.d.ts
 type MetaObjectMeta = NonNullable<components['schemas']['handlers.JSONAPIMetaObjectResource']['meta']>;
 type MetaObject<TData extends Record<string, unknown>, TDataOptional extends boolean = false> = {
-    uuid: string;
-    meta: MetaObjectMeta;
+  uuid: string;
+  meta: MetaObjectMeta;
 } & (TDataOptional extends true ? {
-    data?: TData;
+  data?: TData;
 } : {
-    data: TData;
+  data: TData;
 });
 type GetMetaObjectsPath = OpenapiPathType<paths['/api/v1/repository/{objectType}']['get']>;
 type CreateMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}']['post']>;
 type CreateMetaObjectBody = OpenapiBodyType<paths['/api/v1/repository/{objectType}']['post']>;
 type CreateMetaObjectReturn = OpenapiReturnType<paths['/api/v1/repository/{objectType}']['post']>;
 type CreateMetaObjectInput<TData extends Record<string, unknown> = Record<string, unknown>> = CreateMetaObjectPath & Omit<CreateMetaObjectBody, 'data'> & {
-    data: TData;
+  data: TData;
 };
 type GetMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}']['get']>;
 type DeleteMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}']['delete']>;
@@ -1459,18 +1456,18 @@ type UpdateMetaObjectBody = OpenapiBodyType<paths['/api/v1/repository/{objectTyp
  * patch stays unrepresentable because each branch requires its lead field.
  */
 type UpdateMetaObjectContentPatch<TData extends Record<string, unknown>> = {
-    data: Partial<TData>;
-    name?: UpdateMetaObjectBody['name'];
-    scope?: never;
+  data: Partial<TData>;
+  name?: UpdateMetaObjectBody['name'];
+  scope?: never;
 } | {
-    name: NonNullable<UpdateMetaObjectBody['name']>;
-    data?: Partial<TData>;
-    scope?: never;
+  name: NonNullable<UpdateMetaObjectBody['name']>;
+  data?: Partial<TData>;
+  scope?: never;
 };
 type UpdateMetaObjectScopeStepUp = {
-    scope: NonNullable<UpdateMetaObjectBody['scope']>;
-    data?: never;
-    name?: never;
+  scope: NonNullable<UpdateMetaObjectBody['scope']>;
+  data?: never;
+  name?: never;
 };
 /**
  * A PATCH is exactly one of two operations, and the metastore enforces the split server-side: a
@@ -1487,22 +1484,27 @@ type ReplaceTargetProjectsInput = ReplaceTargetProjectsPath & ReplaceTargetProje
 type ReplaceMetaObjectPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}']['put']>;
 type ReplaceMetaObjectBody = OpenapiBodyType<paths['/api/v1/repository/{objectType}/{UUID}']['put']>;
 type ReplaceMetaObjectInput<TData extends Record<string, unknown> = Record<string, unknown>> = ReplaceMetaObjectPath & Omit<ReplaceMetaObjectBody, 'data'> & {
-    data: TData;
+  data: TData;
 };
 type GetMetaObjectRevisionsPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/revisions']['get']>;
 type GetMetaObjectRevisionPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}/revisions/{revision}']['get']>;
 type DeleteMetaObjectRevisionPath = OpenapiPathType<paths['/api/v1/repository/{objectType}/{UUID}/revisions/{revision}']['delete']>;
 type RawMetaObject<TData extends Record<string, unknown>> = {
-    type: string;
-    id: string;
-    attributes: TData;
-    meta: MetaObjectMeta;
+  type: string;
+  id: string;
+  attributes: TData;
+  meta: MetaObjectMeta;
 };
 type MetaStoreObjectResponse<TData extends Record<string, unknown>> = {
-    data: RawMetaObject<TData>;
+  data: RawMetaObject<TData>;
 };
 type MetaStoreListResponse<TData extends Record<string, unknown>> = {
-    data: RawMetaObject<TData>[];
+  data: RawMetaObject<TData>[];
 };
-
-export type { CreateMetaObjectInput as C, DeleteMetaObjectPath as D, GetMetaObjectsPath as G, MetaObject as M, ReplaceMetaObjectInput as R, UpdateMetaObjectInput as U, MetaStoreListResponse as a, GetMetaObjectRevisionsPath as b, GetMetaObjectPath as c, MetaStoreObjectResponse as d, ReplaceTargetProjectsInput as e, GetMetaObjectRevisionPath as f, DeleteMetaObjectRevisionPath as g, GetSchemaPath as h, components as i, GetVersionedSchemaPath as j, CreateMetaObjectBody as k, CreateMetaObjectPath as l, CreateMetaObjectReturn as m, MetaObjectMeta as n, RawMetaObject as o, ReplaceMetaObjectBody as p, ReplaceMetaObjectPath as q, ReplaceTargetProjectsBody as r, ReplaceTargetProjectsPath as s, UpdateMetaObjectBody as t, UpdateMetaObjectPath as u };
+//#endregion
+//#region src/clients/metastore/schema/types.d.ts
+type GetSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}']['get']>;
+type GetVersionedSchemaPath = OpenapiPathType<paths['/api/v1/schema/{objectType}/{version}']['get']>;
+//#endregion
+export { ReplaceTargetProjectsPath as C, components as D, UpdateMetaObjectPath as E, paths as O, ReplaceTargetProjectsInput as S, UpdateMetaObjectInput as T, RawMetaObject as _, CreateMetaObjectPath as a, ReplaceMetaObjectPath as b, DeleteMetaObjectRevisionPath as c, GetMetaObjectRevisionsPath as d, GetMetaObjectsPath as f, MetaStoreObjectResponse as g, MetaStoreListResponse as h, CreateMetaObjectInput as i, GetMetaObjectPath as l, MetaObjectMeta as m, GetVersionedSchemaPath as n, CreateMetaObjectReturn as o, MetaObject as p, CreateMetaObjectBody as r, DeleteMetaObjectPath as s, GetSchemaPath as t, GetMetaObjectRevisionPath as u, ReplaceMetaObjectBody as v, UpdateMetaObjectBody as w, ReplaceTargetProjectsBody as x, ReplaceMetaObjectInput as y };
+//# sourceMappingURL=types-DMvU4kZ2.d.cts.map

package/dist/{types-BPKQRahf.d.cts → types-DS8uFAeq.d.cts}

@@ -1,10 +1,9 @@
-import { O as OpenapiBodyType, d as OpenapiPathType, c as OpenapiQueryType, b as OpenapiReturnType } from './types-f8dUjMX4.cjs';
-
+import { c as OpenapiReturnType, o as OpenapiPathType, r as OpenapiBodyType, s as OpenapiQueryType } from "./index-CLPrlyIz.cjs";
+//#region src/clients/editor/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '/': {
     parameters: {
@@ -443,13 +442,7 @@ type components = {
        * @example snowflake-service-keypair
        * @enum {string|null}
        */
-      workspaceLoginType?:
-        | 'snowflake-person-sso'
-        | 'snowflake-legacy-service'
-        | 'snowflake-person-keypair'
-        | 'snowflake-service-keypair'
-        | 'default'
-        | null;
+      workspaceLoginType?: 'snowflake-person-sso' | 'snowflake-legacy-service' | 'snowflake-person-keypair' | 'snowflake-service-keypair' | 'default' | null;
       /**
        * Format: date-time
        * @description Timestamp of when data was last loaded to the session. Null if data was never loaded to the session.
@@ -1389,7 +1382,8 @@ interface operations {
     };
   };
 }
-
+//#endregion
+//#region src/clients/editor/types.d.ts
 type SqlSession = OpenapiReturnType<paths['/sql/sessions']['post']>;
 type CreateSqlSessionBody = OpenapiBodyType<paths['/sql/sessions']['post']>;
 type GetSqlSessionPath = OpenapiPathType<paths['/sql/sessions/{id}']['get']>;
@@ -1412,5 +1406,6 @@ type PostSqlSessionLoadPath = OpenapiPathType<paths['/sql/sessions/{id}/load']['
 type PostSqlSessionLoadBody = OpenapiBodyType<paths['/sql/sessions/{id}/load']['post']>;
 type PostSqlSessionUnloadPath = OpenapiPathType<paths['/sql/sessions/{id}/unload']['post']>;
 type PostSqlSessionUnloadBody = OpenapiBodyType<paths['/sql/sessions/{id}/unload']['post']>;
-
-export type { CreateSqlSessionBody as C, GetSqlSessionPath as G, PostSqlRunQueryPath as P, Session as S, GetSqlSessionsQuery as a, GetSqlSessionSchemaPath as b, GetSqlSessionSchemaQuery as c, components as d, PostSqlRunQueryBody as e, PostSqlTablePreviewPath as f, PostSqlTablePreviewBody as g, GetSqlSessionTableDdlPath as h, GetSqlSessionTableDdlQuery as i, PostSqlSessionLoadPath as j, PostSqlSessionLoadBody as k, PostSqlSessionUnloadPath as l, PostSqlSessionUnloadBody as m, SessionSchema as n, SessionSchemaBucket as o, SessionSchemaColumn as p, SessionSchemaDatabase as q, SessionSchemaTable as r, SqlSession as s };
+//#endregion
+export { components as C, SqlSession as S, SessionSchema as _, GetSqlSessionTableDdlPath as a, SessionSchemaDatabase as b, PostSqlRunQueryBody as c, PostSqlSessionLoadPath as d, PostSqlSessionUnloadBody as f, Session as g, PostSqlTablePreviewPath as h, GetSqlSessionSchemaQuery as i, PostSqlRunQueryPath as l, PostSqlTablePreviewBody as m, GetSqlSessionPath as n, GetSqlSessionTableDdlQuery as o, PostSqlSessionUnloadPath as p, GetSqlSessionSchemaPath as r, GetSqlSessionsQuery as s, CreateSqlSessionBody as t, PostSqlSessionLoadBody as u, SessionSchemaBucket as v, SessionSchemaTable as x, SessionSchemaColumn as y };
+//# sourceMappingURL=types-DS8uFAeq.d.cts.map

package/dist/{types-DOc5_aYZ.d.ts → types-DeApSCzx.d.cts}

@@ -1,11 +1,10 @@
-import { B as Backend } from './backends-UNp_e5y9.js';
-import { c as OpenapiQueryType } from './types-f8dUjMX4.js';
-
+import { s as OpenapiQueryType } from "./index-CLPrlyIz.cjs";
+import { t as Backend } from "./backends-DKBz5OxE.cjs";
+//#region src/clients/omnisearch/__generated__/schema.d.ts
 /**
  * This file was auto-generated by openapi-typescript.
  * Do not make direct changes to the file.
  */
-
 type paths = {
   '': {
     parameters: {
@@ -146,13 +145,7 @@ type components = {
      * LineageSource
      * @enum {string}
      */
-    LineageSource:
-      | 'sql_parsing'
-      | 'llm_analysis'
-      | 'extractor_analysis'
-      | 'writer_analysis'
-      | 'alias_analysis'
-      | 'jobs_analysis';
+    LineageSource: 'sql_parsing' | 'llm_analysis' | 'extractor_analysis' | 'writer_analysis' | 'alias_analysis' | 'jobs_analysis';
     /**
      * Metadata
      * @description A metadata entry as it comes out of the Storage API.
@@ -566,19 +559,20 @@ type operations = {
     };
   };
 };
-
+//#endregion
+//#region src/clients/omnisearch/types.d.ts
 type GetProjectsLineageQuery = OpenapiQueryType<paths['/v1/lineage/projects']['get']>;
 type GetTablesLineageQuery = OpenapiQueryType<paths['/v1/lineage/tables']['get']>;
 type ProjectsLineage = components['schemas']['ProjectLineageGraph'];
 type ProjectsLineageResponse = {
-    graph: ProjectsLineage;
+  graph: ProjectsLineage;
 };
 /** Carries {@link LineageTable} nodes, so the fields the spec omits are named rather than `unknown`. */
 type TablesLineage = Omit<components['schemas']['TableLineageGraph'], 'tables'> & {
-    tables: Record<string, LineageTable>;
+  tables: Record<string, LineageTable>;
 };
 type TablesLineageResponse = {
-    graph: TablesLineage;
+  graph: TablesLineage;
 };
 /** Which analysis produced an edge. `lineageSource` (singular) may also be the aggregate `'combined'`. */
 type LineageSource = components['schemas']['LineageSource'];
@@ -590,7 +584,7 @@ type LineageProject = components['schemas']['ProjectNode'];
 type LineageConfiguration = components['schemas']['ConfigurationNode'];
 type LineageMetadata = components['schemas']['Metadata'];
 type LineageBucket = components['schemas']['Bucket'] & {
-    backend?: Backend | null;
+  backend?: Backend | null;
 };
 /**
  * Regular Storage tables carry `bucket`, `id`, `name`, `displayName`, the timestamps and the
@@ -599,9 +593,10 @@ type LineageBucket = components['schemas']['Bucket'] & {
  * sole guaranteed field — narrow before reading anything else.
  */
 type LineageTable = components['schemas']['TableNode'] & {
-    bucket?: LineageBucket | null;
-    rowsCount?: number | null;
-    dataSizeBytes?: number | null;
+  bucket?: LineageBucket | null;
+  rowsCount?: number | null;
+  dataSizeBytes?: number | null;
 };
-
-export type { GetProjectsLineageQuery as G, LineageBucket as L, ProjectLineageRelation as P, TablesLineageResponse as T, GetTablesLineageQuery as a, LineageConfiguration as b, components as c, LineageMetadata as d, LineageProject as e, LineageSource as f, LineageTable as g, ProjectsLineage as h, ProjectsLineageResponse as i, TableLineageRelation as j, TablesLineage as k };
+//#endregion
+export { LineageMetadata as a, LineageTable as c, ProjectsLineageResponse as d, TableLineageRelation as f, components as h, LineageConfiguration as i, ProjectLineageRelation as l, TablesLineageResponse as m, GetTablesLineageQuery as n, LineageProject as o, TablesLineage as p, LineageBucket as r, LineageSource as s, GetProjectsLineageQuery as t, ProjectsLineage as u };
+//# sourceMappingURL=types-DeApSCzx.d.cts.map

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