@keboola/api-client 49.0.0 → 51.0.0

package/dist/index-BfqkgPGI.d.cts

@@ -1,34 +0,0 @@
-import { z } from "zod";
-//#region src/utils/keboolaUID.d.ts
-type KeboolaObjectType = 'data-catalog' | 'table' | 'bucket' | 'flow' | 'configuration' | 'transformation' | 'data-app' | 'workspace';
-type KeboolaObjectId = {
-  uid: string;
-  type: KeboolaObjectType;
-  projectId: number;
-};
-/**
- * There is a proposal for a string format to identify objects in Keboola.
- *
- * https://keboola.atlassian.net/wiki/spaces/ENGG/pages/3967615431/Keboola+UUID+Format
- * Unfortunately, this format will not pass BE validation as `:` is not allowed in the `uid`, and the length is limited to 50 characters only.
- *
- */
-declare const keboolaUID: {
-  serialize: (input: KeboolaObjectId) => string;
-  deserialize: (input: string) => KeboolaObjectId;
-};
-//#endregion
-//#region src/utils/schemaGuidedMerge.d.ts
-/**
- * Merge `patch` into `base`, descending only through object schemas.
- *
- * - At a non-object node (union, array, primitive) the patch replaces the base wholesale, so
- *   switching a union variant drops the old variant's secret.
- * - Hence a union or array subtree is all-or-nothing: send the complete block.
- * - Keys only in `base` are kept; `undefined` patch values are skipped.
- * - Assumes `patch` is schema-validated. Pure.
- */
-declare const schemaGuidedMerge: <T extends Record<string, unknown>>(schema: z.core.$ZodType, base: T, patch: Record<string, unknown>) => T;
-//#endregion
-export { KeboolaObjectId as n, keboolaUID as r, schemaGuidedMerge as t };
-//# sourceMappingURL=index-BfqkgPGI.d.cts.map

package/dist/index-BfqkgPGI.d.ts

@@ -1,34 +0,0 @@
-import { z } from "zod";
-//#region src/utils/keboolaUID.d.ts
-type KeboolaObjectType = 'data-catalog' | 'table' | 'bucket' | 'flow' | 'configuration' | 'transformation' | 'data-app' | 'workspace';
-type KeboolaObjectId = {
-  uid: string;
-  type: KeboolaObjectType;
-  projectId: number;
-};
-/**
- * There is a proposal for a string format to identify objects in Keboola.
- *
- * https://keboola.atlassian.net/wiki/spaces/ENGG/pages/3967615431/Keboola+UUID+Format
- * Unfortunately, this format will not pass BE validation as `:` is not allowed in the `uid`, and the length is limited to 50 characters only.
- *
- */
-declare const keboolaUID: {
-  serialize: (input: KeboolaObjectId) => string;
-  deserialize: (input: string) => KeboolaObjectId;
-};
-//#endregion
-//#region src/utils/schemaGuidedMerge.d.ts
-/**
- * Merge `patch` into `base`, descending only through object schemas.
- *
- * - At a non-object node (union, array, primitive) the patch replaces the base wholesale, so
- *   switching a union variant drops the old variant's secret.
- * - Hence a union or array subtree is all-or-nothing: send the complete block.
- * - Keys only in `base` are kept; `undefined` patch values are skipped.
- * - Assumes `patch` is schema-validated. Pure.
- */
-declare const schemaGuidedMerge: <T extends Record<string, unknown>>(schema: z.core.$ZodType, base: T, patch: Record<string, unknown>) => T;
-//#endregion
-export { KeboolaObjectId as n, keboolaUID as r, schemaGuidedMerge as t };
-//# sourceMappingURL=index-BfqkgPGI.d.ts.map

package/dist/index-fMoM8SeH.d.cts

