@platformatic/kafka 1.23.0 → 1.24.0

package/dist/clients/admin/options.js

@@ -1,4 +1,4 @@
-import { ClientQuotaMatchTypes, ConsumerGroupStates } from "../../apis/enumerations.js";
+import { allowedIncrementalAlterConfigOperationTypes, allowedResourceTypes, ConsumerGroupStates, IncrementalAlterConfigOperationTypes, allowedAclOperations, allowedAclPermissionTypes, allowedResourcePatternTypes, allowedFetchIsolationLevels, allowedClientQuotaMatchTypes } from "../../apis/enumerations.js";
 import { ajv, listErrorMessage } from "../../utils.js";
 import { idProperty } from "../base/options.js";
 export const groupsProperties = {
@@ -46,6 +46,38 @@ export const deleteTopicOptionsSchema = {
     required: ['topics'],
     additionalProperties: false
 };
+export const createPartitionsOptionsSchema = {
+    type: 'object',
+    properties: {
+        topics: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    name: idProperty,
+                    count: { type: 'number', minimum: 1 },
+                    assignments: {
+                        type: 'array',
+                        items: {
+                            type: 'object',
+                            properties: {
+                                brokerIds: { type: 'array', items: { type: 'number' }, minItems: 1 }
+                            },
+                            required: ['brokerIds'],
+                            additionalProperties: false
+                        }
+                    }
+                },
+                required: ['name', 'count'],
+                additionalProperties: false
+            },
+            minItems: 1
+        },
+        validateOnly: { type: 'boolean', default: false }
+    },
+    required: ['topics'],
+    additionalProperties: false
+};
 export const listGroupsOptionsSchema = {
     type: 'object',
     properties: {
@@ -113,7 +145,7 @@ export const describeClientQuotasOptionsSchema = {
                 type: 'object',
                 properties: {
                     entityType: { type: 'string', minLength: 1 },
-                    matchType: { type: 'number', enum: Object.values(ClientQuotaMatchTypes) },
+                    matchType: { type: 'number', enum: allowedClientQuotaMatchTypes },
                     match: { type: 'string' }
                 },
                 required: ['entityType', 'matchType'],
@@ -209,7 +241,322 @@ export const describeLogDirsOptionsSchema = {
     required: ['topics'],
     additionalProperties: false
 };
+export const listConsumerGroupOffsetsOptionsSchema = {
+    type: 'object',
+    properties: {
+        groups: {
+            type: 'array',
+            items: {
+                oneOf: [
+                    { type: 'string', minLength: 1 },
+                    {
+                        type: 'object',
+                        properties: {
+                            groupId: { type: 'string', minLength: 1 },
+                            topics: {
+                                type: ['array', 'null'],
+                                items: {
+                                    type: 'object',
+                                    properties: {
+                                        name: { type: 'string', minLength: 1 },
+                                        partitionIndexes: {
+                                            type: 'array',
+                                            items: { type: 'number', minimum: 0 },
+                                            minItems: 1
+                                        }
+                                    },
+                                    required: ['name', 'partitionIndexes'],
+                                    additionalProperties: false
+                                },
+                                minItems: 1
+                            }
+                        },
+                        required: ['groupId'],
+                        additionalProperties: false
+                    }
+                ]
+            },
+            minItems: 1
+        },
+        requireStable: {
+            type: 'boolean'
+        }
+    },
+    required: ['groups'],
+    additionalProperties: false
+};
+export const alterConsumerGroupOffsetsOptionsSchema = {
+    type: 'object',
+    properties: {
+        groupId: { type: 'string', minLength: 1 },
+        topics: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    name: { type: 'string', minLength: 1 },
+                    partitionOffsets: {
+                        type: 'array',
+                        items: {
+                            type: 'object',
+                            properties: {
+                                partition: { type: 'number', minimum: 0 },
+                                offset: { bigint: true }
+                            },
+                            required: ['partition', 'offset'],
+                            additionalProperties: false
+                        },
+                        minItems: 1
+                    }
+                },
+                required: ['name', 'partitionOffsets'],
+                additionalProperties: false
+            },
+            minItems: 1
+        }
+    },
+    required: ['groupId', 'topics'],
+    additionalProperties: false
+};
+export const deleteConsumerGroupOffsetsOptionsSchema = {
+    type: 'object',
+    properties: {
+        groupId: { type: 'string', minLength: 1 },
+        topics: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    name: { type: 'string', minLength: 1 },
+                    partitionIndexes: {
+                        type: 'array',
+                        items: { type: 'number', minimum: 0 },
+                        minItems: 1
+                    }
+                },
+                required: ['name', 'partitionIndexes'],
+                additionalProperties: false
+            },
+            minItems: 1
+        }
+    },
+    required: ['groupId', 'topics'],
+    additionalProperties: false
+};
+export const describeConfigsOptionsSchema = {
+    type: 'object',
+    properties: {
+        resources: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    resourceType: { type: 'number', enum: allowedResourceTypes },
+                    resourceName: { type: 'string', minLength: 1 },
+                    configurationKeys: {
+                        type: ['array', 'null'],
+                        items: { type: 'string', minLength: 1 }
+                    }
+                },
+                required: ['resourceType', 'resourceName'],
+                additionalProperties: false
+            },
+            minItems: 1
+        },
+        includeSynonyms: { type: 'boolean' },
+        includeDocumentation: { type: 'boolean' }
+    },
+    required: ['resources'],
+    additionalProperties: false
+};
+export const alterConfigsOptionsSchema = {
+    type: 'object',
+    properties: {
+        resources: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    resourceType: { type: 'number', enum: allowedResourceTypes },
+                    resourceName: { type: 'string', minLength: 1 },
+                    configs: {
+                        type: 'array',
+                        items: {
+                            type: 'object',
+                            properties: {
+                                name: { type: 'string', minLength: 1 },
+                                value: { type: ['string', 'null'] }
+                            },
+                            required: ['name'],
+                            additionalProperties: false
+                        },
+                        minItems: 1
+                    }
+                },
+                required: ['resourceType', 'resourceName', 'configs'],
+                additionalProperties: false
+            },
+            minItems: 1
+        },
+        validateOnly: { type: 'boolean' }
+    },
+    required: ['resources'],
+    additionalProperties: false
+};
+export const incrementalAlterConfigsOptionsSchema = {
+    type: 'object',
+    properties: {
+        resources: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    resourceType: { type: 'number', enum: allowedResourceTypes },
+                    resourceName: { type: 'string', minLength: 1 },
+                    configs: {
+                        type: 'array',
+                        items: {
+                            oneOf: [
+                                {
+                                    type: 'object',
+                                    properties: {
+                                        name: { type: 'string', minLength: 1 },
+                                        configOperation: {
+                                            type: 'number',
+                                            enum: [
+                                                ...allowedIncrementalAlterConfigOperationTypes.filter(v => v !== IncrementalAlterConfigOperationTypes.DELETE)
+                                            ]
+                                        },
+                                        value: { type: 'string' }
+                                    },
+                                    required: ['name', 'configOperation', 'value'],
+                                    additionalProperties: false
+                                },
+                                {
+                                    type: 'object',
+                                    properties: {
+                                        name: { type: 'string', minLength: 1 },
+                                        configOperation: { type: 'number', enum: [IncrementalAlterConfigOperationTypes.DELETE] }
+                                    },
+                                    required: ['name', 'configOperation'],
+                                    additionalProperties: false
+                                }
+                            ]
+                        },
+                        minItems: 1
+                    }
+                },
+                required: ['resourceType', 'resourceName', 'configs'],
+                additionalProperties: false
+            },
+            minItems: 1
+        },
+        validateOnly: { type: 'boolean' }
+    },
+    required: ['resources'],
+    additionalProperties: false
+};
+const aclSchema = {
+    type: 'object',
+    properties: {
+        resourceType: { type: 'number', enum: allowedResourceTypes },
+        resourceName: { type: 'string', minLength: 1 },
+        resourcePatternType: { type: 'number', enum: allowedResourcePatternTypes },
+        principal: { type: 'string', minLength: 1 },
+        host: { type: 'string', minLength: 1 },
+        operation: { type: 'number', enum: allowedAclOperations },
+        permissionType: { type: 'number', enum: allowedAclPermissionTypes }
+    },
+    required: ['resourceType', 'resourceName', 'resourcePatternType', 'principal', 'host', 'operation', 'permissionType'],
+    additionalProperties: false
+};
+const aclFilterSchema = {
+    type: 'object',
+    properties: {
+        resourceType: { type: 'number', enum: allowedResourceTypes },
+        resourceName: {
+            anyOf: [{ type: 'string', minLength: 1 }, { type: 'null' }]
+        },
+        resourcePatternType: { type: 'number', enum: allowedResourcePatternTypes },
+        principal: {
+            anyOf: [{ type: 'string', minLength: 1 }, { type: 'null' }]
+        },
+        host: {
+            anyOf: [{ type: 'string', minLength: 1 }, { type: 'null' }]
+        },
+        operation: { type: 'number', enum: allowedAclOperations },
+        permissionType: { type: 'number', enum: allowedAclPermissionTypes }
+    },
+    required: ['resourceType', 'resourcePatternType', 'operation', 'permissionType'],
+    additionalProperties: false
+};
+export const createAclsOptionsSchema = {
+    type: 'object',
+    properties: {
+        creations: {
+            type: 'array',
+            items: aclSchema,
+            minItems: 1
+        }
+    },
+    required: ['creations'],
+    additionalProperties: false
+};
+export const describeAclsOptionsSchema = {
+    type: 'object',
+    properties: {
+        filter: aclFilterSchema
+    },
+    required: ['filter'],
+    additionalProperties: false
+};
+export const deleteAclsOptionsSchema = {
+    type: 'object',
+    properties: {
+        filters: {
+            type: 'array',
+            items: aclFilterSchema,
+            minItems: 1
+        }
+    },
+    required: ['filters'],
+    additionalProperties: false
+};
+export const listOffsetsOptionsSchema = {
+    type: 'object',
+    properties: {
+        topics: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    name: { type: 'string', minLength: 1 },
+                    partitions: {
+                        type: 'array',
+                        items: {
+                            type: 'object',
+                            properties: {
+                                partitionIndex: { type: 'number', minimum: 0 },
+                                timestamp: { bigint: true }
+                            },
+                            required: ['partitionIndex', 'timestamp'],
+                            additionalProperties: false
+                        },
+                        minItems: 1
+                    }
+                },
+                required: ['name', 'partitions'],
+                additionalProperties: false
+            },
+            minItems: 1
+        },
+        isolationLevel: { type: ['number', 'null'], enum: [null, ...allowedFetchIsolationLevels] }
+    },
+    required: ['topics'],
+    additionalProperties: false
+};
 export const createTopicsOptionsValidator = ajv.compile(createTopicOptionsSchema);
