@twin.org/entity-storage-connector-scylladb 0.0.1-next.8 → 0.0.1

package/dist/cjs/index.cjs

@@ -81,9 +81,10 @@ class AbstractScyllaDBConnector {
      * Get an entity.
      * @param id The id of the entity to get.
      * @param secondaryIndex Get the item using a secondary index.
+     * @param conditions The optional conditions to match for the entities.
      * @returns The object if it can be found or undefined.
      */
-    async get(id, secondaryIndex) {
+    async get(id, secondaryIndex, conditions) {
         core.Guards.stringValue(this.CLASS_NAME, "id", id);
         let connection;
         try {
@@ -443,9 +444,6 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
     /**
      * Create a new instance of ScyllaDBTableConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to "logging".
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         super(options, "ScyllaDBTableConnector");
@@ -566,22 +564,36 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
     /**
      * Set an entity.
      * @param entity The entity to set.
+     * @param conditions The optional conditions to match for the entities.
      */
-    async set(entity) {
-        core.Guards.object(this.CLASS_NAME, "entity", entity);
+    async set(entity$1, conditions) {
+        core.Guards.object(this.CLASS_NAME, "entity", entity$1);
+        entity.EntitySchemaHelper.validateEntity(entity$1, this.getSchema());
         let connection;
-        const id = entity[this._primaryKey?.property];
+        const id = entity$1[this._primaryKey?.property];
         try {
-            const propNames = this._entitySchema.properties?.map(f => `"${String(f.property)}"`) ?? [];
             const propValues = [];
-            const preparedValues = [];
-            const entityAsKeyValues = entity;
+            const updateValues = [];
+            conditions ??= [];
             for (const propDesc of this._entitySchema.properties ?? []) {
-                const value = entityAsKeyValues[propDesc.property];
-                propValues.push(this.propertyToDbValue(value, propDesc));
-                preparedValues.push("?");
+                if (!propDesc.isPrimary && !propDesc.isSecondary) {
+                    propValues.push(this.propertyToDbValue(entity$1[propDesc.property], propDesc));
+                    updateValues.push(`"${String(propDesc.property)}"=?`);
+                }
+                else {
+                    conditions.unshift({
+                        property: propDesc.property,
+                        value: this.propertyToDbValue(entity$1[propDesc.property], propDesc)
+                    });
+                }
+            }
+            const { sqlCondition, conditionValues } = this.buildConditions(conditions);
+            let conditionString = "";
+            if (sqlCondition.length > 0) {
+                conditionString = ` WHERE ${sqlCondition}`;
+                propValues.push(...conditionValues);
             }
-            const sql = `INSERT INTO "${this._fullTableName}" (${propNames.join(",")}) VALUES (${preparedValues.join(",")})`;
+            const sql = `UPDATE "${this._fullTableName}" SET ${updateValues.join(",")}${conditionString}`;
             await this._logging?.log({
                 level: "info",
                 source: this.CLASS_NAME,
@@ -602,15 +614,18 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
         }
     }
     /**
-     * Delete the entity.
+     * Remove the entity.
      * @param id The id of the entity to remove.
+     * @param conditions The optional conditions to match for the entities.
      */
-    async remove(id) {
+    async remove(id, conditions) {
         core.Guards.stringValue(this.CLASS_NAME, "id", id);
         let connection;
-        const primaryFieldValue = this.propertyToDbValue(id, this._primaryKey);
         try {
-            const sql = `DELETE FROM "${this._fullTableName}" WHERE "${String(this._primaryKey?.property)}"=?`;
+            conditions ??= [];
+            conditions.unshift({ property: this._primaryKey?.property, value: id });
+            const { sqlCondition, conditionValues } = this.buildConditions(conditions);
+            const sql = `DELETE FROM "${this._fullTableName}" WHERE ${sqlCondition}`;
             await this._logging?.log({
                 level: "info",
                 source: this.CLASS_NAME,
@@ -619,7 +634,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
                 data: { sql }
             });
             connection = await this.openConnection();
-            await this.execute(connection, sql, [primaryFieldValue]);
+            await this.execute(connection, sql, conditionValues);
         }
         catch (error) {
             throw new core.GeneralError(this.CLASS_NAME, "removeFailed", {
@@ -748,6 +763,23 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
         }
         return dbType;
     }
+    /**
+     * Build the conditions for the query.
+     * @param conditions The optional conditions to match for the entities.
+     * @returns The SQL conditions and the values.
+     */
+    buildConditions(conditions) {
+        const conditionValues = [];
+        const sqlConditions = [];
+        if (core.Is.arrayValue(conditions)) {
+            for (const condition of conditions) {
+                sqlConditions.push(`"${condition.property}"=?`);
+                const schemaProperty = this._entitySchema.properties?.find(s => s.property === condition.property);
+                conditionValues.push(this.propertyToDbValue(condition.value, schemaProperty));
+            }
+        }
+        return { sqlCondition: sqlConditions.join(" AND "), conditionValues };
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -773,10 +805,6 @@ class ScyllaDBViewConnector extends AbstractScyllaDBConnector {
     /**
      * Create a new instance of ScyllaDBViewConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to "logging".
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.viewSchema The name of the view schema.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         // We need this conversion so that types can match in the superclass and reuse the get method

package/dist/esm/index.mjs

@@ -79,9 +79,10 @@ class AbstractScyllaDBConnector {
      * Get an entity.
      * @param id The id of the entity to get.
      * @param secondaryIndex Get the item using a secondary index.
+     * @param conditions The optional conditions to match for the entities.
      * @returns The object if it can be found or undefined.
      */
-    async get(id, secondaryIndex) {
+    async get(id, secondaryIndex, conditions) {
         Guards.stringValue(this.CLASS_NAME, "id", id);
         let connection;
         try {
@@ -441,9 +442,6 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
     /**
      * Create a new instance of ScyllaDBTableConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to "logging".
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         super(options, "ScyllaDBTableConnector");
@@ -564,22 +562,36 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
     /**
      * Set an entity.
      * @param entity The entity to set.
+     * @param conditions The optional conditions to match for the entities.
      */
-    async set(entity) {
+    async set(entity, conditions) {
         Guards.object(this.CLASS_NAME, "entity", entity);
+        EntitySchemaHelper.validateEntity(entity, this.getSchema());
         let connection;
         const id = entity[this._primaryKey?.property];
         try {
-            const propNames = this._entitySchema.properties?.map(f => `"${String(f.property)}"`) ?? [];
             const propValues = [];
-            const preparedValues = [];
-            const entityAsKeyValues = entity;
+            const updateValues = [];
+            conditions ??= [];
             for (const propDesc of this._entitySchema.properties ?? []) {
-                const value = entityAsKeyValues[propDesc.property];
-                propValues.push(this.propertyToDbValue(value, propDesc));
-                preparedValues.push("?");
+                if (!propDesc.isPrimary && !propDesc.isSecondary) {
+                    propValues.push(this.propertyToDbValue(entity[propDesc.property], propDesc));
+                    updateValues.push(`"${String(propDesc.property)}"=?`);
+                }
+                else {
+                    conditions.unshift({
+                        property: propDesc.property,
+                        value: this.propertyToDbValue(entity[propDesc.property], propDesc)
+                    });
+                }
+            }
+            const { sqlCondition, conditionValues } = this.buildConditions(conditions);
+            let conditionString = "";
+            if (sqlCondition.length > 0) {
+                conditionString = ` WHERE ${sqlCondition}`;
+                propValues.push(...conditionValues);
             }
-            const sql = `INSERT INTO "${this._fullTableName}" (${propNames.join(",")}) VALUES (${preparedValues.join(",")})`;
+            const sql = `UPDATE "${this._fullTableName}" SET ${updateValues.join(",")}${conditionString}`;
             await this._logging?.log({
                 level: "info",
                 source: this.CLASS_NAME,
@@ -600,15 +612,18 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
         }
     }
     /**
-     * Delete the entity.
+     * Remove the entity.
      * @param id The id of the entity to remove.
+     * @param conditions The optional conditions to match for the entities.
      */
-    async remove(id) {
+    async remove(id, conditions) {
         Guards.stringValue(this.CLASS_NAME, "id", id);
         let connection;
-        const primaryFieldValue = this.propertyToDbValue(id, this._primaryKey);
         try {
-            const sql = `DELETE FROM "${this._fullTableName}" WHERE "${String(this._primaryKey?.property)}"=?`;
+            conditions ??= [];
+            conditions.unshift({ property: this._primaryKey?.property, value: id });
+            const { sqlCondition, conditionValues } = this.buildConditions(conditions);
+            const sql = `DELETE FROM "${this._fullTableName}" WHERE ${sqlCondition}`;
             await this._logging?.log({
                 level: "info",
                 source: this.CLASS_NAME,
@@ -617,7 +632,7 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
                 data: { sql }
             });
             connection = await this.openConnection();
-            await this.execute(connection, sql, [primaryFieldValue]);
+            await this.execute(connection, sql, conditionValues);
         }
         catch (error) {
             throw new GeneralError(this.CLASS_NAME, "removeFailed", {
@@ -746,6 +761,23 @@ class ScyllaDBTableConnector extends AbstractScyllaDBConnector {
         }
         return dbType;
     }
+    /**
+     * Build the conditions for the query.
+     * @param conditions The optional conditions to match for the entities.
+     * @returns The SQL conditions and the values.
+     */
+    buildConditions(conditions) {
+        const conditionValues = [];
+        const sqlConditions = [];
+        if (Is.arrayValue(conditions)) {
+            for (const condition of conditions) {
+                sqlConditions.push(`"${condition.property}"=?`);
+                const schemaProperty = this._entitySchema.properties?.find(s => s.property === condition.property);
+                conditionValues.push(this.propertyToDbValue(condition.value, schemaProperty));
+            }
+        }
+        return { sqlCondition: sqlConditions.join(" AND "), conditionValues };
+    }
 }
 
 // Copyright 2024 IOTA Stiftung.
@@ -771,10 +803,6 @@ class ScyllaDBViewConnector extends AbstractScyllaDBConnector {
     /**
      * Create a new instance of ScyllaDBViewConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to "logging".
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.viewSchema The name of the view schema.
-     * @param options.config The configuration for the connector.
      */
     constructor(options) {
         // We need this conversion so that types can match in the superclass and reuse the get method

package/dist/types/abstractScyllaDBConnector.d.ts

@@ -26,9 +26,13 @@ export declare abstract class AbstractScyllaDBConnector<T> {
      * Get an entity.
      * @param id The id of the entity to get.
      * @param secondaryIndex Get the item using a secondary index.
+     * @param conditions The optional conditions to match for the entities.
      * @returns The object if it can be found or undefined.
      */
-    get(id: string, secondaryIndex?: keyof T): Promise<T | undefined>;
+    get(id: string, secondaryIndex?: keyof T, conditions?: {
+        property: keyof T;
+        value: unknown;
+    }[]): Promise<T | undefined>;
     /**
      * Find all the entities which match the conditions.
      * @param conditions The conditions to match for the entities.

package/dist/types/index.d.ts

@@ -1,4 +1,7 @@
-export * from "./scyllaDBTableConnector";
-export * from "./scyllaDBViewConnector";
+export * from "./models/IScyllaDBConfig";
 export * from "./models/IScyllaDBTableConfig";
+export * from "./models/IScyllaDBTableConnectorConstructorOptions";
 export * from "./models/IScyllaDBViewConfig";
+export * from "./models/IScyllaDBViewConnectorConstructorOptions";
+export * from "./scyllaDBTableConnector";
+export * from "./scyllaDBViewConnector";

package/dist/types/models/IScyllaDBTableConnectorConstructorOptions.d.ts

@@ -0,0 +1,18 @@
+import type { IScyllaDBTableConfig } from "./IScyllaDBTableConfig";
+/**
+ * Options for the ScyllaDB Table Connector constructor.
+ */
+export interface IScyllaDBTableConnectorConstructorOptions {
+    /**
+     * The type of logging connector to use, defaults to no logging.
+     */
+    loggingConnectorType?: string;
+    /**
+     * The name of the entity schema.
+     */
+    entitySchema: string;
+    /**
+     * The configuration for the connector.
+     */
+    config: IScyllaDBTableConfig;
+}

package/dist/types/models/IScyllaDBViewConnectorConstructorOptions.d.ts

@@ -0,0 +1,22 @@
+import type { IScyllaDBViewConfig } from "./IScyllaDBViewConfig";
+/**
+ * Options for the ScyllaDB View Connector constructor.
+ */
+export interface IScyllaDBViewConnectorConstructorOptions {
+    /**
+     * The type of logging connector to use, defaults to no logging.
+     */
+    loggingConnectorType?: string;
+    /**
+     * The name of the entity schema.
+     */
+    entitySchema: string;
+    /**
+     * The name of the view schema.
+     */
+    viewSchema: string;
+    /**
+     * The configuration for the connector.
+     */
+    config: IScyllaDBViewConfig;
+}

package/dist/types/scyllaDBTableConnector.d.ts

@@ -1,6 +1,6 @@
 import type { IEntityStorageConnector } from "@twin.org/entity-storage-models";
 import { AbstractScyllaDBConnector } from "./abstractScyllaDBConnector";
-import type { IScyllaDBTableConfig } from "./models/IScyllaDBTableConfig";
+import type { IScyllaDBTableConnectorConstructorOptions } from "./models/IScyllaDBTableConnectorConstructorOptions";
 /**
  * Store entities using ScyllaDB.
  */
@@ -12,15 +12,8 @@ export declare class ScyllaDBTableConnector<T = unknown> extends AbstractScyllaD
     /**
      * Create a new instance of ScyllaDBTableConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to "logging".
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.config The configuration for the connector.
      */
-    constructor(options: {
-        loggingConnectorType?: string;
-        entitySchema: string;
-        config: IScyllaDBTableConfig;
-    });
+    constructor(options: IScyllaDBTableConnectorConstructorOptions);
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".
@@ -30,13 +23,21 @@ export declare class ScyllaDBTableConnector<T = unknown> extends AbstractScyllaD
     /**
      * Set an entity.
      * @param entity The entity to set.
+     * @param conditions The optional conditions to match for the entities.
      */
-    set(entity: T): Promise<void>;
+    set(entity: T, conditions?: {
+        property: keyof T;
+        value: unknown;
+    }[]): Promise<void>;
     /**
-     * Delete the entity.
+     * Remove the entity.
      * @param id The id of the entity to remove.
+     * @param conditions The optional conditions to match for the entities.
      */
-    remove(id: string): Promise<void>;
+    remove(id: string, conditions?: {
+        property: keyof T;
+        value: unknown;
+    }[]): Promise<void>;
     /**
      * Drops table.
      */
@@ -45,4 +46,10 @@ export declare class ScyllaDBTableConnector<T = unknown> extends AbstractScyllaD
      * Truncates (clear) table.
      */
     truncateTable(): Promise<void>;
+    /**
+     * Build the conditions for the query.
+     * @param conditions The optional conditions to match for the entities.
+     * @returns The SQL conditions and the values.
+     */
+    private buildConditions;
 }

package/dist/types/scyllaDBViewConnector.d.ts

@@ -1,6 +1,6 @@
 import type { IEntityStorageConnector } from "@twin.org/entity-storage-models";
 import { AbstractScyllaDBConnector } from "./abstractScyllaDBConnector";
-import type { IScyllaDBViewConfig } from "./models/IScyllaDBViewConfig";
+import type { IScyllaDBViewConnectorConstructorOptions } from "./models/IScyllaDBViewConnectorConstructorOptions";
 /**
  * Manage entities using ScyllaDB Views.
  */
@@ -12,17 +12,8 @@ export declare class ScyllaDBViewConnector<T> extends AbstractScyllaDBConnector<
     /**
      * Create a new instance of ScyllaDBViewConnector.
      * @param options The options for the connector.
-     * @param options.loggingConnectorType The type of logging connector to use, defaults to "logging".
-     * @param options.entitySchema The name of the entity schema.
-     * @param options.viewSchema The name of the view schema.
-     * @param options.config The configuration for the connector.
      */
-    constructor(options: {
-        loggingConnectorType?: string;
-        entitySchema: string;
-        viewSchema: string;
-        config: IScyllaDBViewConfig;
-    });
+    constructor(options: IScyllaDBViewConnectorConstructorOptions);
     /**
      * Bootstrap the component by creating and initializing any resources it needs.
      * @param nodeLoggingConnectorType The node logging connector type, defaults to "node-logging".

package/docs/changelog.md

@@ -1,5 +1,109 @@
 # @twin.org/entity-storage-connector-scylladb - Changelog
 
-## v0.0.1-next.8
+## 0.0.1 (2025-07-04)
+
+
+### Features
+
+* add production release automation ([1eb4c8e](https://github.com/twinfoundation/entity-storage/commit/1eb4c8ee3eb099defdfc2d063ae44935276dcae8))
+* release to production ([a309051](https://github.com/twinfoundation/entity-storage/commit/a3090519adebf7943232b4df12e4c6bd5afe7eed))
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+* use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
+
+
+### Bug Fixes
+
+* query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from ^0.0.0 to ^0.0.1
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.31](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-scylladb-v0.0.1-next.30...entity-storage-connector-scylladb-v0.0.1-next.31) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([dd6aa87](https://github.com/twinfoundation/entity-storage/commit/dd6aa87efdfb60bab7d6756a86888863c45c51a7))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.30 to 0.0.1-next.31
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.30 to 0.0.1-next.31
+
+## [0.0.1-next.30](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-scylladb-v0.0.1-next.29...entity-storage-connector-scylladb-v0.0.1-next.30) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([7ccc0c4](https://github.com/twinfoundation/entity-storage/commit/7ccc0c429125d073dc60b3de6cf101abc8cc6cba))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.29 to 0.0.1-next.30
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.29 to 0.0.1-next.30
+
+## [0.0.1-next.29](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-scylladb-v0.0.1-next.28...entity-storage-connector-scylladb-v0.0.1-next.29) (2025-04-17)
+
+
+### Features
+
+* use shared store mechanism ([#34](https://github.com/twinfoundation/entity-storage/issues/34)) ([68b6b71](https://github.com/twinfoundation/entity-storage/commit/68b6b71e7a96d7d016cd57bfff36775b56bf3f93))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.28 to 0.0.1-next.29
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.28 to 0.0.1-next.29
+
+## [0.0.1-next.28](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-scylladb-v0.0.1-next.27...entity-storage-connector-scylladb-v0.0.1-next.28) (2025-04-09)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-scylladb:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.27 to 0.0.1-next.28
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.27 to 0.0.1-next.28
+
+## [0.0.1-next.27](https://github.com/twinfoundation/entity-storage/compare/entity-storage-connector-scylladb-v0.0.1-next.26...entity-storage-connector-scylladb-v0.0.1-next.27) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **entity-storage-connector-scylladb:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/entity-storage-models bumped from 0.0.1-next.26 to 0.0.1-next.27
+  * devDependencies
+    * @twin.org/entity-storage-connector-memory bumped from 0.0.1-next.26 to 0.0.1-next.27
+
+## v0.0.1-next.26
 
 - Initial Release

package/docs/reference/classes/ScyllaDBTableConnector.md

@@ -8,7 +8,9 @@ Store entities using ScyllaDB.
 
 ## Type Parameters
 
-• **T** = `unknown`
+### T
+
+`T` = `unknown`
 
 ## Implements
 
@@ -16,33 +18,23 @@ Store entities using ScyllaDB.
 
 ## Constructors
 
-### new ScyllaDBTableConnector()
+### Constructor
 
-> **new ScyllaDBTableConnector**\<`T`\>(`options`): [`ScyllaDBTableConnector`](ScyllaDBTableConnector.md)\<`T`\>
+> **new ScyllaDBTableConnector**\<`T`\>(`options`): `ScyllaDBTableConnector`\<`T`\>
 
 Create a new instance of ScyllaDBTableConnector.
 
 #### Parameters
 
-• **options**
-
-The options for the connector.
-
-• **options.loggingConnectorType?**: `string`
-
-The type of logging connector to use, defaults to "logging".
+##### options
 
-• **options.entitySchema**: `string`
+[`IScyllaDBTableConnectorConstructorOptions`](../interfaces/IScyllaDBTableConnectorConstructorOptions.md)
 
-The name of the entity schema.
-
-• **options.config**: [`IScyllaDBTableConfig`](../interfaces/IScyllaDBTableConfig.md)
-
-The configuration for the connector.
+The options for the connector.
 
 #### Returns
 
-[`ScyllaDBTableConnector`](ScyllaDBTableConnector.md)\<`T`\>
+`ScyllaDBTableConnector`\<`T`\>
 
 #### Overrides
 
@@ -68,13 +60,13 @@ Runtime name for the class.
 
 ### getSchema()
 
-> **getSchema**(): `IEntitySchema`\<`unknown`\>
+> **getSchema**(): `IEntitySchema`
 
 Get the schema for the entities.
 
 #### Returns
 
-`IEntitySchema`\<`unknown`\>
+`IEntitySchema`
 
 The schema for the entities.
 
@@ -90,20 +82,30 @@ The schema for the entities.
 
 ### get()
 
-> **get**(`id`, `secondaryIndex`?): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`undefined` \| `T`\>
 
 Get an entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to get.
 
-• **secondaryIndex?**: keyof `T`
+##### secondaryIndex?
+
+keyof `T`
 
 Get the item using a secondary index.
 
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`undefined` \| `T`\>
@@ -122,51 +124,49 @@ The object if it can be found or undefined.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 Find all the entities which match the conditions.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<`T`\>
+##### conditions?
+
+`EntityCondition`\<`T`\>
 
 The conditions to match for the entities.
 
-• **sortProperties?**: `object`[]
+##### sortProperties?
+
+`object`[]
 
 The optional sort order.
 
-• **properties?**: keyof `T`[]
+##### properties?
+
+keyof `T`[]
 
 The optional properties to return, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
 
-##### entities
-
-> **entities**: `Partial`\<`T`\>[]
-
-The entities, which can be partial if a limited keys list was provided.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more entities.
-
 #### Implementation of
 
 `IEntityStorageConnector.query`
@@ -179,13 +179,15 @@ An optional cursor, when defined can be used to call find to get more entities.
 
 ### bootstrap()
 
-> **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
+> **bootstrap**(`nodeLoggingConnectorType?`): `Promise`\<`boolean`\>
 
 Bootstrap the component by creating and initializing any resources it needs.
 
 #### Parameters
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -203,16 +205,24 @@ True if the bootstrapping process was successful.
 
 ### set()
 
-> **set**(`entity`): `Promise`\<`void`\>
+> **set**(`entity`, `conditions?`): `Promise`\<`void`\>
 
 Set an entity.
 
 #### Parameters
 
-• **entity**: `T`
+##### entity
+
+`T`
 
 The entity to set.
 
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`void`\>
@@ -225,16 +235,24 @@ The entity to set.
 
 ### remove()
 
-> **remove**(`id`): `Promise`\<`void`\>
+> **remove**(`id`, `conditions?`): `Promise`\<`void`\>
 
-Delete the entity.
+Remove the entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to remove.
 
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/classes/ScyllaDBViewConnector.md

@@ -8,7 +8,9 @@ Manage entities using ScyllaDB Views.
 
 ## Type Parameters
 
-• **T**
+### T
+
+`T`
 
 ## Implements
 
@@ -16,37 +18,23 @@ Manage entities using ScyllaDB Views.
 
 ## Constructors
 
-### new ScyllaDBViewConnector()
+### Constructor
 
-> **new ScyllaDBViewConnector**\<`T`\>(`options`): [`ScyllaDBViewConnector`](ScyllaDBViewConnector.md)\<`T`\>
+> **new ScyllaDBViewConnector**\<`T`\>(`options`): `ScyllaDBViewConnector`\<`T`\>
 
 Create a new instance of ScyllaDBViewConnector.
 
 #### Parameters
 
-• **options**
-
-The options for the connector.
-
-• **options.loggingConnectorType?**: `string`
-
-The type of logging connector to use, defaults to "logging".
-
-• **options.entitySchema**: `string`
-
-The name of the entity schema.
-
-• **options.viewSchema**: `string`
+##### options
 
-The name of the view schema.
+[`IScyllaDBViewConnectorConstructorOptions`](../interfaces/IScyllaDBViewConnectorConstructorOptions.md)
 
-• **options.config**: [`IScyllaDBViewConfig`](../interfaces/IScyllaDBViewConfig.md)
-
-The configuration for the connector.
+The options for the connector.
 
 #### Returns
 
-[`ScyllaDBViewConnector`](ScyllaDBViewConnector.md)\<`T`\>
+`ScyllaDBViewConnector`\<`T`\>
 
 #### Overrides
 
@@ -72,13 +60,13 @@ Runtime name for the class.
 
 ### getSchema()
 
-> **getSchema**(): `IEntitySchema`\<`unknown`\>
+> **getSchema**(): `IEntitySchema`
 
 Get the schema for the entities.
 
 #### Returns
 
-`IEntitySchema`\<`unknown`\>
+`IEntitySchema`
 
 The schema for the entities.
 
@@ -94,20 +82,30 @@ The schema for the entities.
 
 ### get()
 
-> **get**(`id`, `secondaryIndex`?): `Promise`\<`undefined` \| `T`\>
+> **get**(`id`, `secondaryIndex?`, `conditions?`): `Promise`\<`undefined` \| `T`\>
 
 Get an entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to get.
 
-• **secondaryIndex?**: keyof `T`
+##### secondaryIndex?
+
+keyof `T`
 
 Get the item using a secondary index.
 
+##### conditions?
+
+`object`[]
+
+The optional conditions to match for the entities.
+
 #### Returns
 
 `Promise`\<`undefined` \| `T`\>
@@ -126,51 +124,49 @@ The object if it can be found or undefined.
 
 ### query()
 
-> **query**(`conditions`?, `sortProperties`?, `properties`?, `cursor`?, `pageSize`?): `Promise`\<`object`\>
+> **query**(`conditions?`, `sortProperties?`, `properties?`, `cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 Find all the entities which match the conditions.
 
 #### Parameters
 
-• **conditions?**: `EntityCondition`\<`T`\>
+##### conditions?
+
+`EntityCondition`\<`T`\>
 
 The conditions to match for the entities.
 
-• **sortProperties?**: `object`[]
+##### sortProperties?
+
+`object`[]
 
 The optional sort order.
 
-• **properties?**: keyof `T`[]
+##### properties?
+
+keyof `T`[]
 
 The optional properties to return, defaults to all.
 
-• **cursor?**: `string`
+##### cursor?
+
+`string`
 
 The cursor to request the next page of entities.
 
-• **pageSize?**: `number`
+##### pageSize?
+
+`number`
 
 The suggested number of entities to return in each chunk, in some scenarios can return a different amount.
 
 #### Returns
 
-`Promise`\<`object`\>
+`Promise`\<\{ `entities`: `Partial`\<`T`\>[]; `cursor?`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.
 
-##### entities
-
-> **entities**: `Partial`\<`T`\>[]
-
-The entities, which can be partial if a limited keys list was provided.
-
-##### cursor?
-
-> `optional` **cursor**: `string`
-
-An optional cursor, when defined can be used to call find to get more entities.
-
 #### Implementation of
 
 `IEntityStorageConnector.query`
@@ -183,13 +179,15 @@ An optional cursor, when defined can be used to call find to get more entities.
 
 ### bootstrap()
 
-> **bootstrap**(`nodeLoggingConnectorType`?): `Promise`\<`boolean`\>
+> **bootstrap**(`nodeLoggingConnectorType?`): `Promise`\<`boolean`\>
 
 Bootstrap the component by creating and initializing any resources it needs.
 
 #### Parameters
 
-• **nodeLoggingConnectorType?**: `string`
+##### nodeLoggingConnectorType?
+
+`string`
 
 The node logging connector type, defaults to "node-logging".
 
@@ -213,7 +211,9 @@ Set an entity.
 
 #### Parameters
 
-• **entity**: `T`
+##### entity
+
+`T`
 
 The entity to set.
 
@@ -235,7 +235,9 @@ Delete the entity.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the entity to remove.
 

package/docs/reference/index.md

@@ -7,5 +7,8 @@
 
 ## Interfaces
 
+- [IScyllaDBConfig](interfaces/IScyllaDBConfig.md)
 - [IScyllaDBTableConfig](interfaces/IScyllaDBTableConfig.md)
+- [IScyllaDBTableConnectorConstructorOptions](interfaces/IScyllaDBTableConnectorConstructorOptions.md)
 - [IScyllaDBViewConfig](interfaces/IScyllaDBViewConfig.md)
+- [IScyllaDBViewConnectorConstructorOptions](interfaces/IScyllaDBViewConnectorConstructorOptions.md)

package/docs/reference/interfaces/IScyllaDBConfig.md

@@ -0,0 +1,31 @@
+# Interface: IScyllaDBConfig
+
+ScyllaDB Configuration.
+
+## Extended by
+
+- [`IScyllaDBTableConfig`](IScyllaDBTableConfig.md)
+
+## Properties
+
+### hosts
+
+> **hosts**: `string`[]
+
+The host to contact to.
+
+***
+
+### localDataCenter
+
+> **localDataCenter**: `string`
+
+The local data center.
+
+***
+
+### keyspace
+
+> **keyspace**: `string`
+
+The keyspace to use.

package/docs/reference/interfaces/IScyllaDBTableConfig.md

@@ -4,7 +4,7 @@ Definition of MySQL DB configuration.
 
 ## Extends
 
-- `IScyllaDBConfig`
+- [`IScyllaDBConfig`](IScyllaDBConfig.md)
 
 ## Extended by
 
@@ -20,7 +20,7 @@ The host to contact to.
 
 #### Inherited from
 
-`IScyllaDBConfig.hosts`
+[`IScyllaDBConfig`](IScyllaDBConfig.md).[`hosts`](IScyllaDBConfig.md#hosts)
 
 ***
 
@@ -32,7 +32,7 @@ The local data center.
 
 #### Inherited from
 
-`IScyllaDBConfig.localDataCenter`
+[`IScyllaDBConfig`](IScyllaDBConfig.md).[`localDataCenter`](IScyllaDBConfig.md#localdatacenter)
 
 ***
 
@@ -44,7 +44,7 @@ The keyspace to use.
 
 #### Inherited from
 
-`IScyllaDBConfig.keyspace`
+[`IScyllaDBConfig`](IScyllaDBConfig.md).[`keyspace`](IScyllaDBConfig.md#keyspace)
 
 ***
 

package/docs/reference/interfaces/IScyllaDBTableConnectorConstructorOptions.md

@@ -0,0 +1,27 @@
+# Interface: IScyllaDBTableConnectorConstructorOptions
+
+Options for the ScyllaDB Table Connector constructor.
+
+## Properties
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type of logging connector to use, defaults to no logging.
+
+***
+
+### entitySchema
+
+> **entitySchema**: `string`
+
+The name of the entity schema.
+
+***
+
+### config
+
+> **config**: [`IScyllaDBTableConfig`](IScyllaDBTableConfig.md)
+
+The configuration for the connector.

package/docs/reference/interfaces/IScyllaDBViewConnectorConstructorOptions.md

@@ -0,0 +1,35 @@
+# Interface: IScyllaDBViewConnectorConstructorOptions
+
+Options for the ScyllaDB View Connector constructor.
+
+## Properties
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type of logging connector to use, defaults to no logging.
+
+***
+
+### entitySchema
+
+> **entitySchema**: `string`
+
+The name of the entity schema.
+
+***
+
+### viewSchema
+
+> **viewSchema**: `string`
+
+The name of the view schema.
+
+***
+
+### config
+
+> **config**: [`IScyllaDBViewConfig`](IScyllaDBViewConfig.md)
+
+The configuration for the connector.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/entity-storage-connector-scylladb",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1",
 	"description": "Entity Storage connector implementation using ScyllaDB",
 	"repository": {
 		"type": "git",
@@ -14,23 +14,23 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
-		"@twin.org/core": "next",
-		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "0.0.1-next.8",
-		"@twin.org/logging-models": "next",
-		"@twin.org/nameof": "next",
-		"cassandra-driver": "^4.7.2"
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/entity": "^0.0.1",
+		"@twin.org/entity-storage-models": "^0.0.1",
+		"@twin.org/logging-models": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"cassandra-driver": "4.8.0"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",