Refactor attribute decorators in Entity class to use the correct character for partition and sort key annotations. Update documentation examples to reflect these changes, ensuring consistency across the library.

blazejkustra · blazejkustra · commit f37ae13f5586 · 2025-09-06T17:39:09.000+02:00
diff --git a/lib/decorators/index.ts b/lib/decorators/index.ts
@@ -25,19 +25,19 @@ import {
  * @example
  * ```typescript
  * class User extends Entity {
- *   @attribute.partitionKey.string()
+ *   ＠attribute.partitionKey.string()
  *   id: string;
  *
- *   @attribute.sortKey.number()
+ *   ＠attribute.sortKey.number()
  *   createdAt: number;
  *
- *   @attribute.string()
+ *   ＠attribute.string()
  *   name: string;
  *
- *   @attribute.gsi.partitionKey.string({ indexName: 'NameIndex' })
+ *   ＠attribute.gsi.partitionKey.string({ indexName: 'NameIndex' })
  *   nameIndex: string;
  *
- *   @attribute.lsi.sortKey.string({ indexName: 'StatusIndex' })
+ *   ＠attribute.lsi.sortKey.string({ indexName: 'StatusIndex' })
  *   status: string;
  * }
  * ```
@@ -124,7 +124,7 @@ const attribute = {
  * ```typescript
  * @entity.customName('CustomUser')
  * class User extends Entity {
- *   @attribute.partitionKey.string()
+ *   ＠attribute.partitionKey.string()
  *   id: string;
  * }
  * ```
diff --git a/lib/entity/entityManager.ts b/lib/entity/entityManager.ts
@@ -72,10 +72,10 @@ import { AttributeValues, ExpressionBuilder, fromDynamo, NotFoundError } from '@
  * @example
  * ```typescript
  * class User extends Entity {
- *   @attribute.partitionKey.string()
+ *   ＠attribute.partitionKey.string()
  *   id: string;
  *
- *   @attribute.string()
+ *   ＠attribute.string()
  *   name: string;
  * }
  *
diff --git a/lib/entity/index.ts b/lib/entity/index.ts
@@ -11,10 +11,10 @@ import { DYNAMODE_ENTITY } from '@lib/utils';
  * @example
  * ```typescript
  * class User extends Entity {
- *   @attribute.partitionKey.string()
+ *   ＠attribute.partitionKey.string()
  *   id: string;
  *
- *   @attribute.string()
+ *   ＠attribute.string()
  *   name: string;
  *
  *   constructor(props: { id: string; name: string }) {
@@ -55,7 +55,7 @@ export default class Entity {
    * @example
    * ```typescript
    * class Product extends Entity {
-   *   @attribute.partitionKey.string()
+   *   ＠attribute.partitionKey.string()
    *   id: string;
    *
    *   constructor(props: { id: string }) {
diff --git a/lib/index.ts b/lib/index.ts
@@ -17,10 +17,10 @@
  *
  * // Define an entity
  * class User extends Entity {
- *   @attribute.partitionKey.string()
+ *   ＠attribute.partitionKey.string()
  *   id: string;
  *
- *   @attribute.string()
+ *   ＠attribute.string()
  *   name: string;
  * }
  *
diff --git a/lib/module.ts b/lib/module.ts
@@ -30,10 +30,10 @@ declare global {
  * import { Entity, TableManager, attribute } from 'dynamode';
  *
  * class User extends Entity {
- *   @attribute.partitionKey.string()
+ *   ＠attribute.partitionKey.string()
  *   id: string;
  *
- *   @attribute.string()
+ *   ＠attribute.string()
  *   name: string;
  * }
  *
diff --git a/lib/table/index.ts b/lib/table/index.ts

Original file line number	Diff line number	Diff line change
`@@ -72,10 +72,10 @@ import { AttributeValues, ExpressionBuilder, fromDynamo, NotFoundError } from '@`
`72`	`72`	`* @example`
`73`	`73`	* ```typescript
`74`	`74`	`* class User extends Entity {`
`75`		`- * @attribute.partitionKey.string()`
	`75`	`+ * ＠attribute.partitionKey.string()`
`76`	`76`	`* id: string;`
`77`	`77`	`*`
`78`		`- * @attribute.string()`
	`78`	`+ * ＠attribute.string()`
`79`	`79`	`* name: string;`
`80`	`80`	`* }`
`81`	`81`	`*`
Original file line number	Diff line number	Diff line change
`@@ -17,10 +17,10 @@`
`17`	`17`	`*`
`18`	`18`	`* // Define an entity`
`19`	`19`	`* class User extends Entity {`
`20`		`- * @attribute.partitionKey.string()`
	`20`	`+ * ＠attribute.partitionKey.string()`
`21`	`21`	`* id: string;`
`22`	`22`	`*`
`23`		`- * @attribute.string()`
	`23`	`+ * ＠attribute.string()`
`24`	`24`	`* name: string;`
`25`	`25`	`* }`
`26`	`26`	`*`
Original file line number	Diff line number	Diff line change
`@@ -30,10 +30,10 @@ declare global {`
`30`	`30`	`* import { Entity, TableManager, attribute } from 'dynamode';`
`31`	`31`	`*`
`32`	`32`	`* class User extends Entity {`
`33`		`- * @attribute.partitionKey.string()`
	`33`	`+ * ＠attribute.partitionKey.string()`
`34`	`34`	`* id: string;`
`35`	`35`	`*`
`36`		`- * @attribute.string()`
	`36`	`+ * ＠attribute.string()`
`37`	`37`	`* name: string;`
`38`	`38`	`* }`
`39`	`39`	`*`