orm-dynamodb 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,176 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Support. While redistributing the Work or
+   Derivative Works thereof, You may choose to offer, and charge a fee
+   for, acceptance of support, warranty, indemnity, or other liability
+   obligations and/or rights consistent with this License. However, in
+   accepting such obligations, You may act only on Your own behalf and
+   on Your sole responsibility, not on behalf of any other Contributor,
+   and only if You agree to indemnify, defend, and hold each Contributor
+   harmless for any liability incurred by, or claims asserted against,
+   such Contributor by reason of your accepting any such warranty or
+   additional liability.
+
+END OF TERMS AND CONDITIONS

package/README.md

@@ -1,16 +1,31 @@
 # orm-dynamodb
 
+[![npm version](https://img.shields.io/npm/v/orm-dynamodb.svg)](https://www.npmjs.com/package/orm-dynamodb)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
 Lightweight TypeScript decorators for modeling DynamoDB items as classes.
 
-## Install
+## ✨ Features
+
+- 🎯 **Type-safe decorators** for DynamoDB entities with full TypeScript support
+- 🔗 **Entity relationships** with `@LinkObject` and `@LinkArray` decorators and automatic link loading
+- 🔄 **Custom serialization** with `@ToDbModel` and `@FromDbModel` transformers
+- ⏰ **Automatic timestamps** for `createdAt` and `updatedAt`
+- 🛠️ **Intuitive API** with `insert()`, `update()`, `delete()`, `get()`, and `query()` methods
+- 🚀 **Zero configuration** - works out of the box with AWS SDK v3
+- 📦 **Tiny footprint** - lightweight with minimal dependencies
+
+## 📦 Install
 
 ```bash
 npm install orm-dynamodb
 ```
 
-The package depends on `@aws-sdk/client-dynamodb` and `@aws-sdk/lib-dynamodb`.
+**Dependencies:** `@aws-sdk/client-dynamodb` and `@aws-sdk/lib-dynamodb`
 
-Your TypeScript config must enable decorators:
+### TypeScript Configuration
+
+Enable decorators in your `tsconfig.json`:
 
 ```json
 {
@@ -21,7 +36,7 @@ Your TypeScript config must enable decorators:
 }
 ```
 
-## Quick Start
+## 🚀 Quick Start
 
 ```ts
 import { DynamoDBClient } from '@aws-sdk/client-dynamodb';
@@ -30,7 +45,7 @@ import {
   Entity,
   FromDbModel,
   HashKeyValue,
-  Link,
+  LinkObject,
   SortKeyValue,
   ToDbModel
 } from 'orm-dynamodb';
@@ -75,7 +90,7 @@ class Post extends BaseEntity {
   title: string;
   publishedAt: Date | null;
 
-  @Link(Author)
+  @LinkObject(Author)
   author: Author | undefined;
 
   constructor(slug: string = '', title: string = '', publishedAt: Date | null = null) {
@@ -104,7 +119,7 @@ async function run() {
   const post = new Post('decorators-with-dynamodb', 'Decorators With DynamoDB', new Date());
   post.author = new Author('ada-lovelace', 'Ada Lovelace');
 
-  await post.save();
+  await post.insert();
 
   const loaded = await Post.get('decorators-with-dynamodb');
   await loaded?.loadLinks();
@@ -113,28 +128,48 @@ async function run() {
 }
 ```
 
-## API
-
-The package exports:
-
-- `BaseEntity`
-- `Entity`
-- `HashKeyValue`
-- `SortKeyValue`
-- `Link`
-- `ToDbModel`
-- `FromDbModel`
-
-Core capabilities:
-
-- explicit DynamoDB client configuration via `BaseEntity.configure(...)` or `@Entity(..., dbClient)`
-- `save()`, `update()`, and `delete()` instance methods
-- `get()`, `query()`, and common query helpers on the entity class
-- linked entity references with `@Link(...)` and `loadLinks()`
-- custom read/write mapping with `@ToDbModel` and `@FromDbModel`
-- automatic `createdAt` and `updatedAt` timestamps
-
-## Local Development
+## 📚 API
+
+### Decorators & Classes
+
+- **`BaseEntity`** - Base class for all entities with CRUD operations
+- **`@Entity(tableName, hashKey, sortKey?, dbClient?)`** - Marks a class as a DynamoDB entity
+- **`@HashKeyValue`** - Defines the hash key value getter
+- **`@SortKeyValue`** - Defines the sort key value getter
+- **`@LinkObject(EntityClass, options?)`** - Creates a reference to a single entity (options: `{ inline?: boolean }`)
+- **`@LinkArray(EntityClass, options?)`** - Creates a reference to an array of entities (options: `{ inline?: boolean }`)
+- **`@ToDbModel`** - Custom serialization when writing to DynamoDB
+- **`@FromDbModel`** - Custom deserialization when reading from DynamoDB
+
+### Core Methods
+
+**Iinsert()` - Insert or update the entity (cascade saves linked entities)
+- `update(attributes)` - Partial update of the entity
+- `delete()` - Remove the entity from DynamoDB
+- `loadLinks()` - Load all linked entities
+
+**Static Methods:**
+- `get(sortKeyValue)` - Retrieve a single entity by sort key
+- `query(options)` - Query entities with custom options
+- `queryAll(limit?)` - Query all entities in the partition
+- `queryEquals(sortKeyValue, limit?)` - Query entities with exact sort key match
+- `queryStartsWith(prefix, limit?)` - Query entities with sort key prefix
+- `queryBetween(start, end, limit?)` - Query entities with sort key in range
+- `queryGreaterThan(value, limit?)` - Query entities with sort key greater than value
+- `queryLessThan(value, limit?)` - Query entities with sort key less than valuesort key
+- `query(options)` - Query entities in the partition
+- `configure(client)` - Set the DynamoDB client globally
+
+### Features
+
+- ✅ Explicit DynamoDB client configuration via `BaseEntity.configure(...)` or `@Entity(..., dbClient)`
+- ✅ Automatic `createdAt` and `updatedAt` timestamp management
+- ✅ Type-safe entity relationships with `@LinkObject` and `@LinkArray` decorators
+- ✅ Lazy loading of linked entities with `loadLinks()`
+- ✅ Custom transformation between domain models and DynamoDB items
+- ✅ Inline and non-inline link storage options
+
+## 🛠️ Development
 
 Install dependencies:
 
@@ -160,22 +195,21 @@ Check what will be published:
 npm run pack:check
 ```
 
-## Publish
+## 📝 License
 
-Make sure the package name in `package.json` is the one you want to publish and is available on npm, then:
+Apache-2.0
 
-```bash
-npm login
-npm publish
-```
+## ⚠️ Important Notes
+
+- Static lookups assume the hash key can be derived from a default-constructed instance
+- Query helpers operate within a single partition key value
+- Link loading issues individual `GetCommand` calls per linked record
+- This is a lightweight utility, not a schema or migration system
 
-If you rename the package, update the import path in this README to match.
+## 📖 Examples
 
-## Notes
+See [examples.ts](./examples.ts) for examples.
 
-- Static lookups assume the hash key can be derived from a default-constructed instance.
-- Query helpers all operate within a single partition key value.
-- Link loading currently issues individual `GetCommand` calls per linked record.
-- This is a lightweight utility, not a schema or migration system.
+## 🤝 Contributing
 
-See [examples.ts](./examples.ts) for a fuller usage example.
+Contributions are welcome! Please feel free to submit a Pull Request.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orm-dynamodb",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Lightweight TypeScript decorators for modeling DynamoDB items as classes",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -12,7 +12,8 @@
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ],
   "sideEffects": false,
   "scripts": {
@@ -32,7 +33,16 @@
     "orm",
     "typescript"
   ],
-  "license": "ISC",
+  "author": "",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "bugs": {
+    "url": ""
+  },
+  "homepage": "https://github.com/ssz360/DynamoDB-ORM",
   "dependencies": {
     "@aws-sdk/client-dynamodb": "^3.0.0",
     "@aws-sdk/lib-dynamodb": "^3.0.0",