@keboola/api-client 25.0.0 → 29.0.0

package/dist/index-BMqLPS6S.d.cts

@@ -0,0 +1,135 @@
+//#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';
+  /**
+   * The bare name: no `c-` prefix. Branches are BE-side, so there is no `{branchId}-` decoration. e.g. `main`.
+   * The on-disk form is derived from it by adding the legacy `c-` prefix:
+   *   name (on-disk) = `c-{baseName}` (adds `c-` when hasLegacyPrefix)
+   */
+  baseName: BucketName;
+  /** When true, the on-disk name carries the legacy `c-` prefix. */
+  hasLegacyPrefix: boolean;
+};
+type LegacyBucket = {
+  kind: 'legacy';
+  /**
+   * The bare name: no `c-` prefix, no `{branchId}-` prefix. e.g. `main`.
+   * The two on-disk forms are derived from it by adding decoration:
+   *   branchedName = `{branchId}-{baseName}`   (drops `c-`, keeps branch — user-facing)
+   *   name (on-disk) = `c-{branchedName}`       (adds `c-` when hasLegacyPrefix)
+   */
+  baseName: BucketName;
+  /** When true, the on-disk name carries the legacy `c-` prefix. */
+  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. (kbc-ui: `!FEATURE_DISABLE_LEGACY_BUCKET_PREFIX`) */
+  useLegacyBucketPrefix: boolean;
+  /** `FEATURE_SOX_PROTECTED_DEFAULT_BRANCH` */
+  hasProtectedDefaultBranch: boolean;
+  /** `FEATURE_STORAGE_BRANCHES` */
+  hasStorageBranches: boolean;
+};
+//#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 _, CreateTableFn as a, Bucket as c, BucketStage as d, LegacyBucket as f, Table as g, StorageBranchBucket as h, CreateBucketFn as i, BucketId as l, ParsedBucket as m, StorageTableInstance as n, TableModel as o, ModelOptions as p, createStorageTable as r, createTableModel as s, StorageTable as t, BucketName as u, TableIdParts as v, TableName as y };
+//# sourceMappingURL=index-BMqLPS6S.d.cts.map

package/dist/index-BMqLPS6S.d.ts

@@ -0,0 +1,135 @@
+//#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';
+  /**
+   * The bare name: no `c-` prefix. Branches are BE-side, so there is no `{branchId}-` decoration. e.g. `main`.
+   * The on-disk form is derived from it by adding the legacy `c-` prefix:
+   *   name (on-disk) = `c-{baseName}` (adds `c-` when hasLegacyPrefix)
+   */
+  baseName: BucketName;
+  /** When true, the on-disk name carries the legacy `c-` prefix. */
+  hasLegacyPrefix: boolean;
+};
+type LegacyBucket = {
+  kind: 'legacy';
+  /**
+   * The bare name: no `c-` prefix, no `{branchId}-` prefix. e.g. `main`.
+   * The two on-disk forms are derived from it by adding decoration:
+   *   branchedName = `{branchId}-{baseName}`   (drops `c-`, keeps branch — user-facing)
+   *   name (on-disk) = `c-{branchedName}`       (adds `c-` when hasLegacyPrefix)
+   */
+  baseName: BucketName;
+  /** When true, the on-disk name carries the legacy `c-` prefix. */
+  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. (kbc-ui: `!FEATURE_DISABLE_LEGACY_BUCKET_PREFIX`) */
+  useLegacyBucketPrefix: boolean;
+  /** `FEATURE_SOX_PROTECTED_DEFAULT_BRANCH` */
+  hasProtectedDefaultBranch: boolean;
+  /** `FEATURE_STORAGE_BRANCHES` */
+  hasStorageBranches: boolean;
+};
+//#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 _, CreateTableFn as a, Bucket as c, BucketStage as d, LegacyBucket as f, Table as g, StorageBranchBucket as h, CreateBucketFn as i, BucketId as l, ParsedBucket as m, StorageTableInstance as n, TableModel as o, ModelOptions as p, createStorageTable as r, createTableModel as s, StorageTable as t, BucketName as u, TableIdParts as v, TableName as y };
+//# sourceMappingURL=index-BMqLPS6S.d.ts.map

package/dist/index-BWBScAYc.d.cts

@@ -0,0 +1,16 @@
+import { n as ClientInitOptions } from "./types-C8XiTXxi.cjs";
+import { a as EncryptQuery, s as ScopedSecrets } from "./types-DvsGS8By.cjs";
+//#region src/clients/encryption/encryptionClient.d.ts
+declare const createEncryptionClient: ({ baseUrl, middlewares }: Omit<ClientInitOptions, 'auth'>) => {
+  healthCheck: (signal?: AbortSignal) => Promise<unknown>;
+  encryptSecrets: <T extends Record<string, unknown>>(data: EncryptQuery & {
+    data: T;
+  }, signal?: AbortSignal) => Promise<T>;
+  encryptScopedSecrets: <T extends Record<string, unknown>>({ scope, ...params }: ScopedSecrets<T>, signal?: AbortSignal) => Promise<T>;
+  encrypt: (data: EncryptQuery & {
+    data: string;
+  }, signal?: AbortSignal) => Promise<string>;
+};
+//#endregion
+export { createEncryptionClient as t };
+//# sourceMappingURL=index-BWBScAYc.d.cts.map