@rebasepro/types 0.16.0 → 0.16.1-canary.g041c925

package/dist/call_context.d.ts

@@ -1,8 +1,8 @@
-import type { DataDriver } from "./controllers/data_driver";
-import type { StorageSource } from "./controllers/storage";
-import type { RebaseClient } from "./controllers/client";
-import type { RebaseSdkData } from "./controllers/data";
-import type { User } from "./users";
+import type { DataDriver } from "./controllers/data_driver.js";
+import type { StorageSource } from "./controllers/storage.js";
+import type { RebaseClient } from "./controllers/client.js";
+import type { RebaseSdkData } from "./controllers/data.js";
+import type { User } from "./users/index.js";
 /**
  * Context that is provided to entity callbacks (hooks).
  * It contains only the dependencies that are available in both the frontend and the backend.

package/dist/controllers/auth_state.d.ts

@@ -1,4 +1,4 @@
-import type { User } from "../users";
+import type { User } from "../users/index.js";
 /**
  * The read-only slice of authentication state that property resolution needs.
  *

package/dist/controllers/client.d.ts

@@ -1,11 +1,11 @@
-import type { User } from "../users";
-import type { RebaseSdkData } from "./data";
-import type { EmailService } from "./email";
-import type { StorageSource } from "./storage";
-import type { CronJobStatus, CronJobLogEntry } from "../types/cron";
-import type { BackupInfo, BackupDestinationKind } from "../types/backup";
-import type { ApiKeysAPI } from "../types/api_keys";
-import type { StorageSourceDefinition } from "../types/storage_source";
+import type { User } from "../users/index.js";
+import type { RebaseSdkData } from "./data.js";
+import type { EmailService } from "./email.js";
+import type { StorageSource } from "./storage.js";
+import type { CronJobStatus, CronJobLogEntry } from "../types/cron.js";
+import type { BackupInfo, BackupDestinationKind } from "../types/backup.js";
+import type { ApiKeysAPI } from "../types/api_keys.js";
+import type { StorageSourceDefinition } from "../types/storage_source.js";
 /**
  * Event type for authentication state changes
  */
