@rebasepro/types 0.10.1-canary.ff9ccd6 → 0.10.1-canary.g4db1bb1

package/dist/controllers/data.d.ts

@@ -1,5 +1,5 @@
 import { Entity, EntityValues } from "../types/entities";
-import { WhereFilterOp, FilterValues, OrderByTuple } from "../types/filter-operators";
+import { WhereFilterOp, FieldPath, FilterValues, OrderByTuple } from "../types/filter-operators";
 export type WhereValue<T> = T | T[] | null;
 export interface LogicalCondition {
     type: "and" | "or";
@@ -39,7 +39,7 @@ export interface FilterCondition {
  *
  * @group Data
  */
-export interface FindParams {
+export interface FindParams<M extends Record<string, unknown> = Record<string, unknown>> {
     /** Maximum number of items to return (default: 20). */
     limit?: number;
     /**
@@ -65,7 +65,7 @@ export interface FindParams {
      * { role: ["in", ["admin", "editor"]] }
      * { age: [[">=", 18], ["<", 65]] }
      */
-    where?: FilterValues<string>;
+    where?: FilterValues<FieldPath<M>>;
     /**
      * Logical grouping conditions (AND/OR). Use this for anything `where`
      * can't express — notably OR-ing conditions. AND-ed with `where` and
@@ -76,8 +76,14 @@ export interface FindParams {
      * Sort order as a `[field, direction]` tuple.
      * @example orderBy: ["created_at", "desc"]
      */
-    orderBy?: OrderByTuple;
-    /** Relations to include in the response */
+    orderBy?: OrderByTuple<FieldPath<M>>;
+    /**
+     * Relations to include in the response.
+     *
+     * Deliberately `string[]` and not checked against `M`: a relation name
+     * comes from the collection's `relations`, not from its columns, so nothing
+     * in a generated row type can validate one.
+     */
     include?: string[];
     /**
      * Full-text search string. Matched (OR-ed) across the collection's
@@ -137,7 +143,7 @@ export interface CollectionAccessor<M extends Record<string, unknown> = Record<s
     /**
      * Find multiple records with optional filtering, pagination, and sorting.
      */
-    find(params?: FindParams): Promise<FindResponse<M>>;
+    find(params?: FindParams<M>): Promise<FindResponse<M>>;
     /**
      * Find a single record by its ID.
      */
@@ -171,7 +177,7 @@ export interface CollectionAccessor<M extends Record<string, unknown> = Record<s
      * Subscribe to a collection for real-time updates.
      * Optional method, may not be supported by all implementations (like stateless HTTP clients).
      */
-    listen?(params: FindParams | undefined, onUpdate: (response: FindResponse<M>) => void, onError?: (error: Error) => void): () => void;
+    listen?(params: FindParams<M> | undefined, onUpdate: (response: FindResponse<M>) => void, onError?: (error: Error) => void): () => void;
     /**
      * Subscribe to a single record for real-time updates.
      * Optional method.
@@ -180,7 +186,7 @@ export interface CollectionAccessor<M extends Record<string, unknown> = Record<s
     /**
      * Count the number of records matching the given filter.
      */
-    count?(params?: FindParams): Promise<number>;
+    count?(params?: FindParams<M>): Promise<number>;
     where<K extends keyof M & string>(column: K, operator: WhereFilterOp, value: WhereValue<M[K]>): QueryBuilderInterface<M>;
     where(logicalCondition: LogicalCondition): QueryBuilderInterface<M>;
     orderBy(column: keyof M & string, direction?: "asc" | "desc"): QueryBuilderInterface<M>;
@@ -259,11 +265,31 @@ export interface SDKQueryBuilderInterface<M extends Record<string, unknown> = Re
  *
  * @group Data
  */
+/**
+ * Per-request options for a write.
+ * @group Data
+ */
+export interface WriteOptions {
+    /**
+     * Names this write, so re-sending it is recognised instead of repeated.
+     *
+     * A client that does not see a response cannot know whether the write
+     * committed. Retrying is therefore the only option, and without a key the
+     * server has no way to tell a retry from a second, genuinely new write — so
+     * it performs it again. On a table with a server-assigned id that is a
+     * duplicate row, because the id the client chose was never used.
+     *
+     * Set by the offline queue on every replay. Honoured for 24 hours and scoped
+     * to the authenticated user; a server that cannot store keys ignores it
+     * rather than refusing the write.
+     */
+    idempotencyKey?: string;
+}
 export interface SDKCollectionClient<M extends Record<string, unknown> = Record<string, unknown>, I = Partial<M>, U = Partial<M>> {
     /**
      * Find multiple records with optional filtering, pagination, and sorting.
      */
-    find(params?: FindParams): Promise<FindResult<M>>;
+    find(params?: FindParams<M>): Promise<FindResult<M>>;
     /**
      * Find a single record by its ID.
      */
@@ -278,7 +304,7 @@ export interface SDKCollectionClient<M extends Record<string, unknown> = Record<
      *   columns.
      * @returns The created row
      */
-    create(data: I, id?: string | number): Promise<M>;
+    create(data: I, id?: string | number, options?: WriteOptions): Promise<M>;
     /**
      * Write many records in a single request and a single transaction.
      *
@@ -323,7 +349,7 @@ export interface SDKCollectionClient<M extends Record<string, unknown> = Record<
     /**
      * Subscribe to a collection for real-time updates.
      */
-    listen?(params: FindParams | undefined, onUpdate: (response: FindResult<M>) => void, onError?: (error: Error) => void): () => void;
+    listen?(params: FindParams<M> | undefined, onUpdate: (response: FindResult<M>) => void, onError?: (error: Error) => void): () => void;
     /**
      * Subscribe to a single record for real-time updates.
      */
@@ -331,7 +357,7 @@ export interface SDKCollectionClient<M extends Record<string, unknown> = Record<
     /**
      * Count the number of records matching the given filter.
      */
-    count?(params?: FindParams): Promise<number>;
+    count?(params?: FindParams<M>): Promise<number>;
     where<K extends keyof M & string>(column: K, operator: WhereFilterOp, value: WhereValue<M[K]>): SDKQueryBuilderInterface<M>;
     where(logicalCondition: LogicalCondition): SDKQueryBuilderInterface<M>;
     orderBy(column: keyof M & string, direction?: "asc" | "desc"): SDKQueryBuilderInterface<M>;

package/dist/index.es.js

@@ -391,6 +391,20 @@ function getDeclaredSubcollections(collection) {
 	return collection.subcollections;
 }
 //#endregion
+//#region src/types/relations.ts
+/** @group Models */
+function hasForeignKeyOnTarget(relation) {
+	return relation.kind === "hasOne" || relation.kind === "hasMany";
+}
+/** @group Models */
+function isManyToMany(relation) {
+	return relation.kind === "manyToMany";
+}
+/** @group Models */
+function isToMany(relation) {
+	return relation.cardinality === "many";
+}
+//#endregion
 //#region src/types/policy.ts
 /**
 * The id a request without a logged-in user reports as `auth.uid()`.
@@ -941,6 +955,6 @@ function isPublicStoragePath(path) {
 	return p.startsWith("public/") || p.startsWith(`default/public/`);
 }
 //#endregion
-export { ADMIN_COLLECTION_KEYS, ALL_WHERE_FILTER_OPS, ANONYMOUS_USER_ID, BUNDLE_FORMAT_VERSION, CANONICAL_TO_REST, DEFAULT_CAPABILITIES, DEFAULT_DATA_SOURCE_KEY, DEFAULT_LIST_LIMIT, DEFAULT_STORAGE_SOURCE_KEY, DEFAULT_VECTOR_LIST_LIMIT, EntityReference, EntityRelation, FIREBASE_CAPABILITIES, GeoPoint, MAX_LIST_LIMIT, MONGODB_CAPABILITIES, NULL_OPS, POSTGRES_CAPABILITIES, PUBLIC_STORAGE_PREFIX, REST_TO_CANONICAL, RUNTIME_CONTRACT_VERSION, RebaseApiError, RebaseClientError, SCHEMA_VERSION_HEADER, Vector, canonicalSchemaPayload, computeSchemaVersion, deserializeCollections, getCollectionDataPath, getDataSourceCapabilities, getDeclaredSubcollections, isBranchAdmin, isChannelBusInstance, isDocumentAdmin, isFirebaseCollectionConfig, isLazyComponentRef, isMongoDBCollectionConfig, isPostgresCollectionConfig, isPublicStoragePath, isSQLAdmin, isSchemaAdmin, isSerializedCollectionRef, policy, registerDataSourceCapabilities, resolveClientListLimit, serializeCollections, toCanonicalOp };
+export { ADMIN_COLLECTION_KEYS, ALL_WHERE_FILTER_OPS, ANONYMOUS_USER_ID, BUNDLE_FORMAT_VERSION, CANONICAL_TO_REST, DEFAULT_CAPABILITIES, DEFAULT_DATA_SOURCE_KEY, DEFAULT_LIST_LIMIT, DEFAULT_STORAGE_SOURCE_KEY, DEFAULT_VECTOR_LIST_LIMIT, EntityReference, EntityRelation, FIREBASE_CAPABILITIES, GeoPoint, MAX_LIST_LIMIT, MONGODB_CAPABILITIES, NULL_OPS, POSTGRES_CAPABILITIES, PUBLIC_STORAGE_PREFIX, REST_TO_CANONICAL, RUNTIME_CONTRACT_VERSION, RebaseApiError, RebaseClientError, SCHEMA_VERSION_HEADER, Vector, canonicalSchemaPayload, computeSchemaVersion, deserializeCollections, getCollectionDataPath, getDataSourceCapabilities, getDeclaredSubcollections, hasForeignKeyOnTarget, isBranchAdmin, isChannelBusInstance, isDocumentAdmin, isFirebaseCollectionConfig, isLazyComponentRef, isManyToMany, isMongoDBCollectionConfig, isPostgresCollectionConfig, isPublicStoragePath, isSQLAdmin, isSchemaAdmin, isSerializedCollectionRef, isToMany, policy, registerDataSourceCapabilities, resolveClientListLimit, serializeCollections, toCanonicalOp };
 
 //# sourceMappingURL=index.es.js.map