s3db.js 12.2.3 → 12.3.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "s3db.js",
-  "version": "12.2.3",
+  "version": "12.3.0",
   "description": "Use AWS S3, the world's most reliable document storage, as a database with this ORM.",
   "main": "dist/s3db.cjs.js",
   "module": "dist/s3db.es.js",

package/src/behaviors/body-only.js

@@ -59,10 +59,15 @@ export async function handleInsert({ resource, data, mappedData }) {
     '_v': mappedData._v || String(resource.version)
   };
   metadataOnly._map = JSON.stringify(resource.schema.map);
-  
+
+  // Store pluginMap for backwards compatibility when plugins are added/removed
+  if (resource.schema.pluginMap && Object.keys(resource.schema.pluginMap).length > 0) {
+    metadataOnly._pluginMap = JSON.stringify(resource.schema.pluginMap);
+  }
+
   // Use the original object for the body
   const body = JSON.stringify(mappedData);
-  
+
   return { mappedData: metadataOnly, body };
 }
 
@@ -70,16 +75,21 @@ export async function handleUpdate({ resource, id, data, mappedData }) {
   // For updates, we need to merge with existing data
   // Since we can't easily read the existing body during update,
   // we'll put the update data in the body and let the resource handle merging
-  
+
   // Keep only the version field in metadata
   const metadataOnly = {
     '_v': mappedData._v || String(resource.version)
   };
   metadataOnly._map = JSON.stringify(resource.schema.map);
-  
+
+  // Store pluginMap for backwards compatibility when plugins are added/removed
+  if (resource.schema.pluginMap && Object.keys(resource.schema.pluginMap).length > 0) {
+    metadataOnly._pluginMap = JSON.stringify(resource.schema.pluginMap);
+  }
+
   // Use the original object for the body
   const body = JSON.stringify(mappedData);
-  
+
   return { mappedData: metadataOnly, body };
 }
 

package/src/behaviors/body-overflow.js

@@ -90,6 +90,15 @@ export async function handleInsert({ resource, data, mappedData, originalData })
     currentSize += attributeSizes._v;
   }
 
+  // Always include plugin map for backwards compatibility when plugins are added/removed
+  // Note: _pluginMap is not in mappedData, it's added separately by behaviors
+  if (resource.schema?.pluginMap && Object.keys(resource.schema.pluginMap).length > 0) {
+    const pluginMapStr = JSON.stringify(resource.schema.pluginMap);
+    const pluginMapSize = calculateUTF8Bytes('_pluginMap') + calculateUTF8Bytes(pluginMapStr);
+    metadataFields._pluginMap = pluginMapStr;
+    currentSize += pluginMapSize;
+  }
+
   // Reserve space for $overflow if overflow is possible
   let reservedLimit = effectiveLimit;
   for (const [fieldName, size] of sortedFields) {

package/src/behaviors/user-managed.js

@@ -88,7 +88,14 @@ export async function handleInsert({ resource, data, mappedData, originalData })
       data: originalData || data
     });
     // If data exceeds limit, store in body
-    return { mappedData: { _v: mappedData._v }, body: JSON.stringify(mappedData) };
+    const metadataOnly = { _v: mappedData._v };
+
+    // Store pluginMap for backwards compatibility when plugins are added/removed
+    if (resource.schema?.pluginMap && Object.keys(resource.schema.pluginMap).length > 0) {
+      metadataOnly._pluginMap = JSON.stringify(resource.schema.pluginMap);
+    }
+
+    return { mappedData: metadataOnly, body: JSON.stringify(mappedData) };
   }
   
   // If data fits in metadata, store only in metadata

package/src/concerns/typescript-generator.js