@@ -1,199 +0,0 @@
-//#region src/domain/storageTable/types.d.ts
-type BucketStage = 'in' | 'out';
-type BucketName = string;
-type TableName = string;
-type BucketId = `${BucketStage}.${BucketName}`;
-type TableId = `${BucketId}.${TableName}`;
-type TableIdParts = [stage: BucketStage, bucket: BucketName, table: TableName];
-type StorageBranchBucket = {
-  kind: 'storage-branch';
-  /** Bare name, no `c-` or `{branchId}-` (branches are BE-side). On-disk: `c-{baseName}` when prefixed. */
-  baseName: BucketName;
-  hasLegacyPrefix: boolean;
-};
-type LegacyBucket = {
-  kind: 'legacy';
-  /**
-   * Bare name, no `c-` or `{branchId}-`. User-facing: `{branchId}-{baseName}`.
-   * On-disk: `c-{branchId}-{baseName}` when prefixed.
-   */
-  baseName: BucketName;
-  hasLegacyPrefix: boolean;
-  /** Dev-branch id encoded into the on-disk name, if any. */
-  branchId: string | null;
-};
-type ParsedBucket = StorageBranchBucket | LegacyBucket;
-type Bucket = ParsedBucket & {
-  stage: BucketStage;
-};
-type Table = {
-  name: TableName;
-  bucket: Bucket;
-};
-type ModelOptions = {
-  /** Project uses the legacy `c-` bucket prefix. (`!ProjectFeature.DisableLegacyBucketPrefix`) */
-  useLegacyBucketPrefix: boolean;
-  /** `ProjectFeature.SoxProtectedDefaultBranch` */
-  hasProtectedDefaultBranch: boolean;
-  /** `ProjectFeature.StorageBranches` */
-  hasStorageBranches: boolean;
-};
-//#endregion
-//#region src/clients/storage/__generated__/constraints.d.ts
-/**
- * The name of a bucket or a table.
- *
- * - Allowed characters: `A-Z`, `a-z`, `0-9`, dash `-` and underscore `_`. Anything else — a
- *   space, a dot, an accented letter — is rejected, not transliterated.
- * - 1 to 96 characters.
- * - Cannot start with an underscore. A dash or a digit as the first character is fine.
- * - Registered (external) buckets follow this same rule, dashes included.
- * - Uniqueness is case-insensitive within a stage: creating `MyBucket` next to `mybucket`
- *   fails with `storage.buckets.alreadyExists`, and for tables with
- *   `storage.buckets.tableAlreadyExists` or `storage.validation.tableAlreadyExists`.
- * - To turn arbitrary user input into a name that satisfies this rule, call
- *   `POST /v2/storage/webalize/display-name` instead of reimplementing the transformation. It
- *   unaccents the input, replaces every run of disallowed characters with a single `-`, trims
- *   `-` from both ends, strips leading underscores, and truncates to 96 characters.
- */
-declare const STORAGE_NAME: {
-  readonly pattern: RegExp;
-  readonly minLength: 1;
-  readonly maxLength: 96;
-};
-/**
- * The name of a table column.
- *
- * - Allowed characters: `A-Z`, `a-z`, `0-9` and underscore `_`. Unlike a bucket or table name,
- *   a column name may **not** contain a dash.
- * - 1 to 64 characters.
- * - Must start with a letter or a digit.
- * - To turn arbitrary user input into a name that satisfies this rule, call
- *   `POST /v2/storage/webalize/column-names` instead of reimplementing the transformation. In
- *   order, it strips emoji, transliterates the rest to ASCII, replaces every run of disallowed
- *   characters with a single `_`, trims `_` from both ends, truncates to 64 characters, and
- *   strips any leading `_` the truncation left behind. Input with no usable character left
- *   webalizes to an empty string, which is *not* a valid column name.
- * - `POST /v2/storage/validate/column-names` applies one rule the creation endpoints do not:
- *   it also rejects the backend system columns `oid`, `tableoid`, `xmin`, `cmin`, `xmax`,
- *   `cmax` and `ctid`.
- */
-declare const STORAGE_COLUMN_NAME: {
-  readonly pattern: RegExp;
-  readonly minLength: 1;
-  readonly maxLength: 64;
-};
-//#endregion
-//#region src/domain/storageTable/nameRule.d.ts
-/**
- * The charset half of each rule, as a sentence.
- *
- * - The generated components carry the rule as a regex; a person filling in a field needs words.
- * - A bucket or table name admits a dash. A column name does not.
- */
-declare const NAME_CHARSET_HINT = "Only alphanumeric characters, dashes, and underscores are allowed.";
-declare const COLUMN_NAME_CHARSET_HINT = "Only alphanumeric characters and underscores are allowed.";
-/**
- * Why Storage would reject `value` as a bucket or table name, or `null` when it would accept it.
- *
- * - Checks the published `StorageName` component — charset, length and the leading underscore.
- * - Knows nothing about names already taken; uniqueness is the caller's own lookup.
- * - `entity` only names the thing in the message.
- */
-declare const validateStorageName: (value: string, entity?: string) => string | null;
-/**
- * Why Storage would reject `value` as a column name, or `null` when it would accept it.
- *
- * - Checks the published `StorageColumnName` component, which is a different, stricter rule than
- *   `validateStorageName`: no dash, 64 characters, and the first character must be alphanumeric.
- * - `POST /v2/storage/validate/column-names` additionally rejects the backend system columns; that
- *   is a server round-trip, not part of this check.
- */
-declare const validateStorageColumnName: (value: string, entity?: string) => string | null;
-//#endregion
-//#region src/domain/storageTable/model.d.ts
-type CreateBucketFn = (input: {
-  stage: BucketStage;
-  name: BucketName;
-  branchId?: string | null;
-}) => Bucket;
-type CreateTableFn = (input: {
-  stage: BucketStage;
-  tableName: TableName;
-  bucketName: BucketName;
-  branchId?: string | null;
-}) => Table;
-type TableModel = {
-  parse(id: string): Table;
-  parseBucket(id: string): Bucket;
-  safeParse(id: string): Table | null;
-  safeParseBucket(id: string): Bucket | null;
-  serializeTableId(table: Table): TableId;
-  serializeBucketId(bucket: Bucket): BucketId;
-  serializeBucketName(bucket: Bucket): BucketName;
-  serializeBucketDisplayName(bucket: Bucket): BucketName;
-  safeSerializeTableId(table: Table): TableId | null;
-  safeSerializeBucketId(bucket: Bucket): BucketId | null;
-  safeSerializeBucketName(bucket: Bucket): BucketName | null;
-  createTable: CreateTableFn;
-  createBucket: CreateBucketFn;
-};
-declare const createTableModel: (options: ModelOptions) => TableModel;
-//#endregion
-//#region src/domain/storageTable/createStorageTable.d.ts
-type StorageTableInstance = {
-  readonly bucket: Bucket;
-  readonly name: TableName | null;
-  isInBranch(branchId: string): boolean;
-  addBranch(branchId: string): StorageTableInstance;
-  removeBranch(branchId: string): StorageTableInstance;
-  /** A new instance with the table name set (or replaced). */
-  addTableName(tableName: TableName): StorageTableInstance;
-  getBucketName(): BucketName;
-  /** Bucket name as shown to users: dev-branch prefix kept, legacy `c-` prefix always dropped. */
-  getBucketDisplayName(): BucketName;
-  /** Bare bucket name: no `c-` prefix, no dev-branch prefix (legacy `baseName`, or the canonical storage-branch name). */
-  getBucketBaseName(): BucketName;
-  getBucketId(): BucketId;
-  getSafeBucketId(): BucketId | null;
-  /** @throws when there is no table name (the instance was built via `createBucket`). */
-  getTableName(): TableName;
-  /** @throws when there is no table name (the instance was built via `createBucket`). */
-  getTableId(): TableId;
-  /** Null when there is no table name (built via `createBucket`) or a segment is empty. */
-  getSafeTableId(): TableId | null;
-};
-type StorageTable = {
-  parse(id: string): StorageTableInstance;
-  safeParse(id: string): StorageTableInstance | null;
-  /** Decode a bucket id (`{stage}.{bucket}`) into a bucket-only instance. */
-  parseBucket(id: string): StorageTableInstance;
-  safeParseBucket(id: string): StorageTableInstance | null;
-  createTable(input: Parameters<CreateTableFn>[0]): StorageTableInstance;
-  createBucket(input: Parameters<CreateBucketFn>[0]): StorageTableInstance;
-  createDefaultBucket(input: {
-    stage: BucketStage;
-    name: string;
-  }): StorageTableInstance;
-  /** Like `createDefaultBucket`, but returns null instead of throwing when the name sanitizes to an empty/invalid segment. */
-  safeCreateDefaultBucket(input: {
-    stage: BucketStage;
-    name: string;
-  }): StorageTableInstance | null;
-  createDefaultConfigBucket(input: {
-    stage: BucketStage;
-    componentId: string;
-    configId: string;
-  }): StorageTableInstance;
-  createDefaultConfigTable(input: {
-    stage: BucketStage;
-    componentId: string;
-    configId: string;
-    tableName: string;
-  }): StorageTableInstance;
-  createDefaultCsvImportTable(configId: string): StorageTableInstance;
-};
-declare const createStorageTable: (flags: ModelOptions) => StorageTable;
-//#endregion
-export { TableId as C, Table as S, TableName as T, BucketStage as _, CreateTableFn as a, ParsedBucket as b, COLUMN_NAME_CHARSET_HINT as c, validateStorageName as d, STORAGE_COLUMN_NAME as f, BucketName as g, BucketId as h, CreateBucketFn as i, NAME_CHARSET_HINT as l, Bucket as m, StorageTableInstance as n, TableModel as o, STORAGE_NAME as p, createStorageTable as r, createTableModel as s, StorageTable as t, validateStorageColumnName as u, LegacyBucket as v, TableIdParts as w, StorageBranchBucket as x, ModelOptions as y };
-//# sourceMappingURL=index-fMoM8SeH.d.cts.map

