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

package/docs/reference/interfaces/IScyllaDBTableConfig.md

@@ -0,0 +1,61 @@
+# Interface: IScyllaDBTableConfig
+
+Definition of MySQL DB configuration.
+
+## Extends
+
+- `IScyllaDBConfig`
+
+## Extended by
+
+- [`IScyllaDBViewConfig`](IScyllaDBViewConfig.md)
+
+## Properties
+
+### hosts
+
+> **hosts**: `string`[]
+
+The host to contact to.
+
+#### Inherited from
+
+`IScyllaDBConfig.hosts`
+
+***
+
+### localDataCenter
+
+> **localDataCenter**: `string`
+
+The local data center.
+
+#### Inherited from
+
+`IScyllaDBConfig.localDataCenter`
+
+***
+
+### keyspace
+
+> **keyspace**: `string`
+
+The keyspace to use.
+
+#### Inherited from
+
+`IScyllaDBConfig.keyspace`
+
+***
+
+### tableName?
+
+> `optional` **tableName**: `string`
+
+The name of the table for the storage.
+
+#### Default
+
+```ts
+To the camel case of the entity name.
+```

package/docs/reference/interfaces/IScyllaDBViewConfig.md

@@ -0,0 +1,75 @@
+# Interface: IScyllaDBViewConfig
+
+Definition of MySQL DB configuration.
+
+## Extends
+
+- [`IScyllaDBTableConfig`](IScyllaDBTableConfig.md)
+
+## Properties
+
+### hosts
+
+> **hosts**: `string`[]
+
+The host to contact to.
+
+#### Inherited from
+
+[`IScyllaDBTableConfig`](IScyllaDBTableConfig.md).[`hosts`](IScyllaDBTableConfig.md#hosts)
+
+***
+
+### localDataCenter
+
+> **localDataCenter**: `string`
+
+The local data center.
+
+#### Inherited from
+
+[`IScyllaDBTableConfig`](IScyllaDBTableConfig.md).[`localDataCenter`](IScyllaDBTableConfig.md#localdatacenter)
+
+***
+
+### keyspace
+
+> **keyspace**: `string`
+
+The keyspace to use.
+
+#### Inherited from
+
+[`IScyllaDBTableConfig`](IScyllaDBTableConfig.md).[`keyspace`](IScyllaDBTableConfig.md#keyspace)
+
+***
+
+### tableName?
+
+> `optional` **tableName**: `string`
+
+The name of the table for the storage.
+
+#### Default
+
+```ts
+To the camel case of the entity name.
+```
+
+#### Inherited from
+
+[`IScyllaDBTableConfig`](IScyllaDBTableConfig.md).[`tableName`](IScyllaDBTableConfig.md#tablename)
+
+***
+
+### viewName?
+
+> `optional` **viewName**: `string`
+
+The name of view.
+
+#### Default
+
+```ts
+To the camel case of the entity name with View appended.
+```

package/locales/en.json

@@ -0,0 +1,28 @@
+{
+	"info": {
+		"scyllaDBTableConnector": {
+			"tableCreating": "Creating table \"{table}\"",
+			"tableCreated": "Created table \"{table}\"",
+			"tableExists": "Skipping create table \"{table}\" as it already exists",
+			"typeCreated": "Created type \"{typeName}\"",
+			"sql": "SQL: \"{sql}\""
+		},
+		"scyllaDBViewConnector": {
+			"viewCreating": "Creating view \"{view}\"",
+			"viewCreated": "Created view \"{view}\"",
+			"viewExists": "Skipping create view \"{view}\" as it already exists",
+			"typeCreated": "Created type \"{typeName}\"",
+			"sql": "SQL: \"{sql}\""
+		}
+	},
+	"error": {
+		"scyllaDBTableConnector": {
+			"tableCreateFailed": "Creating table \"{table}\" failed",
+			"getFailed": "Getting item with \"{id}\" failed",
+			"dropTableFailed": " \"{table}\" cannot be dropped",
+			"truncateTableFailed": " \"{table}\" cannot be dropped",
+			"removeFailed": "Removing item with \"{id}\" failed",
+			"findFailed": "Error while querying data on  \"{table}\""
+		}
+	}
+}

package/package.json

@@ -0,0 +1,73 @@
+{
+	"name": "@twin.org/entity-storage-connector-scylladb",
+	"version": "0.0.1-next.2",
+	"description": "Entity Storage connector implementation using ScyllaDB",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/entity-storage.git",
+		"directory": "packages/entity-storage-connector-scylladb"
+	},
+	"author": "jose.cantera@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"scripts": {
+		"clean": "rimraf dist coverage docs/reference",
+		"build": "tspc",
+		"test": "vitest --run --config ./vitest.config.ts --no-cache",
+		"coverage": "vitest --run --coverage --config ./vitest.config.ts --no-cache",
+		"bundle:esm": "rollup --config rollup.config.mjs --environment MODULE:esm",
+		"bundle:cjs": "rollup --config rollup.config.mjs --environment MODULE:cjs",
+		"bundle": "npm run bundle:esm && npm run bundle:cjs",
+		"docs:clean": "rimraf docs/reference",
+		"docs:generate": "typedoc",
+		"docs": "npm run docs:clean && npm run docs:generate",
+		"dist": "npm run clean && npm run build && npm run test && npm run bundle && npm run docs"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/entity-storage-models": "0.0.1-next.2",
+		"@twin.org/logging-models": "next",
+		"@twin.org/nameof": "next",
+		"cassandra-driver": "^4.7.2"
+	},
+	"devDependencies": {
+		"@twin.org/entity-storage-connector-memory": "0.0.1-next.2",
+		"@twin.org/logging-connector-entity-storage": "next",
+		"@twin.org/nameof-transformer": "next",
+		"@types/node": "22.5.5",
+		"@vitest/coverage-v8": "2.1.1",
+		"copyfiles": "2.4.1",
+		"dotenv": "16.4.5",
+		"rimraf": "6.0.1",
+		"rollup": "4.21.3",
+		"rollup-plugin-copy": "3.5.0",
+		"rollup-plugin-typescript2": "0.36.0",
+		"ts-patch": "3.2.1",
+		"typedoc": "0.26.7",
+		"typedoc-plugin-markdown": "4.2.7",
+		"typescript": "5.6.2",
+		"vitest": "2.1.1"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}