@protobase/query 0.46.6 → 0.46.7

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { CompileOptions, compileFilter } from "./compile-filter.js";
 import { Db } from "./db.js";
-import { Scope } from "./scope.js";
+import { Scope, tenantCondition } from "./scope.js";
 import { RelatedRowsQuery, buildRelatedRows, relatedRows } from "./related-rows.js";
 import { ExtraColumn, ListOptions, ListPlan, ListResult, buildListQuery, listQuery, maxLimit } from "./list-query.js";
 import { estimateCount } from "./estimate-count.js";
@@ -20,4 +20,4 @@ import { IndexKey, TableIndex, TableIndexes, tableIndexes } from "./table-indexe
 import { ColumnUse, CoverageQuery, IndexNeed, UncoveredColumn, indexServes, uncoveredColumns } from "./index-coverage.js";
 import { QueryError, QueryErrorCode } from "./fields/query-error.js";
 import { SeekRequest, seekToPosition } from "./seek-to-position.js";
-export { type ColumnUse, type CompileOptions, type CoverageQuery, type Db, type ExtraColumn, type FacetCount, type FacetOptions, type Granularity, type GroupTotal, type GroupTotalsOptions, type Histogram, type HistogramBucket, type IndexKey, type IndexNeed, type ListOptions, type ListPlan, type ListResult, type MapBounds, type MapBucket, type MapBuckets, type MapPosition, type Measure, QueryError, type QueryErrorCode, type RelatedRowsQuery, type Scope, type ScrollMode, type SeekRequest, type SeriesOptions, type SeriesPoint, type SplitPoint, type SplitSeriesOptions, type TableIndex, type TableIndexes, type UncoveredColumn, buildListQuery, buildRelatedRows, cellsAcross, checkMapPosition, compileFilter, countUpTo, estimateCount, exactCount, facetCounts, groupTotals, histogram, indexServes, listQuery, mapBuckets, mapCellPixels, maxLimit, maxMapBuckets, maxMapZoom, relatedRows, scrollMode, seekToPosition, series, splitSeries, tableIndexes, uncoveredColumns, withoutField };
+export { type ColumnUse, type CompileOptions, type CoverageQuery, type Db, type ExtraColumn, type FacetCount, type FacetOptions, type Granularity, type GroupTotal, type GroupTotalsOptions, type Histogram, type HistogramBucket, type IndexKey, type IndexNeed, type ListOptions, type ListPlan, type ListResult, type MapBounds, type MapBucket, type MapBuckets, type MapPosition, type Measure, QueryError, type QueryErrorCode, type RelatedRowsQuery, type Scope, type ScrollMode, type SeekRequest, type SeriesOptions, type SeriesPoint, type SplitPoint, type SplitSeriesOptions, type TableIndex, type TableIndexes, type UncoveredColumn, buildListQuery, buildRelatedRows, cellsAcross, checkMapPosition, compileFilter, countUpTo, estimateCount, exactCount, facetCounts, groupTotals, histogram, indexServes, listQuery, mapBuckets, mapCellPixels, maxLimit, maxMapBuckets, maxMapZoom, relatedRows, scrollMode, seekToPosition, series, splitSeries, tableIndexes, tenantCondition, uncoveredColumns, withoutField };

package/dist/index.js

@@ -1,5 +1,6 @@
 import { QueryError } from "./fields/query-error.js";
 import { compileFilter } from "./compile-filter.js";
+import { tenantCondition } from "./scope.js";
 import { buildListQuery, listQuery, maxLimit } from "./list-query.js";
 import { buildRelatedRows, relatedRows } from "./related-rows.js";
 import { estimateCount } from "./estimate-count.js";
@@ -16,4 +17,4 @@ import { scrollMode } from "./scroll-mode.js";
 import { tableIndexes } from "./table-indexes.js";
 import { indexServes, uncoveredColumns } from "./index-coverage.js";
 import { seekToPosition } from "./seek-to-position.js";
