@notionhq/custom-blocks-host 0.0.1

package/src/queries/validateQueryDataSourceFilter.ts

@@ -0,0 +1,101 @@
+import type { NotionCollectionSchema } from "@notionhq/custom-blocks-protocol/dataSources/dataSource.js"
+import type {
+	CustomBlockContainsFilterOperator,
+	CustomBlockOptionFilterOperator,
+	ResolvedCustomBlockDataSourceFilter,
+	ResolvedCustomBlockDataSourcePropertyFilter,
+} from "@notionhq/custom-blocks-protocol/messages/queryDataSource.js"
+import type { CustomBlockQueryDataSourceErrorInfo } from "@notionhq/custom-blocks-protocol/messages/queryDataSourceResult.js"
+import { unreachable } from "../utils.js"
+
+type OptionFilterOperator =
+	| CustomBlockOptionFilterOperator
+	| CustomBlockContainsFilterOperator
+
+export function validateQueryDataSourceFilter(
+	filter: ResolvedCustomBlockDataSourceFilter | undefined,
+	collectionSchema: NotionCollectionSchema | undefined,
+): CustomBlockQueryDataSourceErrorInfo | undefined {
+	if (filter === undefined || collectionSchema === undefined) {
+		return undefined
+	}
+
+	const propertyFilters = "and" in filter ? filter.and : [filter]
+	for (const propertyFilter of propertyFilters) {
+		const error = validatePropertyFilter(propertyFilter, collectionSchema)
+		if (error !== undefined) {
+			return error
+		}
+	}
+	return undefined
+}
+
+function validatePropertyFilter(
+	filter: ResolvedCustomBlockDataSourcePropertyFilter,
+	collectionSchema: NotionCollectionSchema,
+): CustomBlockQueryDataSourceErrorInfo | undefined {
+	const propertySchema = collectionSchema.propertiesById[filter.propertyId]
+	if (propertySchema === undefined) {
+		return undefined
+	}
+
+	const optionFilter = getOptionFilter(filter)
+	if (
+		optionFilter === undefined ||
+		propertySchema.type !== optionFilter.propertyType
+	) {
+		return undefined
+	}
+
+	const optionNames = new Set(propertySchema.options.map(option => option.name))
+	const invalidOptionName = getOptionFilterValues(optionFilter.operator).find(
+		optionName => !optionNames.has(optionName),
+	)
+	if (invalidOptionName === undefined) {
+		return undefined
+	}
+
+	return {
+		code: "invalid_data_source_query_filter",
+		message: `Data source query filter option "${invalidOptionName}" is not defined for property "${filter.propertyId}".`,
+		isRetryable: false,
+	}
+}
+
+function getOptionFilter(filter: ResolvedCustomBlockDataSourcePropertyFilter):
+	| {
+			propertyType: "select" | "multi_select" | "status"
+			operator: OptionFilterOperator
+	  }
+	| undefined {
+	if ("select" in filter) {
+		return { propertyType: "select", operator: filter.select }
+	}
+	if ("multi_select" in filter) {
+		return { propertyType: "multi_select", operator: filter.multi_select }
+	}
+	if ("status" in filter) {
+		return { propertyType: "status", operator: filter.status }
+	}
+	return undefined
+}
+
+function getOptionFilterValues(operator: OptionFilterOperator): string[] {
+	let value: string | string[]
+	if ("equals" in operator) {
+		value = operator.equals
+	} else if ("does_not_equal" in operator) {
+		value = operator.does_not_equal
+	} else if ("contains" in operator) {
+		value = operator.contains
+	} else if ("contains_all" in operator) {
+		value = operator.contains_all
+	} else if ("does_not_contain" in operator) {
+		value = operator.does_not_contain
+	} else if ("is_empty" in operator || "is_not_empty" in operator) {
+		return []
+	} else {
+		return unreachable(operator)
+	}
+	return Array.isArray(value) ? value : [value]
+}

package/src/queries/validateQueryDataSourceSorts.ts

@@ -0,0 +1,69 @@
+import type { NotionCollectionSchema } from "@notionhq/custom-blocks-protocol/dataSources/dataSource.js"
+import { CUSTOM_BLOCK_DATA_SOURCE_SORTABLE_PROPERTY_TYPES } from "@notionhq/custom-blocks-protocol/dataSources/propertySchema.js"
+import {
+	CUSTOM_BLOCK_DATA_SOURCE_QUERY_MAX_SORTS,
+	type ResolvedCustomBlockDataSourceSort,
+} from "@notionhq/custom-blocks-protocol/messages/queryDataSource.js"
+import type { CustomBlockQueryDataSourceErrorInfo } from "@notionhq/custom-blocks-protocol/messages/queryDataSourceResult.js"
+
+const supportedDataSourceSortPropertyTypes = new Set<string>(
+	CUSTOM_BLOCK_DATA_SOURCE_SORTABLE_PROPERTY_TYPES,
+)
+
+/**
+ * Ensures the sorts of a data source query are valid.
+ */
+export function validateQueryDataSourceSorts(
+	sorts: ResolvedCustomBlockDataSourceSort[] | undefined,
+	collectionSchema: NotionCollectionSchema | undefined,
+): CustomBlockQueryDataSourceErrorInfo | undefined {
+	if (sorts === undefined) {
+		return undefined
+	}
+	if (sorts.length > CUSTOM_BLOCK_DATA_SOURCE_QUERY_MAX_SORTS) {
+		return {
+			code: "invalid_data_source_query_sort",
+			message: `Data source query sorts may contain at most ${CUSTOM_BLOCK_DATA_SOURCE_QUERY_MAX_SORTS} entries.`,
+			isRetryable: false,
+		}
+	}
+
+	const seenPropertyIds = new Set<string>()
+	for (const sort of sorts) {
+		if (seenPropertyIds.has(sort.propertyId)) {
+			return {
+				code: "invalid_data_source_query_sort",
+				message: `Data source query sorts cannot contain duplicate property ID "${sort.propertyId}".`,
+				isRetryable: false,
+			}
+		}
+		seenPropertyIds.add(sort.propertyId)
+
+		if (
+			collectionSchema !== undefined &&
+			!Object.prototype.hasOwnProperty.call(
+				collectionSchema.propertiesById,
+				sort.propertyId,
+			)
+		) {
+			return {
+				code: "invalid_data_source_query_sort",
+				message: `Data source query sort property ID "${sort.propertyId}" is not defined in the bound data source schema.`,
+				isRetryable: false,
+			}
+		}
+
+		const propertySchema = collectionSchema?.propertiesById[sort.propertyId]
+		if (
+			propertySchema !== undefined &&
+			!supportedDataSourceSortPropertyTypes.has(propertySchema.type)
+		) {
+			return {
+				code: "invalid_data_source_query_sort",
+				message: `Data source query sorts do not yet support property type "${propertySchema.type}".`,
+				isRetryable: false,
+			}
+		}
+	}
+	return undefined
+}

package/src/utils.ts

@@ -0,0 +1,8 @@
+/**
+ * Throws when a discriminated union has an unexpected member.
+ */
+export function unreachable(value: never): never {
+	throw new Error(
+		`[custom-blocks-host] Unexpected value encountered: ${JSON.stringify(value)}`,
+	)
+}