@@ -190,10 +190,20 @@ export async function generateTypes(database, options = {}) {
   const resourceInterfaces = [];
 
   for (const [name, resource] of Object.entries(database.resources)) {
-    const attributes = resource.config?.attributes || resource.attributes || {};
+    const allAttributes = resource.config?.attributes || resource.attributes || {};
     const timestamps = resource.config?.timestamps || false;
 
-    const interfaceDef = generateResourceInterface(name, attributes, timestamps);
+    // Filter out plugin attributes - they are internal implementation details
+    // and should not be exposed in public TypeScript interfaces
+    const pluginAttrNames = resource.schema?._pluginAttributes
+      ? Object.values(resource.schema._pluginAttributes).flat()
+      : [];
+
+    const userAttributes = Object.fromEntries(
+      Object.entries(allAttributes).filter(([name]) => !pluginAttrNames.includes(name))
+    );
+
+    const interfaceDef = generateResourceInterface(name, userAttributes, timestamps);
     lines.push(interfaceDef);
 
     resourceInterfaces.push({

package/src/plugins/api/utils/openapi-generator.js

@@ -98,7 +98,17 @@ function generateResourceSchema(resource) {
   const properties = {};
   const required = [];
 
-  const attributes = resource.config?.attributes || resource.attributes || {};
+  const allAttributes = resource.config?.attributes || resource.attributes || {};
+
+  // Filter out plugin attributes - they are internal implementation details
+  // and should not be exposed in public API documentation
+  const pluginAttrNames = resource.schema?._pluginAttributes
+    ? Object.values(resource.schema._pluginAttributes).flat()
+    : [];
+
+  const attributes = Object.fromEntries(
+    Object.entries(allAttributes).filter(([name]) => !pluginAttrNames.includes(name))
+  );
 
   // Extract resource description (supports both string and object format)
   const resourceDescription = resource.config?.description;
@@ -254,7 +264,16 @@ function generateResourcePaths(resource, version, config = {}) {
     }
 
     // Create query parameters only for partition fields
-    const attributes = resource.config?.attributes || resource.attributes || {};
+    const allAttributes = resource.config?.attributes || resource.attributes || {};
+
+    // Filter out plugin attributes
+    const pluginAttrNames = resource.schema?._pluginAttributes
+      ? Object.values(resource.schema._pluginAttributes).flat()
+      : [];
+
+    const attributes = Object.fromEntries(
+      Object.entries(allAttributes).filter(([name]) => !pluginAttrNames.includes(name))
+    );
 
     for (const fieldName of partitionFieldsSet) {
       const fieldDef = attributes[fieldName];

package/src/plugins/replicators/bigquery-replicator.class.js

@@ -186,7 +186,15 @@ class BigqueryReplicator extends BaseReplicator {
         continue;
       }
 
-      const attributes = resource.config.versions[resource.config.currentVersion]?.attributes || {};
+      const allAttributes = resource.config.versions[resource.config.currentVersion]?.attributes || {};
+
+      // Filter out plugin attributes - they are internal and should not be replicated
+      const pluginAttrNames = resource.schema?._pluginAttributes
+        ? Object.values(resource.schema._pluginAttributes).flat()
+        : [];
+      const attributes = Object.fromEntries(
+        Object.entries(allAttributes).filter(([name]) => !pluginAttrNames.includes(name))
+      );
 
       for (const tableConfig of tableConfigs) {
         const tableName = tableConfig.table;

package/src/plugins/replicators/mysql-replicator.class.js

@@ -221,7 +221,15 @@ class MySQLReplicator extends BaseReplicator {
         continue;
       }
 
-      const attributes = resource.config.versions[resource.config.currentVersion]?.attributes || {};
+      const allAttributes = resource.config.versions[resource.config.currentVersion]?.attributes || {};
+
+      // Filter out plugin attributes - they are internal and should not be replicated
+      const pluginAttrNames = resource.schema?._pluginAttributes
+        ? Object.values(resource.schema._pluginAttributes).flat()
+        : [];
+      const attributes = Object.fromEntries(
+        Object.entries(allAttributes).filter(([name]) => !pluginAttrNames.includes(name))
+      );
 
       for (const tableConfig of tableConfigs) {
         const tableName = tableConfig.table;

package/src/plugins/replicators/planetscale-replicator.class.js

@@ -183,7 +183,15 @@ class PlanetScaleReplicator extends BaseReplicator {
         continue;
       }
 
-      const attributes = resource.config.versions[resource.config.currentVersion]?.attributes || {};
+      const allAttributes = resource.config.versions[resource.config.currentVersion]?.attributes || {};
+
+      // Filter out plugin attributes - they are internal and should not be replicated
+      const pluginAttrNames = resource.schema?._pluginAttributes
+        ? Object.values(resource.schema._pluginAttributes).flat()
+        : [];
+      const attributes = Object.fromEntries(
+        Object.entries(allAttributes).filter(([name]) => !pluginAttrNames.includes(name))
+      );
 
       for (const tableConfig of tableConfigs) {
         const tableName = tableConfig.table;

package/src/plugins/replicators/postgres-replicator.class.js

@@ -225,7 +225,15 @@ class PostgresReplicator extends BaseReplicator {
       }
 
       // Get resource attributes from current version
-      const attributes = resource.config.versions[resource.config.currentVersion]?.attributes || {};
+      const allAttributes = resource.config.versions[resource.config.currentVersion]?.attributes || {};
+
+      // Filter out plugin attributes - they are internal and should not be replicated
+      const pluginAttrNames = resource.schema?._pluginAttributes
+        ? Object.values(resource.schema._pluginAttributes).flat()
+        : [];
+      const attributes = Object.fromEntries(
+        Object.entries(allAttributes).filter(([name]) => !pluginAttrNames.includes(name))
+      );
 
       // Sync each table configured for this resource
       for (const tableConfig of tableConfigs) {

package/src/plugins/replicators/schema-sync.helper.js

@@ -7,6 +7,25 @@
 
 import tryFn from "#src/concerns/try-fn.js";
 
+/**
+ * Filter out plugin attributes from attributes object
+ * Plugin attributes are internal implementation details and should not be replicated
+ * @param {Object} attributes - All attributes including plugin attributes
+ * @param {Object} resource - Resource instance with schema._pluginAttributes
+ * @returns {Object} Filtered attributes (user attributes only)
+ */
+function filterPluginAttributes(attributes, resource) {
+  if (!resource?.schema?._pluginAttributes) {
+    return attributes;
+  }
+
+  const pluginAttrNames = Object.values(resource.schema._pluginAttributes).flat();
+
+  return Object.fromEntries(
+    Object.entries(attributes).filter(([name]) => !pluginAttrNames.includes(name))
+  );
+}
+
 /**
  * Parse s3db field type notation (e.g., 'string|required|maxlength:50')
  */

package/src/plugins/replicators/turso-replicator.class.js

@@ -177,7 +177,15 @@ class TursoReplicator extends BaseReplicator {
         continue;
       }
 
-      const attributes = resource.config.versions[resource.config.currentVersion]?.attributes || {};
+      const allAttributes = resource.config.versions[resource.config.currentVersion]?.attributes || {};
+
+      // Filter out plugin attributes - they are internal and should not be replicated
+      const pluginAttrNames = resource.schema?._pluginAttributes
+        ? Object.values(resource.schema._pluginAttributes).flat()
+        : [];
+      const attributes = Object.fromEntries(
+        Object.entries(allAttributes).filter(([name]) => !pluginAttrNames.includes(name))
+      );
 
       for (const tableConfig of tableConfigs) {
         const tableName = tableConfig.table;