@aventara/core 1.0.0-rc.0 → 1.0.0-rc.10

package/dist/contracts/capability.d.ts

@@ -1,15 +1,40 @@
 /** The operators a scalar field can be filtered with. */
-export type ScalarFilterOperator = "equals" | "not" | "in" | "notIn" | "lt" | "lte" | "gt" | "gte" | "contains" | "startsWith" | "endsWith" | "mode" | "has" | "hasEvery" | "hasSome" | "isEmpty" | "path" | "stringContains" | "stringStartsWith" | "stringEndsWith" | "arrayContains" | "arrayStartsWith" | "arrayEndsWith";
+export type AvScalarFilterOperator = "equals" | "not" | "in" | "notIn" | "lt" | "lte" | "gt" | "gte" | "contains" | "startsWith" | "endsWith" | "mode" | "has" | "hasEvery" | "hasSome" | "isEmpty" | "path" | "stringContains" | "stringStartsWith" | "stringEndsWith" | "arrayContains" | "arrayStartsWith" | "arrayEndsWith";
+/**
+ * The case-sensitivity a text filter's `mode` asks for. `"default"` is whatever
+ * the database's own comparison does and is always available; `"sensitive"` and
+ * `"insensitive"` are an explicit promise, available on a field only where its
+ * `filterModes` lists them.
+ */
+export declare const FILTER_MODES: readonly ["default", "sensitive", "insensitive"];
+/** @see FILTER_MODES, the axis this union is derived from. */
+export type ScalarFilterMode = (typeof FILTER_MODES)[number];
 /** What an update can do to a scalar value besides setting it. */
-export type ScalarMutationDirective = "$increment" | "$decrement" | "$multiply" | "$divide" | "$push" | "$unset";
+export type AvScalarMutationDirective = "$increment" | "$decrement" | "$multiply" | "$divide" | "$push" | "$unset";
 /** How a relation can be filtered on. */
-export type RelationFilterCapability = "nested" | "match" | "null" | "some" | "every" | "none";
+export type AvRelationFilterCapability = "nested" | "match" | "null" | "some" | "every" | "none";
 /** What a write can do to a relation: `$create`, `$connect` and the rest. */
-export type RelationMutationDirective = "$create" | "$connect" | "$connectOrCreate" | "$disconnect" | "$set" | "$update" | "$delete" | "$upsert";
+export type AvRelationMutationDirective = "$create" | "$connect" | "$connectOrCreate" | "$disconnect" | "$set" | "$update" | "$delete" | "$upsert";
+/** The to-one directives that change which row the relation links. */
+export declare const TO_ONE_RELINK_DIRECTIVES: readonly ["$connect", "$connectOrCreate", "$create", "$set", "$disconnect"];
+/** The to-one directives that write the row the relation links. */
+export declare const TO_ONE_REWRITE_DIRECTIVES: readonly ["$update", "$upsert"];
+/** @see TO_ONE_RELINK_DIRECTIVES */
+export type ToOneRelinkDirective = (typeof TO_ONE_RELINK_DIRECTIVES)[number];
+/** @see TO_ONE_REWRITE_DIRECTIVES */
+export type ToOneRewriteDirective = (typeof TO_ONE_REWRITE_DIRECTIVES)[number];
+/**
+ * A to-one operand's directives that both relink the relation and write the
+ * linked row, or `undefined` when it does not pair them.
+ */
+export declare function toOneRelinkWithRewrite(operand: Readonly<Record<string, unknown>>): {
+    readonly rewrite: readonly ToOneRewriteDirective[];
+    readonly relink: readonly ToOneRelinkDirective[];
+} | undefined;
 /** How a list of related rows can be paginated. */
-export type PaginationCapability = "limit" | "offset" | "cursor";
+export type AvPaginationCapability = "limit" | "offset" | "cursor";
 /** What a projection can compute over a to-many relation. */
-export type RelationReducer = "$count";
+export type AvRelationReducer = "$count";
 /**
  * Where a projected field may be asked for: the kind of argument POSITION a projection
  * sits in, not the operation that carries it. A variant states the position its
@@ -17,13 +42,13 @@ export type RelationReducer = "$count";
  * projectable in.
  */
 export declare const PROJECTION_SCOPES: readonly ["record", "bulkWrite"];
-/** @see PROJECTION_SCOPES — the axis this union is derived from. */
-export type ProjectionScope = (typeof PROJECTION_SCOPES)[number];
+/** @see PROJECTION_SCOPES, the axis this union is derived from. */
+export type AvProjectionScope = (typeof PROJECTION_SCOPES)[number];
 /**
  * Where a field may be written: the kind of argument POSITION a write sits in,
  * not the operation that carries it. The write counterpart of
- * {@link ProjectionScope}.
+ * {@link AvProjectionScope}.
  */
-export declare const WRITE_SCOPES: readonly ["nested", "bulkWrite"];
-/** @see WRITE_SCOPES — the axis this union is derived from. */
-export type WriteScope = (typeof WRITE_SCOPES)[number];
+export declare const WRITE_SCOPES: readonly ["nested", "bulkWrite", "loopback"];
+/** @see WRITE_SCOPES, the axis this union is derived from. */
+export type AvWriteScope = (typeof WRITE_SCOPES)[number];

package/dist/contracts/capability.js

@@ -1,3 +1,22 @@
+export const FILTER_MODES = ["default", "sensitive", "insensitive"];
+export const TO_ONE_RELINK_DIRECTIVES = [
+    "$connect",
+    "$connectOrCreate",
+    "$create",
+    "$set",
+    "$disconnect",
+];
+export const TO_ONE_REWRITE_DIRECTIVES = [
+    "$update",
+    "$upsert",
+];
+export function toOneRelinkWithRewrite(operand) {
+    const rewrite = TO_ONE_REWRITE_DIRECTIVES.filter((key) => Object.hasOwn(operand, key));
+    const relink = TO_ONE_RELINK_DIRECTIVES.filter((key) => Object.hasOwn(operand, key));
+    return rewrite.length === 0 || relink.length === 0
+        ? undefined
+        : { rewrite, relink };
+}
 export const PROJECTION_SCOPES = [
     "record",
     "bulkWrite",
@@ -5,4 +24,5 @@ export const PROJECTION_SCOPES = [
 export const WRITE_SCOPES = [
     "nested",
     "bulkWrite",
+    "loopback",
 ];