+export const createPartitionsOptionsValidator = ajv.compile(createPartitionsOptionsSchema);
 export const listTopicsOptionsValidator = ajv.compile(listTopicOptionsSchema);
 export const deleteTopicsOptionsValidator = ajv.compile(deleteTopicOptionsSchema);
 export const listGroupsOptionsValidator = ajv.compile(listGroupsOptionsSchema);
@@ -219,3 +566,13 @@ export const removeMembersFromConsumerGroupOptionsValidator = ajv.compile(remove
 export const describeClientQuotasOptionsValidator = ajv.compile(describeClientQuotasOptionsSchema);
 export const alterClientQuotasOptionsValidator = ajv.compile(alterClientQuotasOptionsSchema);
 export const describeLogDirsOptionsValidator = ajv.compile(describeLogDirsOptionsSchema);
+export const alterConsumerGroupOffsetsOptionsValidator = ajv.compile(alterConsumerGroupOffsetsOptionsSchema);
+export const deleteConsumerGroupOffsetsOptionsValidator = ajv.compile(deleteConsumerGroupOffsetsOptionsSchema);
+export const listConsumerGroupOffsetsOptionsValidator = ajv.compile(listConsumerGroupOffsetsOptionsSchema);
+export const describeConfigsOptionsValidator = ajv.compile(describeConfigsOptionsSchema);
+export const alterConfigsOptionsValidator = ajv.compile(alterConfigsOptionsSchema);
+export const incrementalAlterConfigsOptionsValidator = ajv.compile(incrementalAlterConfigsOptionsSchema);
+export const createAclsOptionsValidator = ajv.compile(createAclsOptionsSchema);
+export const describeAclsOptionsValidator = ajv.compile(describeAclsOptionsSchema);
+export const deleteAclsOptionsValidator = ajv.compile(deleteAclsOptionsSchema);
+export const listOffsetsOptionsValidator = ajv.compile(listOffsetsOptionsSchema);

package/dist/clients/admin/types.d.ts

@@ -1,11 +1,16 @@
 import { type AlterClientQuotasRequestEntry } from '../../apis/admin/alter-client-quotas-v1.ts';
+import { type CreatePartitionsRequestTopic } from '../../apis/admin/create-partitions-v3.ts';
 import { type CreateTopicsRequestTopicConfig } from '../../apis/admin/create-topics-v7.ts';
+import { type AlterConfigsRequestResource } from '../../apis/admin/alter-configs-v2.ts';
+import { type DescribeConfigsRequestResource, type DescribeConfigsResponseConfig } from '../../apis/admin/describe-configs-v4.ts';
 import { type DescribeClientQuotasRequestComponent } from '../../apis/admin/describe-client-quotas-v0.ts';
 import { type DescribeLogDirsRequestTopic, type DescribeLogDirsResponse, type DescribeLogDirsResponseResult } from '../../apis/admin/describe-log-dirs-v4.ts';
-import { type ConsumerGroupState } from '../../apis/enumerations.ts';
+import { type IncrementalAlterConfigsRequestResource } from '../../apis/admin/incremental-alter-configs-v1.ts';
+import { type FetchIsolationLevelValue, type ConfigResourceTypeValue, type ConsumerGroupStateValue } from '../../apis/enumerations.ts';
 import { type Nullable, type NullableString } from '../../protocol/definitions.ts';
 import { type BaseOptions } from '../base/types.ts';
 import { type ExtendedGroupProtocolSubscription, type GroupAssignment } from '../consumer/types.ts';
+import { type Acl, type AclFilter } from '../../apis/types.ts';
 export interface BrokerAssignment {
     partition: number;
     brokers: number[];
@@ -27,7 +32,7 @@ export interface GroupMember {
 }
 export interface GroupBase {
     id: string;
-    state: ConsumerGroupState;
+    state: ConsumerGroupStateValue;
     groupType: string;
     protocolType: string;
 }
@@ -51,8 +56,12 @@ export interface ListTopicsOptions {
 export interface DeleteTopicsOptions {
     topics: string[];
 }
+export interface CreatePartitionsOptions {
+    topics: CreatePartitionsRequestTopic[];
+    validateOnly?: boolean;
+}
 export interface ListGroupsOptions {
-    states?: ConsumerGroupState[];
+    states?: ConsumerGroupStateValue[];
     types?: string[];
 }
 export interface DescribeGroupsOptions {
@@ -86,4 +95,97 @@ export interface BrokerLogDirDescription {
     throttleTimeMs: DescribeLogDirsResponse['throttleTimeMs'];
     results: Omit<DescribeLogDirsResponseResult, 'errorCode'>[];
 }
+interface GroupWithTopicPartitions {
+    groupId: string;
+    topics?: Nullable<{
+        name: string;
+        partitionIndexes: number[];
+    }[]>;
+}
+export interface ListConsumerGroupOffsetsOptions {
+    groups: (string | GroupWithTopicPartitions)[];
+    requireStable?: boolean;
+}
+interface ListConsumerGroupOffsetsPartition {
+    partitionIndex: number;
+    committedOffset: bigint;
+    committedLeaderEpoch: number;
+    metadata: NullableString;
+}
+interface ListConsumerGroupOffsetsTopic {
+    name: string;
+    partitions: ListConsumerGroupOffsetsPartition[];
+}
+export interface ListConsumerGroupOffsetsGroup {
+    groupId: string;
+    topics: ListConsumerGroupOffsetsTopic[];
+}
+interface PartitionOffset {
+    partition: number;
+    offset: bigint;
+}
+interface AlterConsumerGroupOffsetsTopic {
+    name: string;
+    partitionOffsets: PartitionOffset[];
+}
+export interface AlterConsumerGroupOffsetsOptions {
+    groupId: string;
+    topics: AlterConsumerGroupOffsetsTopic[];
+}
+export interface DeleteConsumerGroupOffsetsOptions {
+    groupId: string;
+    topics: {
+        name: string;
+        partitionIndexes: number[];
+    }[];
+}
+export interface DescribeConfigsOptions {
+    resources: DescribeConfigsRequestResource[];
+    includeSynonyms?: boolean;
+    includeDocumentation?: boolean;
+}
+export interface ConfigDescription {
+    resourceType: ConfigResourceTypeValue;
+    resourceName: string;
+    configs: DescribeConfigsResponseConfig[];
+}
+export interface AlterConfigsOptions {
+    resources: AlterConfigsRequestResource[];
+    validateOnly?: boolean;
+}
+export interface IncrementalAlterConfigsOptions {
+    resources: IncrementalAlterConfigsRequestResource[];
+    validateOnly?: boolean;
+}
+export interface CreateAclsOptions {
+    creations: Acl[];
+}
+export interface DescribeAclsOptions {
+    filter: AclFilter;
+}
+export interface DeleteAclsOptions {
+    filters: AclFilter[];
+}
+export interface PartitionTimestamp {
+    partitionIndex: number;
+    timestamp: bigint;
+}
+export interface TopicOffsetRequest {
+    name: string;
+    partitions: PartitionTimestamp[];
+}
+export interface ListOffsetsOptions {
+    topics: TopicOffsetRequest[];
+    isolationLevel?: Nullable<FetchIsolationLevelValue>;
+}
+export interface ListedOffsetsPartition {
+    partitionIndex: number;
+    timestamp: bigint;
+    offset: bigint;
+    leaderEpoch: number;
+}
+export interface ListedOffsetsTopic {
+    name: string;
+    partitions: ListedOffsetsPartition[];
+}
 export {};