-export { QueryError, buildListQuery, buildRelatedRows, cellsAcross, checkMapPosition, compileFilter, countUpTo, estimateCount, exactCount, facetCounts, groupTotals, histogram, indexServes, listQuery, mapBuckets, mapCellPixels, maxLimit, maxMapBuckets, maxMapZoom, relatedRows, scrollMode, seekToPosition, series, splitSeries, tableIndexes, uncoveredColumns, withoutField };
+export { QueryError, buildListQuery, buildRelatedRows, cellsAcross, checkMapPosition, compileFilter, countUpTo, estimateCount, exactCount, facetCounts, groupTotals, histogram, indexServes, listQuery, mapBuckets, mapCellPixels, maxLimit, maxMapBuckets, maxMapZoom, relatedRows, scrollMode, seekToPosition, series, splitSeries, tableIndexes, tenantCondition, uncoveredColumns, withoutField };

package/dist/scope.d.ts

@@ -4,6 +4,8 @@ import { CheckedFilter, ResourceModel } from "@protobase/schema";
 /**
  * Who is asking, and which rows they may see.
  * - `tenantValue`: models with a `tenant` column only ever see rows of this value.
+ * - `tenantValues`: instead, rows of any of these values, for a list across the caller's tenants; `rowFilter` then ties
+ *   each tenant to its own access. An empty list sees no rows.
  * - `rowFilter`: a filter from access rules, ANDed in before the user's filter. It is checked against the FULL model,
  *   so it may use hidden or non-filterable columns the user's own (restricted) model does not expose.
  * - `fullModel`: that full model. Soft delete, tenant and `rowFilter` resolve against it; everything the user
@@ -11,7 +13,13 @@ import { CheckedFilter, ResourceModel } from "@protobase/schema";
  */
 export type Scope = {
   tenantValue?: string | number;
+  tenantValues?: readonly (string | number)[];
   rowFilter?: CheckedFilter;
   fullModel?: ResourceModel;
 };
+/**
+ * `tenant = value`, or `tenant in (values)`, for tenant models; throws when the scope is missing, so a forgotten scope
+ * never leaks rows.
+ */
+export declare const tenantCondition: (model: ResourceModel, scope?: Scope) => Expression<SqlBool> | undefined;
 //#endregion

package/dist/scope.js

@@ -3,14 +3,21 @@ import { columnRef } from "./columns.js";
 import { sql } from "kysely";
 //#region src/scope.ts
 const fullModelOf = (model, scope) => scope?.fullModel ?? model;
-/** `tenant = value` for tenant models; throws when the scope is missing, so a forgotten scope never leaks rows. */
+/**
+* `tenant = value`, or `tenant in (values)`, for tenant models; throws when the scope is missing, so a forgotten scope
+* never leaks rows.
+*/
 const tenantCondition = (model, scope) => {
 	const full = fullModelOf(model, scope);
 	const tenant = full.tenant ?? model.tenant;
 	if (!tenant) return void 0;
-	if (scope?.tenantValue === void 0) throw new QueryError("missing_tenant", `Resource "${model.name}" is tenant-scoped; pass scope.tenantValue`);
 	const field = Object.hasOwn(full.fields, tenant) ? full.fields[tenant] : void 0;
 	const column = field ? columnRef(field) : sql`${sql.id("t", tenant)}`;
+	if (scope?.tenantValues) {
+		if (scope.tenantValues.length === 0) return sql`false`;
+		return sql`${column} in (${sql.join(scope.tenantValues)})`;
+	}
+	if (scope?.tenantValue === void 0) throw new QueryError("missing_tenant", `Resource "${model.name}" is tenant-scoped; pass scope.tenantValue`);
 	return sql`${column} = ${scope.tenantValue}`;
 };
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@protobase/query",
-  "version": "0.46.6",
+  "version": "0.46.7",
   "description": "Kysely list, filter, count and aggregate queries over Protobase resources.",
   "license": "Apache-2.0",
   "repository": {
@@ -29,7 +29,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@protobase/schema": "0.46.6",
+    "@protobase/schema": "0.46.7",
     "kysely": "^0.29.6"
   }
 }