supabase-typed-query 0.2.3 → 0.3.0

package/dist/index.js

@@ -664,13 +664,11 @@ const query = (client, table, where = {}, is, wherein, order) => {
 };
 function MultiMutationQuery(promise) {
   const result = Object.assign(promise, {
-    // Standard MultiExecution interface
     many: () => promise,
     manyOrThrow: async () => {
       const taskResult = await promise;
       return taskResult.orThrow();
     },
-    // Standard ExecutableQuery interface
     execute: () => promise,
     executeOrThrow: async () => {
       const taskResult = await promise;
@@ -681,13 +679,11 @@ function MultiMutationQuery(promise) {
 }
 function SingleMutationQuery(promise) {
   const result = Object.assign(promise, {
-    // Standard SingleExecution interface
     one: () => promise.then((outcome) => outcome.map((value) => functype.Option(value))),
     oneOrThrow: async () => {
       const taskResult = await promise;
       return taskResult.orThrow();
     },
-    // Standard ExecutableQuery interface
     execute: () => promise.then((outcome) => outcome.map((value) => functype.Option(value))),
     executeOrThrow: async () => {
       const taskResult = await promise;
@@ -697,50 +693,189 @@ function SingleMutationQuery(promise) {
   });
   return result;
 }
-const Entity = (client, name, config) => {
-  const softDeleteMode = config.softDelete ? "exclude" : "include";
-  function getItem({ id, where, is }) {
-    const whereWithPartition = config.partitionKey ? { ...config.partitionKey, ...where, id } : { ...where, id };
-    return createQuery(
+function getSoftDeleteMode(softDelete) {
+  return softDelete ? "exclude" : "include";
+}
+function buildWhereWithPartition(partitionField, partitionKey, where) {
+  const partitionCondition = { [partitionField]: partitionKey };
+  return { ...partitionCondition, ...where };
+}
+function buildWhereWithPartitionAndId(partitionField, partitionKey, id, where) {
+  const partitionCondition = { [partitionField]: partitionKey };
+  return { ...partitionCondition, ...where, id };
+}
+function createGetItemQuery(client, name, whereConditions, is, softDeleteMode) {
+  return createQuery(client, name, whereConditions, is, void 0, void 0, {
+    mode: softDeleteMode,
+    appliedByDefault: true
+  });
+}
+function createGetItemsQuery(client, name, whereConditions, is, wherein, order, softDeleteMode) {
+  return createQuery(client, name, whereConditions, is, wherein, order, {
+    mode: softDeleteMode,
+    appliedByDefault: true
+  });
+}
+function createAddItemsMutation(client, name, items) {
+  return MultiMutationQuery(addEntities(client, name, items));
+}
+function createUpdateItemMutation(client, name, item, whereConditions, is, wherein) {
+  return SingleMutationQuery(
+    updateEntity(client, name, item, whereConditions, is, wherein)
+  );
+}
+function createUpdateItemsMutation(client, name, items, identity, where, is, wherein) {
+  return MultiMutationQuery(
+    updateEntities(client, name, items, identity, where, is, wherein)
+  );
+}
+function makeGetItem(client, name, softDeleteMode) {
+  return function getItem({ id, where, is }) {
+    const whereConditions = { ...where, id };
+    return createGetItemQuery(client, name, whereConditions, is, softDeleteMode);
+  };
+}
+function makeGetItems(client, name, softDeleteMode) {
+  return function getItems({ where, is, wherein, order } = {}) {
+    return createGetItemsQuery(client, name, where, is, wherein, order, softDeleteMode);
+  };
+}
+function makePartitionedGetItem(client, name, partitionField, softDeleteMode) {
+  return function getItem(partitionKey, { id, where, is }) {
+    const whereConditions = buildWhereWithPartitionAndId(partitionField, partitionKey, id, where);
+    return createGetItemQuery(client, name, whereConditions, is, softDeleteMode);
+  };
+}
+function makePartitionedGetItems(client, name, partitionField, softDeleteMode) {
+  return function getItems(partitionKey, { where, is, wherein, order } = {}) {
+    const whereConditions = buildWhereWithPartition(partitionField, partitionKey, where);
+    return createGetItemsQuery(
       client,
       name,
-      whereWithPartition,
+      whereConditions,
       is,
-      void 0,
-      void 0,
-      { mode: softDeleteMode, appliedByDefault: true }
-    );
-  }
-  function getItems({ where, is, wherein, order } = {}) {
-    const whereWithPartition = config.partitionKey ? { ...config.partitionKey, ...where } : where;
-    return createQuery(client, name, whereWithPartition, is, wherein, order, {
-      mode: softDeleteMode,
-      appliedByDefault: true
-    });
-  }
-  function addItems({ items }) {
-    return MultiMutationQuery(addEntities(client, name, items));
-  }
-  function updateItem({ id, item, where, is, wherein }) {
-    return SingleMutationQuery(
-      updateEntity(client, name, item, { ...where, id }, is, wherein)
+      wherein,
+      order,
+      softDeleteMode
     );
-  }
-  function updateItems({
+  };
+}
+function makeUpdateItem(client, name) {
+  return function updateItem({ id, item, where, is, wherein }) {
+    const whereConditions = { ...where, id };
+    return createUpdateItemMutation(client, name, item, whereConditions, is, wherein);
+  };
+}
+function makePartitionedUpdateItem(client, name, partitionField) {
+  return function updateItem(partitionKey, { id, item, where, is, wherein }) {
+    const whereConditions = buildWhereWithPartitionAndId(partitionField, partitionKey, id, where);
+    return createUpdateItemMutation(client, name, item, whereConditions, is, wherein);
+  };
+}
+function makeUpdateItems(client, name) {
+  return function updateItems({
     items,
     identity = "id",
     where,
     is,
     wherein
   }) {
-    return MultiMutationQuery(updateEntities(client, name, items, identity, where, is, wherein));
-  }
+    return createUpdateItemsMutation(client, name, items, identity, where, is, wherein);
+  };
+}
+function makePartitionedUpdateItems(client, name, partitionField) {
+  return function updateItems(partitionKey, { items, identity = "id", where, is, wherein }) {
+    const whereConditions = buildWhereWithPartition(partitionField, partitionKey, where);
+    return createUpdateItemsMutation(
+      client,
+      name,
+      items,
+      identity,
+      whereConditions,
+      is,
+      wherein
+    );
+  };
+}
+function makeAddItems(client, name) {
+  return function addItems({ items }) {
+    return createAddItemsMutation(client, name, items);
+  };
+}
+const Entity = (client, name, config) => {
+  const softDeleteMode = getSoftDeleteMode(config.softDelete);
   return {
-    getItem,
-    getItems,
-    addItems,
-    updateItem,
-    updateItems
+    /**
+     * Retrieve a single item from the table by ID.
+     * @param params Query parameters including id, where conditions, and is conditions
+     * @returns A chainable query that can be executed with .one(), .many(), or .first()
+     */
+    getItem: makeGetItem(client, name, softDeleteMode),
+    /**
+     * Get a list of items from the table filtered by conditions.
+     * @param params Optional query parameters including where, is, wherein, and order
+     * @returns A chainable query that can be executed with .one(), .many(), or .first()
+     */
+    getItems: makeGetItems(client, name, softDeleteMode),
+    /**
+     * Adds multiple items to the table.
+     * @param params Parameters including items array
+     * @returns A mutation query with OrThrow methods
+     */
+    addItems: makeAddItems(client, name),
+    /**
+     * Update a single item in the table.
+     * @param params Update parameters including id, item data, and optional filters
+     * @returns A mutation query with OrThrow methods
+     */
+    updateItem: makeUpdateItem(client, name),
+    /**
+     * Update multiple items in the table.
+     * @param params Update parameters including items array, identity, and optional filters
+     * @returns A mutation query with OrThrow methods
+     */
+    updateItems: makeUpdateItems(client, name)
+  };
+};
+const PartitionedEntity = (client, name, config) => {
+  const softDeleteMode = getSoftDeleteMode(config.softDelete);
+  const { partitionField } = config;
+  return {
+    /**
+     * Retrieve a single item from the table by ID within a partition.
+     * @param partitionKey The partition key value (e.g., tenantId)
+     * @param params Query parameters including id, where conditions, and is conditions
+     * @returns A chainable query that can be executed with .one(), .many(), or .first()
+     */
+    getItem: makePartitionedGetItem(client, name, partitionField, softDeleteMode),
+    /**
+     * Get a list of items from the table within a partition.
+     * @param partitionKey The partition key value (e.g., tenantId)
+     * @param params Optional query parameters including where, is, wherein, and order
+     * @returns A chainable query that can be executed with .one(), .many(), or .first()
+     */
+    getItems: makePartitionedGetItems(client, name, partitionField, softDeleteMode),
+    /**
+     * Adds multiple items to the table.
+     * Note: Items should include the partition key value in their data.
+     * @param params Parameters including items array
+     * @returns A mutation query with OrThrow methods
+     */
+    addItems: makeAddItems(client, name),
+    /**
+     * Update a single item in the table within a partition.
+     * @param partitionKey The partition key value (e.g., tenantId)
+     * @param params Update parameters including id, item data, and optional filters
+     * @returns A mutation query with OrThrow methods
+     */
+    updateItem: makePartitionedUpdateItem(client, name, partitionField),
+    /**
+     * Update multiple items in the table within a partition.
+     * @param partitionKey The partition key value (e.g., tenantId)
+     * @param params Update parameters including items array, identity, and optional filters
+     * @returns A mutation query with OrThrow methods
+     */
+    updateItems: makePartitionedUpdateItems(client, name, partitionField)
   };
 };
 Object.defineProperty(exports, "Err", {
@@ -761,6 +896,7 @@ Object.defineProperty(exports, "Option", {
 });
 exports.Entity = Entity;
 exports.MultiMutationQuery = MultiMutationQuery;
+exports.PartitionedEntity = PartitionedEntity;
 exports.SingleMutationQuery = SingleMutationQuery;
 exports.SupabaseError = SupabaseError;
 exports.addEntities = addEntities;