package/dist/index-fMoM8SeH.d.ts

@@ -1,199 +0,0 @@
-//#region src/domain/storageTable/types.d.ts
-type BucketStage = 'in' | 'out';
-type BucketName = string;
-type TableName = string;
-type BucketId = `${BucketStage}.${BucketName}`;
-type TableId = `${BucketId}.${TableName}`;
-type TableIdParts = [stage: BucketStage, bucket: BucketName, table: TableName];
-type StorageBranchBucket = {
-  kind: 'storage-branch';
-  /** Bare name, no `c-` or `{branchId}-` (branches are BE-side). On-disk: `c-{baseName}` when prefixed. */
-  baseName: BucketName;
-  hasLegacyPrefix: boolean;
-};
-type LegacyBucket = {
-  kind: 'legacy';
-  /**
-   * Bare name, no `c-` or `{branchId}-`. User-facing: `{branchId}-{baseName}`.
-   * On-disk: `c-{branchId}-{baseName}` when prefixed.
-   */
-  baseName: BucketName;
-  hasLegacyPrefix: boolean;
-  /** Dev-branch id encoded into the on-disk name, if any. */
-  branchId: string | null;
-};
-type ParsedBucket = StorageBranchBucket | LegacyBucket;
-type Bucket = ParsedBucket & {
-  stage: BucketStage;
-};
-type Table = {
-  name: TableName;
-  bucket: Bucket;
-};
-type ModelOptions = {
-  /** Project uses the legacy `c-` bucket prefix. (`!ProjectFeature.DisableLegacyBucketPrefix`) */
-  useLegacyBucketPrefix: boolean;
-  /** `ProjectFeature.SoxProtectedDefaultBranch` */
-  hasProtectedDefaultBranch: boolean;
-  /** `ProjectFeature.StorageBranches` */
-  hasStorageBranches: boolean;
-};
-//#endregion
-//#region src/clients/storage/__generated__/constraints.d.ts
-/**
- * The name of a bucket or a table.
- *
- * - Allowed characters: `A-Z`, `a-z`, `0-9`, dash `-` and underscore `_`. Anything else — a
- *   space, a dot, an accented letter — is rejected, not transliterated.
- * - 1 to 96 characters.
- * - Cannot start with an underscore. A dash or a digit as the first character is fine.
- * - Registered (external) buckets follow this same rule, dashes included.
- * - Uniqueness is case-insensitive within a stage: creating `MyBucket` next to `mybucket`
- *   fails with `storage.buckets.alreadyExists`, and for tables with
- *   `storage.buckets.tableAlreadyExists` or `storage.validation.tableAlreadyExists`.
- * - To turn arbitrary user input into a name that satisfies this rule, call
- *   `POST /v2/storage/webalize/display-name` instead of reimplementing the transformation. It
- *   unaccents the input, replaces every run of disallowed characters with a single `-`, trims
- *   `-` from both ends, strips leading underscores, and truncates to 96 characters.
- */
-declare const STORAGE_NAME: {
-  readonly pattern: RegExp;
-  readonly minLength: 1;
-  readonly maxLength: 96;
-};
-/**
- * The name of a table column.
- *
- * - Allowed characters: `A-Z`, `a-z`, `0-9` and underscore `_`. Unlike a bucket or table name,
- *   a column name may **not** contain a dash.
- * - 1 to 64 characters.
- * - Must start with a letter or a digit.
- * - To turn arbitrary user input into a name that satisfies this rule, call
- *   `POST /v2/storage/webalize/column-names` instead of reimplementing the transformation. In
- *   order, it strips emoji, transliterates the rest to ASCII, replaces every run of disallowed
- *   characters with a single `_`, trims `_` from both ends, truncates to 64 characters, and
- *   strips any leading `_` the truncation left behind. Input with no usable character left
- *   webalizes to an empty string, which is *not* a valid column name.
- * - `POST /v2/storage/validate/column-names` applies one rule the creation endpoints do not:
- *   it also rejects the backend system columns `oid`, `tableoid`, `xmin`, `cmin`, `xmax`,
- *   `cmax` and `ctid`.
- */
-declare const STORAGE_COLUMN_NAME: {
-  readonly pattern: RegExp;
-  readonly minLength: 1;
-  readonly maxLength: 64;
-};
-//#endregion
-//#region src/domain/storageTable/nameRule.d.ts
-/**
- * The charset half of each rule, as a sentence.
- *
- * - The generated components carry the rule as a regex; a person filling in a field needs words.
- * - A bucket or table name admits a dash. A column name does not.
- */
-declare const NAME_CHARSET_HINT = "Only alphanumeric characters, dashes, and underscores are allowed.";
-declare const COLUMN_NAME_CHARSET_HINT = "Only alphanumeric characters and underscores are allowed.";
-/**
- * Why Storage would reject `value` as a bucket or table name, or `null` when it would accept it.
- *
- * - Checks the published `StorageName` component — charset, length and the leading underscore.
- * - Knows nothing about names already taken; uniqueness is the caller's own lookup.
- * - `entity` only names the thing in the message.
- */
-declare const validateStorageName: (value: string, entity?: string) => string | null;
-/**
- * Why Storage would reject `value` as a column name, or `null` when it would accept it.
- *
- * - Checks the published `StorageColumnName` component, which is a different, stricter rule than
- *   `validateStorageName`: no dash, 64 characters, and the first character must be alphanumeric.
- * - `POST /v2/storage/validate/column-names` additionally rejects the backend system columns; that
- *   is a server round-trip, not part of this check.
- */
-declare const validateStorageColumnName: (value: string, entity?: string) => string | null;
-//#endregion
-//#region src/domain/storageTable/model.d.ts
-type CreateBucketFn = (input: {
-  stage: BucketStage;
-  name: BucketName;
-  branchId?: string | null;
-}) => Bucket;
-type CreateTableFn = (input: {
-  stage: BucketStage;
-  tableName: TableName;
-  bucketName: BucketName;
-  branchId?: string | null;
-}) => Table;
-type TableModel = {
-  parse(id: string): Table;
-  parseBucket(id: string): Bucket;
-  safeParse(id: string): Table | null;
-  safeParseBucket(id: string): Bucket | null;
-  serializeTableId(table: Table): TableId;
-  serializeBucketId(bucket: Bucket): BucketId;
-  serializeBucketName(bucket: Bucket): BucketName;
-  serializeBucketDisplayName(bucket: Bucket): BucketName;
-  safeSerializeTableId(table: Table): TableId | null;
-  safeSerializeBucketId(bucket: Bucket): BucketId | null;
-  safeSerializeBucketName(bucket: Bucket): BucketName | null;
-  createTable: CreateTableFn;
-  createBucket: CreateBucketFn;
-};
-declare const createTableModel: (options: ModelOptions) => TableModel;
-//#endregion
-//#region src/domain/storageTable/createStorageTable.d.ts
-type StorageTableInstance = {
-  readonly bucket: Bucket;
-  readonly name: TableName | null;
-  isInBranch(branchId: string): boolean;
-  addBranch(branchId: string): StorageTableInstance;
-  removeBranch(branchId: string): StorageTableInstance;
-  /** A new instance with the table name set (or replaced). */
-  addTableName(tableName: TableName): StorageTableInstance;
-  getBucketName(): BucketName;
-  /** Bucket name as shown to users: dev-branch prefix kept, legacy `c-` prefix always dropped. */
-  getBucketDisplayName(): BucketName;
-  /** Bare bucket name: no `c-` prefix, no dev-branch prefix (legacy `baseName`, or the canonical storage-branch name). */
-  getBucketBaseName(): BucketName;
-  getBucketId(): BucketId;
-  getSafeBucketId(): BucketId | null;
-  /** @throws when there is no table name (the instance was built via `createBucket`). */
-  getTableName(): TableName;
-  /** @throws when there is no table name (the instance was built via `createBucket`). */
-  getTableId(): TableId;
-  /** Null when there is no table name (built via `createBucket`) or a segment is empty. */
-  getSafeTableId(): TableId | null;
-};
-type StorageTable = {
-  parse(id: string): StorageTableInstance;
-  safeParse(id: string): StorageTableInstance | null;
-  /** Decode a bucket id (`{stage}.{bucket}`) into a bucket-only instance. */
-  parseBucket(id: string): StorageTableInstance;
-  safeParseBucket(id: string): StorageTableInstance | null;
-  createTable(input: Parameters<CreateTableFn>[0]): StorageTableInstance;
-  createBucket(input: Parameters<CreateBucketFn>[0]): StorageTableInstance;
-  createDefaultBucket(input: {
-    stage: BucketStage;
-    name: string;
-  }): StorageTableInstance;
-  /** Like `createDefaultBucket`, but returns null instead of throwing when the name sanitizes to an empty/invalid segment. */
-  safeCreateDefaultBucket(input: {
-    stage: BucketStage;
-    name: string;
-  }): StorageTableInstance | null;
-  createDefaultConfigBucket(input: {
-    stage: BucketStage;
-    componentId: string;
-    configId: string;
-  }): StorageTableInstance;
-  createDefaultConfigTable(input: {
-    stage: BucketStage;
-    componentId: string;
-    configId: string;
-    tableName: string;
-  }): StorageTableInstance;
-  createDefaultCsvImportTable(configId: string): StorageTableInstance;
-};
-declare const createStorageTable: (flags: ModelOptions) => StorageTable;
-//#endregion
-export { TableId as C, Table as S, TableName as T, BucketStage as _, CreateTableFn as a, ParsedBucket as b, COLUMN_NAME_CHARSET_HINT as c, validateStorageName as d, STORAGE_COLUMN_NAME as f, BucketName as g, BucketId as h, CreateBucketFn as i, NAME_CHARSET_HINT as l, Bucket as m, StorageTableInstance as n, TableModel as o, STORAGE_NAME as p, createStorageTable as r, createTableModel as s, StorageTable as t, validateStorageColumnName as u, LegacyBucket as v, TableIdParts as w, StorageBranchBucket as x, ModelOptions as y };
-//# sourceMappingURL=index-fMoM8SeH.d.ts.map