apache-iggy 0.5.0-edge.1 → 0.5.0-edge.2

package/README.md

@@ -4,30 +4,30 @@ Apache Iggy Node.js client written in typescript, it currently only supports tcp
 
 diclaimer: although all iggy commands & basic client/stream are implemented this is still a WIP, provided as is, and has still a long way to go to be considered "battle tested".
 
-note: This lib started as _iggy-bin_ ( [github](https://github.com/T1B0/iggy-bin) / [npm](https://www.npmjs.com/package/iggy-bin)) before migrating under iggy-rs org. package iggy-bin@v1.3.4 is equivalent to @iggy.rs/sdk@v1.0.3 and migrating again under apache iggy monorepo ( [github](https://github.com/apache/iggy/tree/master/foreign/node) and is now published on npmjs as @apache-iggy/node-sdk
+note: This lib started as _iggy-bin_ ( [github](https://github.com/T1B0/iggy-bin) / [npm](https://www.npmjs.com/package/iggy-bin)) before migrating under iggy-rs org. package iggy-bin@v1.3.4 is equivalent to @iggy.rs/sdk@v1.0.3 and migrating again under apache iggy monorepo ( [github](https://github.com/apache/iggy/tree/master/foreign/node) and is now published on npmjs as apache-iggy
 
 note: previous works on node.js http client has been moved to [iggy-node-http-client](<https://github.com/iggy-rs/iggy-node-http-client>) (moved on 04 July 2024)
 
 ## install
 
 ```bash
-npm i --save @apache-iggy/node-sdk
+npm i --save apache-iggy
 ```
 
 ## basic usage
 
 ```ts
-import { Client } from "@apache-iggy/node-sdk";
+import { Client } from "apache-iggy";
 
 const credentials = { username: "iggy", password: "iggy" };
 
-const c = new Client({
+const client = new Client({
   transport: "TCP",
   options: { port: 8090, host: "127.0.0.1" },
   credentials,
 });
 
-const stats = await c.system.getStats();
+const stats = await client.system.getStats();
 ```
 
 ## use sources

package/dist/{src/wire → wire}/client/client.utils.js

@@ -33,6 +33,8 @@ export const deserializeClient = (r, pos = 0) => {
      * 13 - x   string - adress
      *  x - x+4 u32 - consumerGroupCount
      */
+    if (r.length < 17)
+        throw new Error('Client does not exist');
     const addressLength = r.readUInt32LE(pos + 9);
     return {
         bytesRead: 13 + addressLength + 4,

package/dist/{src/wire → wire}/stream/stream.utils.js

@@ -18,6 +18,8 @@
  */
 import { toDate } from '../serialize.utils.js';
 export const deserializeToStream = (r, pos = 0) => {
+    if (r.length === 0)
+        throw new Error('Steam does not exist');
     const id = r.readUInt32LE(pos);
     const createdAt = toDate(r.readBigUint64LE(pos + 4));
     const topicsCount = r.readUInt32LE(pos + 12);

package/dist/{src/wire → wire}/topic/create-topic.command.d.ts

@@ -18,13 +18,13 @@
  */
 import type { CommandResponse } from '../../client/client.type.js';
 import { type Id } from '../identifier.utils.js';
-import { type Topic, type CompressionAlgorithm } from './topic.utils.js';
+import { type Topic, type CompressionAlgorithm as CompressionAlgorithmT } from './topic.utils.js';
 export type CreateTopic = {
     streamId: Id;
     topicId: number;
     name: string;
     partitionCount: number;
-    compressionAlgorithm: CompressionAlgorithm;
+    compressionAlgorithm: CompressionAlgorithmT;
     messageExpiry?: bigint;
     maxTopicSize?: bigint;
     replicationFactor?: number;

package/dist/{src/wire → wire}/topic/create-topic.command.js

@@ -19,10 +19,10 @@
 import { serializeIdentifier } from '../identifier.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
-import { isValidCompressionAlgorithm, CompressionAlgorithmKind, deserializeTopic } from './topic.utils.js';
+import { isValidCompressionAlgorithm, CompressionAlgorithm, deserializeTopic } from './topic.utils.js';
 export const CREATE_TOPIC = {
     code: COMMAND_CODE.CreateTopic,
-    serialize: ({ streamId, topicId, name, partitionCount, compressionAlgorithm = CompressionAlgorithmKind.None, messageExpiry = 0n, maxTopicSize = 0n, replicationFactor = 1 }) => {
+    serialize: ({ streamId, topicId, name, partitionCount, compressionAlgorithm = CompressionAlgorithm.None, messageExpiry = 0n, maxTopicSize = 0n, replicationFactor = 1 }) => {
         const streamIdentifier = serializeIdentifier(streamId);
         const bName = Buffer.from(name);
         if (replicationFactor < 1 || replicationFactor > 255)

package/dist/{src/wire → wire}/topic/index.d.ts

@@ -22,4 +22,5 @@ export * from './get-topic.command.js';
 export * from './get-topics.command.js';
 export * from './purge-topic.command.js';
 export * from './update-topic.command.js';
+export { CompressionAlgorithm } from './topic.utils.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/{src/wire → wire}/topic/index.js

@@ -22,4 +22,5 @@ export * from './get-topic.command.js';
 export * from './get-topics.command.js';
 export * from './purge-topic.command.js';
 export * from './update-topic.command.js';
+export { CompressionAlgorithm } from './topic.utils.js';
 //# sourceMappingURL=index.js.map

package/dist/{src/wire → wire}/topic/topic.utils.d.ts

@@ -52,13 +52,13 @@ type BaseTopicSerialized = {
 type TopicSerialized = {
     data: Topic;
 } & Serialized;
-export declare const CompressionAlgorithmKind: {
+export declare const CompressionAlgorithm: {
     None: number;
     Gzip: number;
 };
-export type CompressionAlgorithmKind = typeof CompressionAlgorithmKind;
-export type CompressionAlgorithmKindId = keyof CompressionAlgorithmKind;
-export type CompressionAlgorithmKindValue = ValueOf<CompressionAlgorithmKind>;
+export type CompressionAlgorithmKind = typeof CompressionAlgorithm;
+export type CompressionAlgorithmKindId = keyof CompressionAlgorithm;
+export type CompressionAlgorithmKindValue = ValueOf<CompressionAlgorithm>;
 export type CompressionAlgorithmNone = CompressionAlgorithmKind['None'];
 export type CompressionAlgorithmGzip = CompressionAlgorithmKind['Gzip'];
 export type CompressionAlgorithm = CompressionAlgorithmNone | CompressionAlgorithmGzip;

package/dist/{src/wire → wire}/topic/topic.utils.js

@@ -17,11 +17,11 @@
  * under the License.
  */
 import { toDate } from '../serialize.utils.js';
-export const CompressionAlgorithmKind = {
+export const CompressionAlgorithm = {
     None: 1,
     Gzip: 2
 };
-export const isValidCompressionAlgorithm = (ca) => Object.values(CompressionAlgorithmKind).includes(ca);
+export const isValidCompressionAlgorithm = (ca) => Object.values(CompressionAlgorithm).includes(ca);
 export const deserializeBaseTopic = (p, pos = 0) => {
     const id = p.readUInt32LE(pos);
     const createdAt = toDate(p.readBigUint64LE(pos + 4));

package/dist/{src/wire → wire}/topic/update-topic.command.d.ts

@@ -17,12 +17,12 @@
  * under the License.
  */
 import { type Id } from '../identifier.utils.js';
-import { type CompressionAlgorithm } from './topic.utils.js';
+import { type CompressionAlgorithm as CompressionAlgorithmT } from './topic.utils.js';
 export type UpdateTopic = {
     streamId: Id;
     topicId: Id;
     name: string;
-    compressionAlgorithm?: CompressionAlgorithm;
+    compressionAlgorithm?: CompressionAlgorithmT;
     messageExpiry?: bigint;
     maxTopicSize?: bigint;
     replicationFactor?: number;

package/dist/{src/wire → wire}/topic/update-topic.command.js

@@ -20,10 +20,10 @@ import { serializeIdentifier } from '../identifier.utils.js';
 import { deserializeVoidResponse } from '../../client/client.utils.js';
 import { wrapCommand } from '../command.utils.js';
 import { COMMAND_CODE } from '../command.code.js';
-import { CompressionAlgorithmKind, isValidCompressionAlgorithm } from './topic.utils.js';
+import { CompressionAlgorithm, isValidCompressionAlgorithm } from './topic.utils.js';
 export const UPDATE_TOPIC = {
     code: COMMAND_CODE.UpdateTopic,
-    serialize: ({ streamId, topicId, name, compressionAlgorithm = CompressionAlgorithmKind.None, messageExpiry = 0n, maxTopicSize = 0n, replicationFactor = 1, }) => {
+    serialize: ({ streamId, topicId, name, compressionAlgorithm = CompressionAlgorithm.None, messageExpiry = 0n, maxTopicSize = 0n, replicationFactor = 1, }) => {
         const streamIdentifier = serializeIdentifier(streamId);
         const topicIdentifier = serializeIdentifier(topicId);
         const bName = Buffer.from(name);

package/dist/{src/wire → wire}/user/user.utils.js

@@ -33,6 +33,8 @@ const statusString = (t) => {
     }
 };
 export const deserializeBaseUser = (p, pos = 0) => {
+    if (p.length === 0)
+        throw new Error('User does not exist');
     const id = p.readUInt32LE(pos);
     const createdAt = toDate(p.readBigUInt64LE(pos + 4));
     const status = statusString(p.readUInt8(pos + 12));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "apache-iggy",
   "type": "module",
-  "version": "0.5.0-edge.1",
+  "version": "0.5.0-edge.2",
   "description": "Official Apache Iggy NodeJS SDK",
   "keywords": [
     "iggy",
@@ -19,8 +19,8 @@
   },
   "publishConfig": {
     "access": "public",
-    "main": "dist/src/index.js",
-    "types": "dist/src/index.d.ts"
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts"
   },
   "homepage": "https://iggy.apache.org",
   "files": [

package/dist/src/bdd/auth.d.ts

@@ -1,20 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-export {};
-//# sourceMappingURL=auth.d.ts.map

package/dist/src/bdd/auth.js

@@ -1,38 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-import assert from 'node:assert/strict';
-import { Client } from '../client/index.js';
-import { Given } from "@cucumber/cucumber";
-import { getIggyAddress } from '../tcp.sm.utils.js';
-const credentials = { username: 'iggy', password: 'iggy' };
-const [host, port] = getIggyAddress();
-const opt = {
-    transport: 'TCP',
-    options: { host, port },
-    credentials
-};
-Given('I have a running Iggy server', function () {
-    return true;
-});
-Given('I am authenticated as the root user', async function () {
-    this.client = new Client(opt);
-    assert.deepEqual({ userId: 1 }, await this.client.session.login(credentials));
-    assert.equal(true, await this.client.system.ping());
-});
-//# sourceMappingURL=auth.js.map

package/dist/src/bdd/message.d.ts

@@ -1,20 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-export {};
-//# sourceMappingURL=message.d.ts.map

package/dist/src/bdd/message.js

@@ -1,70 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-import assert from 'node:assert/strict';
-import { When, Then } from "@cucumber/cucumber";
-import { Consumer, PollingStrategy, Partitioning } from '../wire/index.js';
-import { someMessageContent } from '../tcp.sm.utils.js';
-const generateTestMessages = (count = 1) => {
-    return [...Array(count)].map((_, i) => ({ id: i + 1, ...someMessageContent() }));
-};
-When('I send {int} messages to stream {int}, topic {int}, partition {int}', async function (msgCount, streamId, topicId, partitionId) {
-    this.sendMessages = generateTestMessages(msgCount);
-    assert.ok(await this.client.message.send({
-        streamId,
-        topicId,
-        messages: this.sendMessages,
-        partition: Partitioning.PartitionId(partitionId)
-    }));
-});
-Then('all messages should be sent successfully', () => true);
-When('I poll messages from stream {int}, topic {int}, partition {int} starting from offset {int}', async function (streamId, topicId, partitionId, offset) {
-    const pollReq = {
-        streamId,
-        topicId,
-        consumer: Consumer.Single,
-        partitionId,
-        pollingStrategy: PollingStrategy.Offset(BigInt(offset)),
-        count: 100,
-        autocommit: true
-    };
-    const { messages } = await this.client.message.poll(pollReq);
-    this.polledMessages = messages;
-    assert.equal(this.polledMessages.length, this.sendMessages.length);
-});
-Then('I should receive {int} messages', function (msgCount) {
-    assert.equal(this.polledMessages.length, msgCount);
-});
-Then('the messages should have sequential offsets from {int} to {int}', function (from, to) {
-    for (let i = from; i < to; i++) {
-        assert.equal(BigInt(i), this.polledMessages[i].headers.offset);
-    }
-});
-Then('each message should have the expected payload content', function () {
-    this.sendMessages.forEach((msg, i) => {
-        assert.deepEqual(msg.payload.toString(), this.polledMessages[i].payload.toString());
-        assert.equal(BigInt(msg.id || 0), this.polledMessages[i].headers.id);
-    });
-});
-Then('the last polled message should match the last sent message', function () {
-    const lastSent = this.sendMessages[this.sendMessages.length - 1];
-    const lastPoll = this.polledMessages[this.polledMessages.length - 1];
-    assert.deepEqual(lastSent.payload.toString(), lastPoll.payload.toString());
-    assert.deepEqual(lastSent.headers || {}, lastPoll.userHeaders);
-});
-//# sourceMappingURL=message.js.map

package/dist/src/bdd/stream.d.ts

@@ -1,20 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-export {};
-//# sourceMappingURL=stream.d.ts.map

package/dist/src/bdd/stream.js

@@ -1,39 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-import assert from 'node:assert/strict';
-import { Given, When, Then } from "@cucumber/cucumber";
-Given('I have no streams in the system', async function () {
-    assert.deepEqual([], await this.client.stream.list());
-});
-When('I create a stream with ID {int} and name {string}', async function (streamId, name) {
-    this.stream = await this.client.stream.create({ streamId, name });
-    return this.stream;
-});
-Then('the stream should be created successfully', function () {
-    assert.ok(this.stream);
-});
-Then('the stream should have ID {int} and name {string}', async function (streamId, name) {
-    assert.equal(this.stream.id, streamId);
-    assert.equal(this.stream.name, name);
-});
-// Cleanup: delete stream after test
-Then('I can delete stream with ID {int}', async function (streamId) {
-    assert.ok(await this.client.stream.delete({ streamId }));
-});
-//# sourceMappingURL=stream.js.map

package/dist/src/bdd/topic.d.ts

@@ -1,20 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-export {};
-//# sourceMappingURL=topic.d.ts.map

package/dist/src/bdd/topic.js

@@ -1,36 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-import assert from 'node:assert/strict';
-import { When, Then } from "@cucumber/cucumber";
-When('I create a topic with ID {int} and name {string} in stream {int} with {int} partitions', async function (topicId, name, streamId, partitionCount) {
-    this.topic = await this.client.topic.create({
-        topicId, name, streamId, partitionCount, compressionAlgorithm: 1
-    });
-});
-Then('the topic should be created successfully', function () {
-    assert.ok(this.topic);
-});
-Then('the topic should have ID {int} and name {string}', function (topicId, name) {
-    assert.equal(this.topic.id, topicId);
-    assert.equal(this.topic.name, name);
-});
-Then('the topic should have {int} partitions', function (partitionCount) {
-    assert.equal(this.topic.partitionsCount, partitionCount);
-});
-//# sourceMappingURL=topic.js.map

package/dist/src/bdd/world.d.ts

@@ -1,30 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-import type { Stream } from '../wire/stream/stream.utils.js';
-import type { Topic } from '../wire/topic/topic.utils.js';
-import type { CreateMessage, Message } from 'src/wire/index.js';
-import type { Client } from '../client/index.js';
-export interface TestWorld {
-    client: Client;
-    stream: Stream;
-    topic: Topic;
-    sendMessages: CreateMessage[];
-    polledMessages: Message[];
-}
-//# sourceMappingURL=world.d.ts.map

package/dist/src/bdd/world.js

@@ -1,21 +0,0 @@
-/**
- * Licensed to the Apache Software Foundation (ASF) under one
- * or more contributor license agreements.  See the NOTICE file
- * distributed with this work for additional information
- * regarding copyright ownership.  The ASF licenses this file
- * to you under the Apache License, Version 2.0 (the
- * "License"); you may not use this file except in compliance
- * with the License.  You may obtain a copy of the License at
- *
- *   http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing,
- * software distributed under the License is distributed on an
- * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- * KIND, either express or implied.  See the License for the
- * specific language governing permissions and limitations
- * under the License.
- */
-;
-export {};
-//# sourceMappingURL=world.js.map