@@ -327,7 +327,7 @@ export interface RebaseClient<DB = unknown> {
     dataAsAdmin?: RebaseSdkData<DB>;
     /** Unified Authentication layer */
     auth: AuthClient;
-    /** Unified Storage layer (default storage source, backward-compatible) */
+    /** Unified Storage layer — the default storage source. */
     storage?: StorageSource;
     /** Registry of all named storage sources for multi-backend support */
     storageRegistry?: StorageSourceRegistry;
@@ -443,6 +443,19 @@ export interface RebaseServerClient<DB = unknown> extends Omit<RebaseClient<DB>,
      * Execute raw SQL against the database. Always present server-side for SQL
      * engines. Values interpolated into the query should be passed via
      * `params`, referenced as `$1`, `$2`, … placeholders in the query text.
+     *
+     * **Runtime note.** This is the one accessor on this object that is not
+     * portable. It runs on the database owner connection over a TCP socket, so
+     * it is available wherever the framework holds that connection — every Node
+     * deployment, self-hosted or managed — and not on a host that has no
+     * sockets and no business holding owner credentials.
+     *
+     * Nothing about that is a problem for a Node deployment, and it is not a
+     * reason to avoid it there. It is a reason not to build a function's *only*
+     * data path on it if that function may later move: `c.get("driver")` and
+     * `rebase.dataAsAdmin` go over the same wire wherever they run. A function
+     * that genuinely needs raw SQL can ask `runtimeKey()` and degrade, rather
+     * than discovering it at the call.
      */
     sql(query: string, options?: {
         database?: string;

package/dist/controllers/collection_registry.d.ts

@@ -1,5 +1,5 @@
-import type { CollectionConfig } from "../types/collections";
-import type { EntityReference } from "../types/entities";
+import type { CollectionConfig } from "../types/collections.js";
+import type { EntityReference } from "../types/entities.js";
 /**
  * Controller that provides access to the registered entity collections.
  * @group Models

package/dist/controllers/data.d.ts

@@ -1,15 +1,7 @@
-import type { VectorSearchParams } from "./data_driver";
-import type { ComputedSortField, SearchMatch } from "../types/search";
-import { Entity, EntityValues } from "../types/entities";
-import { WhereFilterOp, FieldPath, FilterValues, OrderBySpec } from "../types/filter-operators";
-/**
- * Operator-blind filter value: whatever the column holds, a list of it, or null.
- *
- * @deprecated Superseded by {@link WhereValueFor}, which correlates the value
- * with the operator. Kept exported because it is public API and downstream code
- * annotates with it; every `where()` overload in this file uses `WhereValueFor`.
- */
-export type WhereValue<T> = T | T[] | null;
+import type { VectorSearchParams } from "./data_driver.js";
+import type { ComputedSortField, SearchMatch } from "../types/search.js";
+import { Entity, EntityValues } from "../types/entities.js";
+import { WhereFilterOp, FieldPath, FilterValues, OrderBySpec } from "../types/filter-operators.js";
 /**
  * The element type of an array column, and the column's own type otherwise.
  *

package/dist/controllers/data_driver.d.ts

@@ -1,9 +1,9 @@
-import { RebaseApiError } from "../errors";
-import type { EntityStatus, EntityValues } from "../types/entities";
-import type { CollectionConfig, FilterValues } from "../types/collections";
-import type { OrderByTuple } from "../types/filter-operators";
-import type { RebaseCallContext } from "../call_context";
-import type { LogicalCondition } from "./data";
+import { RebaseApiError } from "../errors.js";
+import type { EntityStatus, EntityValues } from "../types/entities.js";
+import type { CollectionConfig, FilterValues } from "../types/collections.js";
+import type { OrderByTuple } from "../types/filter-operators.js";
+import type { RebaseCallContext } from "../call_context.js";
+import type { LogicalCondition } from "./data.js";
 /**
  * @internal
  */
@@ -384,7 +384,7 @@ export interface DataDriver {
      * @see DocumentAdmin
      * @see SchemaAdmin
      */
-    admin?: import("../types/backend").DatabaseAdmin;
+    admin?: import("../types/backend.js").DatabaseAdmin;
 }
 /**
  * REST-optimised fetch service exposed by drivers that support

package/dist/controllers/email.d.ts

@@ -19,6 +19,50 @@ export interface EmailSendOptions {
     text?: string;
     /** Optional reply-to address. */
     replyTo?: string;
+    /**
+     * Additional headers, verbatim.
+     *
+     * The reason this exists is that several things a real sender must do are
+     * only expressible as headers, and without a passthrough an application had
+     * to choose between not doing them and not using this interface:
+     *
+     * - `List-Unsubscribe` and `List-Unsubscribe-Post`, which give a mail client
+     *   its own one-click opt-out. The large providers weigh their presence when
+     *   deciding whether bulk mail reaches an inbox at all.
+     * - `In-Reply-To` and `References`, without which a reply is a new thread.
+     *
+     * **Values are validated, not escaped.** A value containing CR or LF is
+     * rejected rather than sanitised, because a newline in a header value ends
+     * the header and starts a new one — so a field built from user input is an
+     * injection point for `Bcc:` and anything else. Rejecting is the only safe
+     * response: silently stripping the newline would deliver a message the
+     * caller did not write, and neither would tell them.
+     */
+    headers?: Record<string, string>;
+}
+/**
+ * What the provider reported about a message it accepted.
+ *
+ * Every field is optional because not every backend reports them: a custom
+ * `sendEmail` function that posts to an HTTP API may know nothing beyond "no
+ * error". An absent `messageId` therefore means "not reported", never "not
+ * sent" — the absence of an id is not a delivery failure, which is signalled by
+ * a thrown error.
+ */
+export interface EmailSendResult {
+    /**
+     * The message's RFC 5322 Message-ID, **without** angle brackets.
+     *
+     * Stripped because this is an identifier to store and compare — against a
+     * reply's `In-Reply-To`, most often — and a value that sometimes carries
+     * brackets and sometimes does not is a bug waiting in every comparison.
+     * Re-add them when writing it into a header: `<${messageId}>`.
+     */
+    messageId?: string;
+    /** Recipients the provider accepted, when it says. */
+    accepted?: string[];
+    /** Recipients the provider refused, when it says. A non-empty list is not an error. */
+    rejected?: string[];
 }
 /**
  * Abstraction over an email delivery backend.
@@ -27,8 +71,16 @@ export interface EmailSendOptions {
  * provider — consumers only interact through this interface.
  */
 export interface EmailService {
-    /** Send a single email. */
-    send(options: EmailSendOptions): Promise<void>;
+    /**
+     * Send a single email.
+     *
+     * Resolves with what the provider reported (see {@link EmailSendResult});
+     * throws on failure. It returned `void` before 0.17: an application that
+     * sent a message had no way to learn the id the server assigned it, so
+     * threading a reply back to the message that prompted it was impossible
+     * through this interface. Callers that do not care may still ignore it.
+     */
+    send(options: EmailSendOptions): Promise<EmailSendResult>;
     /** Returns `true` when the service has valid credentials / is ready to send. */
     isConfigured(): boolean;
     /** Verify connection/credentials with the email provider. */

package/dist/controllers/index.d.ts

@@ -1,9 +1,8 @@
-export * from "./collection_registry";
-export * from "./auth_state";
-export * from "./data";
-export * from "./database_admin";
-export * from "./data_driver";
-export * from "./effective_role";
-export * from "./storage";
-export * from "./email";
-export * from "./client";
+export * from "./collection_registry.js";
+export * from "./auth_state.js";
+export * from "./data.js";
+export * from "./data_driver.js";
+export * from "./effective_role.js";
+export * from "./storage.js";
+export * from "./email.js";
+export * from "./client.js";

package/dist/controllers/storage.d.ts

@@ -46,11 +46,11 @@ export interface UploadFileResult {
     /**
      * Fully qualified storage URL for the uploaded file.
      *
-     * For example: `s3://my-bucket/path/to/file.png`.
-     *
-     * This is optional for backwards compatibility.
+     * For example: `s3://my-bucket/path/to/file.png`. Every controller in the
+     * framework returns one — S3, GCS and local alike — and a caller that stores
+     * the reference needs it, so it is part of the result rather than a maybe.
      */
-    storageUrl?: string;
+    storageUrl: string;
 }
 /**
  * @group Models

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./errors";
-export * from "./call_context";
-export * from "./types";
-export * from "./controllers";
-export * from "./users";
+export * from "./errors.js";
+export * from "./call_context.js";
+export * from "./types/index.js";
+export * from "./controllers/index.js";
+export * from "./users/index.js";