@axiom-lattice/pg-stores 1.0.1

package/.turbo/turbo-build.log

@@ -0,0 +1,20 @@
+
+> @axiom-lattice/pg-stores@1.0.1 build /home/runner/work/agentic/agentic/packages/pg-stores
+> tsup src/index.ts --format cjs,esm --dts --sourcemap
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.0
+CLI Target: es2020
+CJS Build start
+ESM Build start
+ESM dist/index.mjs     15.71 KB
+ESM dist/index.mjs.map 30.15 KB
+ESM ⚡️ Build success in 84ms
+CJS dist/index.js     16.98 KB
+CJS dist/index.js.map 30.95 KB
+CJS ⚡️ Build success in 86ms
+DTS Build start
+DTS ⚡️ Build success in 5031ms
+DTS dist/index.d.ts  5.38 KB
+DTS dist/index.d.mts 5.38 KB

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# @axiom-lattice/pg-stores
+
+## 1.0.1
+
+### Patch Changes
+
+- 7d8f3f5: enhance lattice
+- Updated dependencies [7d8f3f5]
+  - @axiom-lattice/protocols@2.1.6
+  - @axiom-lattice/core@2.1.12

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 Additional Liability. 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/MIGRATION_GUIDE.md

@@ -0,0 +1,310 @@
+# Migration System Usage Guide
+
+## Overview
+
+The migration system in `@axiom-lattice/pg-stores` provides automatic database schema management. It tracks applied migrations, applies pending migrations in order, and supports rollback operations.
+
+## How It Works
+
+### Automatic Migration (Default)
+
+By default, migrations run automatically when you create a store instance:
+
+```typescript
+import { PostgreSQLThreadStore } from "@axiom-lattice/pg-stores";
+
+// Migrations run automatically on initialization
+const threadStore = new PostgreSQLThreadStore({
+  poolConfig: process.env.DATABASE_URL,
+  autoMigrate: true, // Default: true
+});
+
+// This will automatically:
+// 1. Create lattice_schema_migrations table if it doesn't exist
+// 2. Check for pending migrations
+// 3. Apply any pending migrations in order
+await threadStore.initialize();
+```
+
+### Manual Migration Control
+
+If you want to control when migrations run:
+
+```typescript
+import { PostgreSQLThreadStore } from "@axiom-lattice/pg-stores";
+
+// Disable auto-migration
+const threadStore = new PostgreSQLThreadStore({
+  poolConfig: process.env.DATABASE_URL,
+  autoMigrate: false,
+});
+
+// Manually run migrations when ready
+await threadStore.initialize();
+```
+
+## Migration Structure
+
+Each migration is defined with:
+
+- **version**: Sequential version number (must be unique)
+- **name**: Descriptive migration name
+- **up**: Function to apply the migration (creates/modifies tables)
+- **down**: Optional function to rollback the migration
+
+Example migration:
+
+```typescript
+import { PoolClient } from "pg";
+import { Migration } from "./migration";
+
+export const createThreadsTable: Migration = {
+  version: 1,
+  name: "create_threads_table",
+  up: async (client: PoolClient) => {
+    await client.query(`
+      CREATE TABLE IF NOT EXISTS lattice_threads (
+        id VARCHAR(255) NOT NULL,
+        assistant_id VARCHAR(255) NOT NULL,
+        metadata JSONB DEFAULT '{}',
+        created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+        updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
+        PRIMARY KEY (id, assistant_id)
+      )
+    `);
+
+    await client.query(`
+      CREATE INDEX IF NOT EXISTS idx_lattice_threads_assistant_id 
+      ON lattice_threads(assistant_id)
+    `);
+  },
+  down: async (client: PoolClient) => {
+    await client.query("DROP INDEX IF EXISTS idx_lattice_threads_assistant_id");
+    await client.query("DROP TABLE IF EXISTS lattice_threads");
+  },
+};
+```
+
+## Using MigrationManager Directly
+
+You can also use `MigrationManager` directly for more control:
+
+```typescript
+import { Pool } from "pg";
+import { MigrationManager } from "@axiom-lattice/pg-stores";
+import { createThreadsTable } from "@axiom-lattice/pg-stores";
+
+const pool = new Pool({
+  connectionString: process.env.DATABASE_URL,
+});
+
+const migrationManager = new MigrationManager(pool);
+
+// Register migrations
+migrationManager.register(createThreadsTable);
+
+// Apply pending migrations
+await migrationManager.migrate();
+
+// Check current version
+const currentVersion = await migrationManager.getCurrentVersion();
+console.log(`Current migration version: ${currentVersion}`);
+
+// Rollback last migration (if down migration exists)
+await migrationManager.rollback();
+```
+
+## Migration Methods
+
+### `migrate()`
+
+Applies all pending migrations in order:
+
+```typescript
+await migrationManager.migrate();
+```
+
+**What it does:**
+
+1. Creates `lattice_schema_migrations` table if it doesn't exist
+2. Gets list of applied migrations from database
+3. Finds pending migrations (registered but not applied)
+4. Applies each pending migration in order (by version)
+5. Records each migration in `lattice_schema_migrations` table
+6. Uses transactions - if any migration fails, all are rolled back
+
+### `rollback()`
+
+Rolls back the last applied migration:
+
+```typescript
+await migrationManager.rollback();
+```
+
+**What it does:**
+
+1. Gets the last applied migration from database
+2. Finds the corresponding migration definition
+3. Runs the `down` function if it exists
+4. Removes the migration record from `lattice_schema_migrations`
+5. Uses transactions - if rollback fails, changes are reverted
+
+**Note:** Rollback only works if the migration has a `down` function defined.
+
+### `getCurrentVersion()`
+
+Gets the current migration version:
+
+```typescript
+const version = await migrationManager.getCurrentVersion();
+// Returns the highest version number of applied migrations
+// Returns 0 if no migrations have been applied
+```
+
+## Creating New Migrations
+
+To add a new migration:
+
+1. **Create a migration file** (e.g., `thread_migrations_v2.ts`):
+
+```typescript
+import { PoolClient } from "pg";
+import { Migration } from "./migration";
+
+export const addThreadStatusColumn: Migration = {
+  version: 2, // Must be higher than previous version
+  name: "add_thread_status_column",
+  up: async (client: PoolClient) => {
+    await client.query(`
+      ALTER TABLE lattice_threads 
+      ADD COLUMN IF NOT EXISTS status VARCHAR(50) DEFAULT 'active'
+    `);
+
+    await client.query(`
+      CREATE INDEX IF NOT EXISTS idx_lattice_threads_status 
+      ON lattice_threads(status)
+    `);
+  },
+  down: async (client: PoolClient) => {
+    await client.query("DROP INDEX IF EXISTS idx_lattice_threads_status");
+    await client.query(
+      "ALTER TABLE lattice_threads DROP COLUMN IF EXISTS status"
+    );
+  },
+};
+```
+
+2. **Register the migration** in your store:
+
+```typescript
+import {
+  createThreadsTable,
+  addThreadStatusColumn,
+} from "./migrations/thread_migrations";
+
+export class PostgreSQLThreadStore implements ThreadStore {
+  constructor(options: PostgreSQLThreadStoreOptions) {
+    // ... pool setup ...
+
+    this.migrationManager = new MigrationManager(this.pool);
+    this.migrationManager.register(createThreadsTable);
+    this.migrationManager.register(addThreadStatusColumn); // Register new migration
+
+    // ... rest of setup ...
+  }
+}
+```
+
+3. **Migrations will be applied automatically** on next initialization
+
+## Migration Tracking
+
+The system uses a `lattice_schema_migrations` table to track applied migrations:
+
+```sql
+CREATE TABLE lattice_schema_migrations (
+  version INTEGER PRIMARY KEY,
+  name VARCHAR(255) NOT NULL,
+  applied_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
+);
+```
+
+This ensures:
+
+- Migrations are only applied once
+- Migrations are applied in order (by version)
+- You can see which migrations have been applied and when
+
+## Best Practices
+
+1. **Always use transactions**: The migration system uses transactions automatically
+2. **Use IF NOT EXISTS**: Prevents errors if migration is run multiple times
+3. **Provide down migrations**: Enables rollback functionality
+4. **Version numbers**: Use sequential integers (1, 2, 3, ...)
+5. **Descriptive names**: Use clear, descriptive migration names
+6. **Test migrations**: Test both `up` and `down` migrations before deploying
+
+## Example: Complete Migration Workflow
+
+```typescript
+import { Pool } from "pg";
+import { MigrationManager } from "@axiom-lattice/pg-stores";
+import { createThreadsTable, addThreadStatusColumn } from "./migrations";
+
+const pool = new Pool({ connectionString: process.env.DATABASE_URL });
+
+// Create migration manager
+const migrationManager = new MigrationManager(pool);
+
+// Register all migrations
+migrationManager.register(createThreadsTable);
+migrationManager.register(addThreadStatusColumn);
+
+// Check current version
+const currentVersion = await migrationManager.getCurrentVersion();
+console.log(`Current version: ${currentVersion}`);
+
+// Apply pending migrations
+await migrationManager.migrate();
+// Output:
+// Applying migration 1: create_threads_table
+// Applying migration 2: add_thread_status_column
+// Applied 2 migration(s)
+
+// Check version again
+const newVersion = await migrationManager.getCurrentVersion();
+console.log(`New version: ${newVersion}`); // 2
+
+// If needed, rollback last migration
+await migrationManager.rollback();
+// Output:
+// Rolling back migration 2: add_thread_status_column
+// Rollback completed
+```
+
+## Troubleshooting
+
+### Migration Already Applied
+
+If a migration fails because it's already applied, check the `lattice_schema_migrations` table:
+
+```sql
+SELECT * FROM lattice_schema_migrations ORDER BY version;
+```
+
+### Migration Failed
+
+If a migration fails:
+
+1. The transaction is automatically rolled back
+2. No changes are applied
+3. Check the error message for details
+4. Fix the migration and try again
+
+### Version Conflicts
+
+If you have version conflicts:
+
+- Ensure each migration has a unique version number
+- Migrations are applied in order by version number
+- Don't reuse version numbers