@jaypie/dynamodb 0.0.1

package/dist/esm/types.d.ts

@@ -0,0 +1,142 @@
+/**
+ * DynamoDB client configuration
+ */
+export interface DynamoClientConfig {
+    /** DynamoDB table name */
+    tableName: string;
+    /** Optional endpoint URL for local development (e.g., "http://127.0.0.1:8100") */
+    endpoint?: string;
+    /** AWS region (default: "us-east-1") */
+    region?: string;
+    /** Optional credentials for local development */
+    credentials?: {
+        accessKeyId: string;
+        secretAccessKey: string;
+    };
+}
+/**
+ * Parent reference for calculating OU
+ */
+export interface ParentReference {
+    id: string;
+    model: string;
+}
+/**
+ * Base query options shared by all query functions
+ */
+export interface BaseQueryOptions {
+    /** Query archived entities instead of active ones */
+    archived?: boolean;
+    /** Whether to sort ascending (oldest first). Default: false (most recent first) */
+    ascending?: boolean;
+    /** Query deleted entities instead of active ones */
+    deleted?: boolean;
+    /** Maximum number of items to return */
+    limit?: number;
+    /** Pagination cursor from previous query */
+    startKey?: Record<string, unknown>;
+}
+/**
+ * Parameters for queryByOu
+ */
+export interface QueryByOuParams extends BaseQueryOptions {
+    /** The entity model name */
+    model: string;
+    /** The organizational unit (APEX or "{parent.model}#{parent.id}") */
+    ou: string;
+}
+/**
+ * Parameters for queryByAlias
+ */
+export interface QueryByAliasParams {
+    /** The human-friendly alias */
+    alias: string;
+    /** Query archived entities instead of active ones */
+    archived?: boolean;
+    /** Query deleted entities instead of active ones */
+    deleted?: boolean;
+    /** The entity model name */
+    model: string;
+    /** The organizational unit */
+    ou: string;
+}
+/**
+ * Parameters for queryByClass
+ */
+export interface QueryByClassParams extends BaseQueryOptions {
+    /** The entity model name */
+    model: string;
+    /** The organizational unit */
+    ou: string;
+    /** The category classification */
+    recordClass: string;
+}
+/**
+ * Parameters for queryByType
+ */
+export interface QueryByTypeParams extends BaseQueryOptions {
+    /** The entity model name */
+    model: string;
+    /** The organizational unit */
+    ou: string;
+    /** The type classification */
+    type: string;
+}
+/**
+ * Parameters for queryByXid
+ */
+export interface QueryByXidParams {
+    /** Query archived entities instead of active ones */
+    archived?: boolean;
+    /** Query deleted entities instead of active ones */
+    deleted?: boolean;
+    /** The entity model name */
+    model: string;
+    /** The organizational unit */
+    ou: string;
+    /** The external ID */
+    xid: string;
+}
+/**
+ * Result of a query operation
+ */
+export interface QueryResult<T = FabricEntity> {
+    /** Array of matching entities */
+    items: T[];
+    /** Pagination cursor for next page (undefined if no more results) */
+    lastEvaluatedKey?: Record<string, unknown>;
+}
+/**
+ * Base entity interface for DynamoDB single-table design
+ */
+export interface FabricEntity {
+    /** Partition key (e.g., "record", "message") */
+    model: string;
+    /** Sort key (UUID) */
+    id: string;
+    /** Human-readable name */
+    name: string;
+    /** Organizational unit: APEX ("@") or "{parent.model}#{parent.id}" */
+    ou: string;
+    /** Timestamp for chronological ordering (Date.now()) */
+    sequence: number;
+    indexAlias?: string;
+    indexClass?: string;
+    indexOu?: string;
+    indexType?: string;
+    indexXid?: string;
+    /** Human-friendly slug/alias */
+    alias?: string;
+    /** Category classification */
+    class?: string;
+    /** Type classification */
+    type?: string;
+    /** External ID for integration with external systems */
+    xid?: string;
+    createdAt: string;
+    updatedAt: string;
+    /** Archive timestamp (for inactive but preserved records) */
+    archivedAt?: string;
+    /** Soft-delete timestamp */
+    deletedAt?: string;
+}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@jaypie/dynamodb",
+  "version": "0.0.1",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/finlaysonstudio/jaypie.git"
+  },
+  "license": "MIT",
+  "author": "Finlayson Studio",
+  "sideEffects": false,
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "require": "./dist/cjs/index.cjs",
+      "import": "./dist/esm/index.js",
+      "default": "./dist/esm/index.js"
+    }
+  },
+  "main": "./dist/cjs/index.cjs",
+  "module": "./dist/esm/index.js",
+  "types": "./dist/esm/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rollup --config",
+    "format": "npm run format:package && npm run format:lint",
+    "format:lint": "eslint --fix .",
+    "format:package": "sort-package-json ./package.json",
+    "lint": "eslint .",
+    "test": "vitest run .",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "@aws-sdk/client-dynamodb": "^3.726.1",
+    "@aws-sdk/lib-dynamodb": "^3.726.1"
+  },
+  "devDependencies": {
+    "@rollup/plugin-typescript": "^12.1.2",
+    "@types/node": "^22.13.1",
+    "typescript": "^5.3.3"
+  },
+  "peerDependencies": {
+    "@jaypie/errors": "^1.2.1",
+    "@jaypie/kit": "^1.2.1",
+    "@jaypie/logger": "^1.2.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}