@prisma-next/sql-lane-query-builder 0.3.0-dev.34 → 0.3.0-dev.37

package/dist/index.d.mts

@@ -1 +1,213 @@
-export { };
+import { Brand, StorageHashBase } from "@prisma-next/contract/types";
+import { SqlContract, StorageColumn } from "@prisma-next/sql-contract/types";
+
+//#region src/type-errors.d.ts
+
+/**
+ * An error message type, prefixed with `[error]`.
+ *
+ * @template TMessage The error message.
+ */
+type ErrorMessage = `[error] ${string}`;
+/**
+ * An error type indicating that the previous function call had bad input.
+ * To be used as a return type.
+ *
+ * @template TMessage The error message.
+ */
+type PreviousFunctionReceivedBadInputError<TMessage extends ErrorMessage> = Brand<TMessage>;
+//#endregion
+//#region src/column-reference.d.ts
+/**
+ * An object representing a reference to a column in a table in the database.
+ *
+ * @template TColumnName The name of the column.
+ * @template TTableName The name of the table this column belongs to.
+ * @template THash The contract storage hash belonging to the database this column is in.
+ */
+type ColumnReference<TColumnName extends string = string, TTableName extends string = string, THash extends StorageHashBase<string> = StorageHashBase<string>> = {
+  readonly '~name': TColumnName;
+  readonly '~table': TTableName;
+} & Brand<'[info] this column reference belongs to the following table reference:', `${TTableName}@${THash}`>;
+/**
+ * An error type indicating that the provided column reference is out of the contract's scope.
+ * To be used in reference creators, e.g. `createRef()`.
+ *
+ * @template TMessage The error message.
+ */
+type ColumnReferenceOutOfContractError<TMessage extends ErrorMessage> = Brand<TMessage>;
+/**
+ * A type representing a reference to all columns in the current query context.
+ */
+type Asterisk = {
+  readonly '~name': '*';
+  readonly '~table': null;
+} & Brand<'[info] referencing all columns in the current query context'>;
+/**
+ * A type representing a reference to all columns in a specific table.
+ *
+ * @template TTableName The name of the table whose columns are being referenced.
+ * @template THash The contract storage hash belonging to the database this column is in.
+ */
+type TableAsterisk<TTableName extends string = string, THash extends StorageHashBase<string> = StorageHashBase<string>> = {
+  readonly '~name': '*';
+  readonly '~table': TTableName;
+} & Brand<'[info] referencing all columns that belong to the following table reference:', `${TTableName}@${THash}`>;
+//#endregion
+//#region src/table-reference.d.ts
+/**
+ * An object representing a reference to a table in the database.
+ *
+ * @template TName The name of the table. `string` is all tables, a union of string literals is a set of specific tables, a single string literal is a specific table.
+ * @template THash The contract storage hash belonging to the database this table is in.
+ */
+type TableReference<TName extends string = string, THash extends StorageHashBase<string> = StorageHashBase<string>> = {
+  readonly '~name': TName;
+} & Brand<'[info] this table reference belongs to the contract with the following storage hash:', THash>;
+/**
+ * An error type indicating that the provided table reference is out of the contract's scope.
+ * To be used in reference creators, e.g. `createRef()`.
+ *
+ * @template TMessage The error message.
+ */
+type TableReferenceOutOfContractError<TMessage extends ErrorMessage> = Brand<TMessage>;
+/**
+ * An error type indicating that the provided table reference is too wide.
+ * To be used as a `never` alternative in conditional types.
+ *
+ * @template TMessage The error message.
+ */
+type TableReferenceTooWideError<TMessage extends ErrorMessage> = Brand<TMessage>;
+//#endregion
+//#region src/ref.d.ts
+/**
+ * A fluent API representing references to tables and columns in a SQL contract.
+ *
+ * @template TContract The contract that describes the database.
+ */
+type Ref<TContract extends SqlContract> = { readonly [TableName in keyof TContract['storage']['tables'] & string]: TableReference<TableName, TContract['storageHash']> & { readonly [ColumnName in Exclude<keyof TContract['storage']['tables'][TableName]['columns'], keyof TableReference> & string]: ColumnReference<ColumnName, TableName, TContract['storageHash']> } & {
+  readonly ['*']: TableAsterisk<TableName, TContract['storageHash']>;
+} & Record<PropertyKey, ColumnReferenceOutOfContractError<`[error] reference to a non-existing column in the '${TableName}' table`>> } & {
+  readonly ['*']: Asterisk;
+} & Record<PropertyKey, TableReferenceOutOfContractError<`[error] reference to a non-existing table in the contract`>>;
+/**
+ * Creates a reference object for the given SQL contract.
+ *
+ * @template TContract The contract that describes the database.
+ */
+declare function createRef<TContract extends SqlContract>(_contract: TContract): Ref<TContract>;
+//#endregion
+//#region src/type-atoms.d.ts
+/**
+ * A utility type to drain outer generics from a type. A compiler micro-optimization.
+ *
+ * @template TThing The type to drain.
+ */
+type DrainOuterGeneric<TThing> = [TThing] extends [unknown] ? TThing : never;
+/**
+ * A utility type to ensure that exactly one property of an object type is present.
+ *
+ * @template TObject The object type to check.
+ */
+type ExactlyOneProperty<TObject extends object> = { [K in keyof TObject]-?: IsNever<Exclude<keyof TObject, K>> }[keyof TObject];
+/**
+ * A utility type to merge two objects.
+ *
+ * @template TObject0 The first object.
+ * @template TObject1 The second object.
+ */
+type MergeObjects<TObject0 extends object, TObject1 extends object> = DrainOuterGeneric<IsNever<TObject0> extends true ? TObject1 : { readonly [K in keyof TObject0 | keyof TObject1]: K extends keyof TObject1 ? TObject1[K] : K extends keyof TObject0 ? TObject0[K] : never }>;
+/**
+ * A utility type to determine if a type is `never`.
+ *
+ * @template TThing The type to check.
+ */
+type IsNever<TThing> = [TThing] extends [never] ? true : false;
+/**
+ * A utility type to simplify an object type for better readability.
+ *
+ * @template TObject The object type to simplify.
+ */
+type Simplify<TObject extends object> = DrainOuterGeneric<{ [K in keyof TObject]: TObject[K] } & {}>;
+//#endregion
+//#region src/selection.d.ts
+/**
+ * A utility type to extract the output type of a referenced column from a contract.
+ *
+ * @template TContract The contract that describes the database.
+ * @template TTableName The name of the table containing the column.
+ * @template TColumnName The name of the column whose output type is to be extracted.
+ */
+type ExtractOutputType<TContract extends SqlContract, TTableName extends keyof TContract['storage']['tables'] & string, TColumnName extends keyof TContract['storage']['tables'][TTableName]['columns'] & string, _TColumn = TContract['storage']['tables'][TTableName]['columns'][TColumnName]> = _TColumn extends StorageColumn ? (_TColumn['nullable'] extends true ? null : never) | TContract['mappings']['codecTypes'][_TColumn['codecId']]['output'] : never;
+/**
+ * A type representing a selection of columns in a SQL `select` query in the
+ * most generic form.
+ */
+type Selection = Record<string, SelectionValue<unknown, unknown>>;
+/**
+ * A type representing the value of a selected column in a SQL `select` query.
+ *
+ * @template TOutput The output type of the selected column.
+ * @template TDatatype The database-side datatype of the selected column.
+ */
+interface SelectionValue<TOutput, TDatatype extends string | unknown = unknown> {
+  readonly '~datatype': TDatatype;
+  readonly '~output': TOutput;
+}
+/**
+ * A utility type to convert a table's columns into a {@link Selection}.
+ *
+ * @template TContract The contract that describes the database.
+ * @template TTableName The name of the table whose columns will be included in the selection.
+ */
+type TableToSelection<TContract extends SqlContract, TTableName extends keyof TContract['storage']['tables'] & string> = DrainOuterGeneric<{ readonly [ColumnName in keyof TContract['storage']['tables'][TTableName]['columns'] & string]: SelectionValue<ExtractOutputType<TContract, TTableName, ColumnName>, TContract['storage']['tables'][TTableName]['columns'][ColumnName]['nativeType']> }>;
+//#endregion
+//#region src/select-builder.d.ts
+/**
+ * A builder for SQL `select` queries.
+ *
+ * @template TContract The contract that describes the database.
+ * @template TTables The tables involved in the current `select` query.
+ * @template TSelection The current selection of the `select` query.
+ */
+declare class SelectBuilder<TContract extends SqlContract, TTables extends SqlContract['storage']['tables'], TSelection extends Selection = never> {
+  #private;
+  constructor(contract: TContract);
+  select(asterisk: Asterisk): ExactlyOneProperty<TTables> extends true ? SelectBuilder<TContract, TTables, MergeObjects<TSelection, TableToSelection<TContract, keyof TTables & string>>> : PreviousFunctionReceivedBadInputError<'[error] selecting all columns via `*` results in ambiguity when multiple tables are involved in the query'>;
+  select<TTableName extends keyof TTables & string>(asterisk: TableAsterisk<TTableName, TContract['storageHash']>): SelectBuilder<TContract, TTables, MergeObjects<TSelection, TableToSelection<TContract, TTableName>>>;
+  select(arg: never): PreviousFunctionReceivedBadInputError<'[error] invalid input in previous `select()` call'>;
+  build(): IsNever<TSelection> extends true ? never : Simplify<TSelection>;
+}
+//#endregion
+//#region src/root.d.ts
+/**
+ * The root of all builder.
+ *
+ * @template TContract The contract that describes the database.
+ */
+declare class Root<TContract extends SqlContract> {
+  #private;
+  constructor(contract: TContract);
+  /**
+   * SQL's `from` clause, where all `select` queries actually start from.
+   *
+   * @param table The table to select from.
+   */
+  from(table: TableReference<never>): PreviousFunctionReceivedBadInputError<'[error] invalid table reference in previous `root.from()` call will probably cause runtime errors'>;
+  /**
+   * @template TName The name of the table to select from.
+   */
+  from<TName extends string>(table: string extends TName ? TableReferenceTooWideError<'[error] `root.from()` call received a table reference without a specific table name'> : TableReference<TName, TContract['storageHash']>): TName extends string ? SelectBuilder<TContract, Pick<TContract['storage']['tables'], TName>> : PreviousFunctionReceivedBadInputError<'[error] invalid table reference in previous `root.from()` call will probably cause runtime errors'>;
+  from(table: TableReferenceTooWideError<'[error] `root.from()` call received a table reference without a specific table name'>): PreviousFunctionReceivedBadInputError<'[error] invalid table reference in previous `root.from()` call will probably cause runtime errors'>;
+}
+/**
+ * Creates a new `Root` instance.
+ */
+declare function createRoot(contract: never): PreviousFunctionReceivedBadInputError<'[error] root creation will likely fail at runtime given the passed contract is not valid or verified'>;
+/**
+ * @template TContract The contract that describes the database.
+ */
+declare function createRoot<TContract extends SqlContract>(contract: TContract): Root<TContract>;
+//#endregion
+export { type Asterisk, type ColumnReference, type ColumnReferenceOutOfContractError, type DrainOuterGeneric, type ErrorMessage, type ExactlyOneProperty, type ExtractOutputType, type IsNever, type MergeObjects, type PreviousFunctionReceivedBadInputError, type Ref, type Root, type SelectBuilder, type Selection, type SelectionValue, type Simplify, type TableAsterisk, type TableReference, type TableReferenceOutOfContractError, type TableReferenceTooWideError, type TableToSelection, createRef, createRoot };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/type-errors.ts","../src/column-reference.ts","../src/table-reference.ts","../src/ref.ts","../src/type-atoms.ts","../src/selection.ts","../src/select-builder.ts","../src/root.ts"],"sourcesContent":[],"mappings":";;;;;;;;AAOA;AAQA;AAAmE,KARvD,YAAA,GAQuD,WAAA,MAAA,EAAA;;;;;;;ACLvD,KDKA,qCCLe,CAAA,iBDKwC,YCLxC,CAAA,GDKwD,KCLxD,CDK8D,QCL9D,CAAA;;;;;ADH3B;AAQA;;;;AAAwF,KCL5E,eDK4E,CAAA,oBAAA,MAAA,GAAA,MAAA,EAAA,mBAAA,MAAA,GAAA,MAAA,EAAA,cCFxE,eDEwE,CAAA,MAAA,CAAA,GCF9C,eDE8C,CAAA,MAAA,CAAA,CAAA,GAAA;oBCApE;qBACC;IACjB,mFAEC,cAAc;AATnB;;;;;;AASmB,KASP,iCATO,CAAA,iBAS4C,YAT5C,CAAA,GAS4D,KAT5D,CASkE,QATlE,CAAA;;;AASnB;AAA+D,KAKnD,QAAA,GALmD;EAAsB,SAAA,OAAA,EAAA,GAAA;EAAN,SAAA,QAAA,EAAA,IAAA;CAAK,GAQhF,KARgF,CAAA,6DAAA,CAAA;AAKpF;AAWA;;;;;AAQmB,KARP,aAQO,CAAA,mBAAA,MAAA,GAAA,MAAA,EAAA,cANH,eAMG,CAAA,MAAA,CAAA,GANuB,eAMvB,CAAA,MAAA,CAAA,CAAA,GAAA;EAFf,SAAA,OAAA,EAAA,GAAA;EAAK,SAAA,QAAA,EADY,UACZ;IAAL,yFAEC,cAAc;;;;;AD7CnB;AAQA;;;AAAmF,KENvE,cFMuE,CAAA,cAAA,MAAA,GAAA,MAAA,EAAA,cEJnE,eFImE,CAAA,MAAA,CAAA,GEJzC,eFIyC,CAAA,MAAA,CAAA,CAAA,GAAA;EAAK,SAAA,OAAA,EEFpE,KFEoE;IEDpF,8FAEF;;;ADNF;;;;AAMqB,KCST,gCDTS,CAAA,iBCSyC,YDTzC,CAAA,GCSyD,KDTzD,CCS+D,QDT/D,CAAA;;;;;AAYrB;;AAAqF,KCKzE,0BDLyE,CAAA,iBCK7B,YDL6B,CAAA,GCKb,KDLa,CCKP,QDLO,CAAA;;;;ADrBrF;AAQA;;;AAAmF,KGDvE,GHCuE,CAAA,kBGDjD,WHCiD,CAAA,GAAA,yBAAK,MGAzD,SHAyD,CAAA,SAAA,CAAA,CAAA,QAAA,CAAA,GAAA,MAAA,GGAf,cHAe,CGCpF,SHDoF,EGEpF,SHFoF,CAAA,aAAA,CAAA,CAAA,GAAA,0BGI5D,cAChB,+BAA+B,6BAC/B,2BAEG,gBAAgB,YAAY,WAAW;kBAElC,cAAc,WAAW;AFfjC,CAAA,GEgBN,MFhBM,CEiBN,WFjBqB,EEkBrB,iCFlBqB,CAAA,sDEkBmE,SFlBnE,SAAA,CAAA,CAAA,EAGX,GAAA;EAA0B,UAAA,GAAA,CAAA,EEkBxB,QFlBwB;CAEtB,GEiBhB,MFjBgB,CEkBhB,WFlBgB,EEmBhB,gCFnBgB,CAAA,2DAAA,CAAA,CAAA;;;;;;AAaR,iBEcI,SFdJ,CAAA,kBEcgC,WFdC,CAAA,CAAA,SAAA,EEcuB,SFdvB,CAAA,EEcmC,GFdnC,CEcuC,SFdvC,CAAA;;;;;;;ADrB7C;AAQY,KIVA,iBJUA,CAAA,MAAA,CAAA,GAAA,CIV6B,MJUQ,CAAA,SAAA,CAAA,OAAA,CAAA,GIVoB,MJUpB,GAAA,KAAA;;;;;;KIHrC,2DACE,YAAY,QAAQ,cAAc,SAAS,KHHzD,CAAA,MGIQ,OHJI,CAAA;;;;;;;AAOR,KGKQ,YHLR,CAAA,iBAAA,MAAA,EAAA,iBAAA,MAAA,CAAA,GGKyE,iBHLzE,CGMF,OHNE,CGMM,QHNN,CAAA,SAAA,IAAA,GGOE,QHPF,GAAA,iBAAK,MGSoB,QHTpB,GAAA,MGSqC,QHTrC,GGSgD,CHThD,SAAA,MGSgE,QHThE,GGUG,QHVH,CGUY,CHVZ,CAAA,GGWG,CHXH,SAAA,MGWmB,QHXnB,GGYK,QHZL,CGYc,CHZd,CAAA,GAAA,KAAA,EAWT,CAAA;;;;;AAKA;AAWY,KGLA,OHKA,CAAa,MAAA,CAAA,GAAA,CGLM,MHKN,CAAA,SAAA,CAAA,KAAA,CAAA,GAAA,IAAA,GAAA,KAAA;;;;;;AAMrB,KGJQ,QHIR,CAAA,gBAAA,MAAA,CAAA,GGJ2C,iBHI3C,CAAA,QAAK,MGHO,OHGP,GGHiB,OHGjB,CGHyB,CHGzB,CAAA;;;;;AD3CT;AAQA;;;;AAAwF,KKL5E,iBLK4E,CAAA,kBKJpE,WLIoE,EAAA,mBAAA,MKH7D,SLG6D,CAAA,SAAA,CAAA,CAAA,QAAA,CAAA,GAAA,MAAA,EAAA,oBAAA,MKF5D,SLE4D,CAAA,SAAA,CAAA,CAAA,QAAA,CAAA,CKF7B,ULE6B,CAAA,CAAA,SAAA,CAAA,GAAA,MAAA,EAAA,WKD3E,SLC2E,CAAA,SAAA,CAAA,CAAA,QAAA,CAAA,CKD5C,ULC4C,CAAA,CAAA,SAAA,CAAA,CKDrB,WLCqB,CAAA,CAAA,GKApF,QLAoF,SKAnE,aLAmE,GAAA,CKE/E,QLF+E,CAAA,UAAA,CAAA,SAAA,IAAA,GAAA,IAAA,GAAA,KAAA,CAAA,GKGhF,SLHgF,CAAA,UAAA,CAAA,CAAA,YAAA,CAAA,CKG5C,QLH4C,CAAA,SAAA,CAAA,CAAA,CAAA,QAAA,CAAA,GAAA,KAAA;;;;ACLxF;AAGgB,KIYJ,SAAA,GAAY,MJZR,CAAA,MAAA,EIYuB,cJZvB,CAAA,OAAA,EAAA,OAAA,CAAA,CAAA;;;;;;;AAIP,UIgBQ,cJhBR,CAAA,OAAA,EAAA,kBAAA,MAAA,GAAA,OAAA,GAAA,OAAA,CAAA,CAAA;EAWG,SAAA,WAAA,EIMY,SJNZ;EAAmD,SAAA,SAAA,EIOzC,OJPyC;;;;AAK/D;AAWA;;;AAKqB,KILT,gBJKS,CAAA,kBIJD,WJIC,EAAA,mBAAA,MIHM,SJGN,CAAA,SAAA,CAAA,CAAA,QAAA,CAAA,GAAA,MAAA,CAAA,GIFjB,iBJEiB,CAAA,0BAGhB,MIJ2B,SJI3B,CAAA,SAAA,CAAA,CAAA,QAAA,CAAA,CIJ0D,UJI1D,CAAA,CAAA,SAAA,CAAA,GAAA,MAAA,GIHQ,cJGR,CIFD,iBJEC,CIFiB,SJEjB,EIF4B,UJE5B,EIFwC,UJExC,CAAA,EIDD,SJCC,CAAA,SAAA,CAAA,CAAA,QAAA,CAAA,CID8B,UJC9B,CAAA,CAAA,SAAA,CAAA,CIDqD,UJCrD,CAAA,CAAA,YAAA,CAAA,CAAA,EAAc,CAAA;;;ADrCnB;;;;;;;cMFa,gCACO,6BACF,qDACG;ELNT,CAAA,OAAA;EAGI,WAAA,CAAA,QAAA,EKSQ,SLTR;EAA0B,MAAA,CAAA,QAAA,EKc5B,QLd4B,CAAA,EKerC,kBLfqC,CKelB,OLfkB,CAAA,SAAA,IAAA,GKgBpC,aLhBoC,CKiBlC,SLjBkC,EKkBlC,OLlBkC,EKmBlC,YLnBkC,CKmBrB,ULnBqB,EKmBT,gBLnBS,CKmBQ,SLnBR,EAAA,MKmByB,OLnBzB,GAAA,MAAA,CAAA,CAAA,CAAA,GKqBpC,qCLrBoC,CAAA,2GAAA,CAAA;EAEtB,MAAA,CAAA,mBAAA,MKoBc,OLpBd,GAAA,MAAA,CAAA,CAAA,QAAA,EKqBN,aLrBM,CKqBQ,ULrBR,EKqBoB,SLrBpB,CAAA,aAAA,CAAA,CAAA,CAAA,EKsBf,aLtBe,CKuBhB,SLvBgB,EKwBhB,OLxBgB,EKyBhB,YLzBgB,CKyBH,ULzBG,EKyBS,gBLzBT,CKyB0B,SLzB1B,EKyBqC,ULzBrC,CAAA,CAAA,CAAA;EACC,MAAA,CAAA,GAAA,EAAA,KAAA,CAAA,EK4BhB,qCL5BgB,CAAA,mDAAA,CAAA;EAGhB,KAAA,CAAA,CAAA,EKiCM,OLjCN,CKiCc,ULjCd,CAAA,SAAA,IAAA,GAAA,KAAA,GKoCC,QLpCD,CKoCU,ULpCV,CAAA;;;;ADZL;AAQA;;;;AAAwF,cOL3E,IPK2E,CAAA,kBOLpD,WPKoD,CAAA,CAAA;;wBOFhE;;ANHxB;;;;EAMqB,IAAA,CAAA,KAAA,EMOV,cNPU,CAAA,KAAA,CAAA,CAAA,EMQhB,qCNRgB,CAAA,mGAAA,CAAA;EAGhB;;;EAFI,IAAA,CAAA,cAAA,MAAA,CAAA,CAAA,KAAA,EAAA,MAAA,SMYiB,KNZjB,GMaD,0BNbC,CAAA,qFAAA,CAAA,GMcD,cNdC,CMcc,KNdd,EMcqB,SNdrB,CAAA,aAAA,CAAA,CAAA,CAAA,EMeJ,KNfI,SAAA,MAAA,GMgBH,aNhBG,CMgBW,SNhBX,EMgBsB,INhBtB,CMgB2B,SNhB3B,CAAA,SAAA,CAAA,CAAA,QAAA,CAAA,EMgB2D,KNhB3D,CAAA,CAAA,GMiBH,qCNjBG,CAAA,mGAAA,CAAA;EAWG,IAAA,CAAA,KAAA,EMQD,0BNRkC,CAAA,qFAAA,CAAA,CAAA,EMSxC,qCNTwC,CAAA,mGAAA,CAAA;;;;;AAKjC,iBMiBI,UAAA,CNdP,QAAA,EAAA,KAAA,CAAA,EMgBN,qCNhBM,CAAA,sGAAA,CAAA;AAQT;;;AAKqB,iBMOL,UNPK,CAAA,kBMOwB,WNPxB,CAAA,CAAA,QAAA,EMO+C,SNP/C,CAAA,EMO2D,INP3D,CMOgE,SNPhE,CAAA"}

package/dist/index.mjs

@@ -1 +1,73 @@
-export {  };
+//#region src/ref.ts
+/**
+* Creates a reference object for the given SQL contract.
+*
+* @template TContract The contract that describes the database.
+*/
+function createRef(_contract) {
+	return new Proxy({}, { get(_target, tableName) {
+		if (tableName === "*") return Object.freeze({
+			"~name": tableName,
+			"~table": null
+		});
+		return new Proxy({}, { get(_target$1, columnName) {
+			if (columnName === "~name") return tableName;
+			return Object.freeze({
+				"~name": columnName,
+				"~table": tableName
+			});
+		} });
+	} });
+}
+
+//#endregion
+//#region src/select-builder.ts
+/**
+* A builder for SQL `select` queries.
+*
+* @template TContract The contract that describes the database.
+* @template TTables The tables involved in the current `select` query.
+* @template TSelection The current selection of the `select` query.
+*/
+var SelectBuilder = class {
+	#contract;
+	constructor(contract) {
+		this.#contract = contract;
+	}
+	select(..._args) {
+		return this;
+	}
+	build() {
+		return {};
+	}
+};
+
+//#endregion
+//#region src/root.ts
+/**
+* The root of all builder.
+*
+* @template TContract The contract that describes the database.
+*/
+var Root = class {
+	#contract;
+	constructor(contract) {
+		this.#contract = contract;
+	}
+	/**
+	* @internal
+	*/
+	from(_table) {
+		return new SelectBuilder(this.#contract);
+	}
+};
+/**
+* @internal
+*/
+function createRoot(contract) {
+	return new Root(contract);
+}
+
+//#endregion
+export { createRef, createRoot };
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["#contract","#contract"],"sources":["../src/ref.ts","../src/select-builder.ts","../src/root.ts"],"sourcesContent":["import type { SqlContract } from '@prisma-next/sql-contract/types';\nimport type {\n  Asterisk,\n  ColumnReference,\n  ColumnReferenceOutOfContractError,\n  TableAsterisk,\n} from './column-reference';\nimport type { TableReference, TableReferenceOutOfContractError } from './table-reference';\n\n/**\n * A fluent API representing references to tables and columns in a SQL contract.\n *\n * @template TContract The contract that describes the database.\n */\nexport type Ref<TContract extends SqlContract> = {\n  readonly [TableName in keyof TContract['storage']['tables'] & string]: TableReference<\n    TableName,\n    TContract['storageHash']\n  > & {\n    readonly [ColumnName in Exclude<\n      keyof TContract['storage']['tables'][TableName]['columns'],\n      keyof TableReference\n    > &\n      string]: ColumnReference<ColumnName, TableName, TContract['storageHash']>;\n  } & {\n    readonly ['*']: TableAsterisk<TableName, TContract['storageHash']>;\n  } & Record<\n      PropertyKey,\n      ColumnReferenceOutOfContractError<`[error] reference to a non-existing column in the '${TableName}' table`>\n    >;\n} & {\n  readonly ['*']: Asterisk;\n} & Record<\n    PropertyKey,\n    TableReferenceOutOfContractError<`[error] reference to a non-existing table in the contract`>\n  >;\n\n/**\n * Creates a reference object for the given SQL contract.\n *\n * @template TContract The contract that describes the database.\n */\nexport function createRef<TContract extends SqlContract>(_contract: TContract): Ref<TContract> {\n  return new Proxy({} as Ref<TContract>, {\n    get(_target, tableName) {\n      if (tableName === '*') {\n        return Object.freeze({\n          '~name': tableName,\n          '~table': null,\n        });\n      }\n\n      return new Proxy(\n        {},\n        {\n          get(_target, columnName) {\n            if (columnName === '~name') {\n              return tableName;\n            }\n\n            return Object.freeze({\n              '~name': columnName,\n              '~table': tableName,\n            });\n          },\n        },\n      );\n    },\n  });\n}\n","import type { SqlContract } from '@prisma-next/sql-contract/types';\nimport type { Asterisk, TableAsterisk } from './column-reference';\nimport type { Selection, TableToSelection } from './selection';\nimport type { ExactlyOneProperty, IsNever, MergeObjects, Simplify } from './type-atoms';\nimport type { PreviousFunctionReceivedBadInputError } from './type-errors';\n\n/**\n * A builder for SQL `select` queries.\n *\n * @template TContract The contract that describes the database.\n * @template TTables The tables involved in the current `select` query.\n * @template TSelection The current selection of the `select` query.\n */\nexport class SelectBuilder<\n  TContract extends SqlContract,\n  TTables extends SqlContract['storage']['tables'],\n  TSelection extends Selection = never,\n> {\n  // @ts-expect-error\n  // biome-ignore lint/correctness/noUnusedPrivateClassMembers: will be used soon.\n  readonly #contract: TContract;\n\n  constructor(contract: TContract) {\n    this.#contract = contract;\n  }\n\n  select(\n    asterisk: Asterisk,\n  ): ExactlyOneProperty<TTables> extends true\n    ? SelectBuilder<\n        TContract,\n        TTables,\n        MergeObjects<TSelection, TableToSelection<TContract, keyof TTables & string>>\n      >\n    : PreviousFunctionReceivedBadInputError<'[error] selecting all columns via `*` results in ambiguity when multiple tables are involved in the query'>;\n  select<TTableName extends keyof TTables & string>(\n    asterisk: TableAsterisk<TTableName, TContract['storageHash']>,\n  ): SelectBuilder<\n    TContract,\n    TTables,\n    MergeObjects<TSelection, TableToSelection<TContract, TTableName>>\n  >;\n  select(\n    arg: never,\n  ): PreviousFunctionReceivedBadInputError<'[error] invalid input in previous `select()` call'>;\n  select(..._args: unknown[]): unknown {\n    // TODO: do runtime stuff.\n    return this;\n  }\n\n  // TODO: the return type here is not the real one we'll use eventually.\n  // I'm using something to test the selection stuff.\n  build(): IsNever<TSelection> extends true\n    ? // TODO: either split to two builders or provide a type-level error here.\n      never\n    : Simplify<TSelection> {\n    // TODO: do runtime stuff.\n    return {} as never;\n  }\n}\n","import type { SqlContract } from '@prisma-next/sql-contract/types';\nimport { SelectBuilder } from './select-builder';\nimport type { TableReference, TableReferenceTooWideError } from './table-reference';\nimport type { PreviousFunctionReceivedBadInputError } from './type-errors';\n\n/**\n * The root of all builder.\n *\n * @template TContract The contract that describes the database.\n */\nexport class Root<TContract extends SqlContract> {\n  readonly #contract: TContract;\n\n  constructor(contract: TContract) {\n    this.#contract = contract;\n  }\n\n  /**\n   * SQL's `from` clause, where all `select` queries actually start from.\n   *\n   * @param table The table to select from.\n   */\n  from(\n    table: TableReference<never>,\n  ): PreviousFunctionReceivedBadInputError<'[error] invalid table reference in previous `root.from()` call will probably cause runtime errors'>;\n  /**\n   * @template TName The name of the table to select from.\n   */\n  from<TName extends string>(\n    table: string extends TName\n      ? TableReferenceTooWideError<'[error] `root.from()` call received a table reference without a specific table name'>\n      : TableReference<TName, TContract['storageHash']>,\n  ): TName extends string\n    ? SelectBuilder<TContract, Pick<TContract['storage']['tables'], TName>>\n    : PreviousFunctionReceivedBadInputError<'[error] invalid table reference in previous `root.from()` call will probably cause runtime errors'>;\n  from(\n    table: TableReferenceTooWideError<'[error] `root.from()` call received a table reference without a specific table name'>,\n  ): PreviousFunctionReceivedBadInputError<'[error] invalid table reference in previous `root.from()` call will probably cause runtime errors'>;\n  /**\n   * @internal\n   */\n  from(_table: unknown): unknown {\n    // TODO: use runtime table reference value to do something \"AST\"-related.\n    return new SelectBuilder(this.#contract);\n  }\n}\n\n/**\n * Creates a new `Root` instance.\n */\nexport function createRoot(\n  contract: never,\n): PreviousFunctionReceivedBadInputError<'[error] root creation will likely fail at runtime given the passed contract is not valid or verified'>;\n/**\n * @template TContract The contract that describes the database.\n */\nexport function createRoot<TContract extends SqlContract>(contract: TContract): Root<TContract>;\n/**\n * @internal\n */\nexport function createRoot(contract: unknown): unknown {\n  return new Root(contract as SqlContract);\n}\n"],"mappings":";;;;;;AA0CA,SAAgB,UAAyC,WAAsC;AAC7F,QAAO,IAAI,MAAM,EAAE,EAAoB,EACrC,IAAI,SAAS,WAAW;AACtB,MAAI,cAAc,IAChB,QAAO,OAAO,OAAO;GACnB,SAAS;GACT,UAAU;GACX,CAAC;AAGJ,SAAO,IAAI,MACT,EAAE,EACF,EACE,IAAI,WAAS,YAAY;AACvB,OAAI,eAAe,QACjB,QAAO;AAGT,UAAO,OAAO,OAAO;IACnB,SAAS;IACT,UAAU;IACX,CAAC;KAEL,CACF;IAEJ,CAAC;;;;;;;;;;;;ACvDJ,IAAa,gBAAb,MAIE;CAGA,CAASA;CAET,YAAY,UAAqB;AAC/B,QAAKA,WAAY;;CAsBnB,OAAO,GAAG,OAA2B;AAEnC,SAAO;;CAKT,QAGyB;AAEvB,SAAO,EAAE;;;;;;;;;;;AC/Cb,IAAa,OAAb,MAAiD;CAC/C,CAASC;CAET,YAAY,UAAqB;AAC/B,QAAKA,WAAY;;;;;CA2BnB,KAAK,QAA0B;AAE7B,SAAO,IAAI,cAAc,MAAKA,SAAU;;;;;;AAiB5C,SAAgB,WAAW,UAA4B;AACrD,QAAO,IAAI,KAAK,SAAwB"}

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "@prisma-next/sql-lane-query-builder",
-  "version": "0.3.0-dev.34",
+  "version": "0.3.0-dev.37",
   "type": "module",
   "sideEffects": false,
   "description": "SQL query builder lane for Prisma Next",
   "devDependencies": {
     "tsdown": "0.18.4",
     "typescript": "5.9.3",
-    "vitest": "4.0.16",
+    "vitest": "4.0.17",
+    "@prisma-next/contract": "0.3.0-dev.37",
+    "@prisma-next/sql-contract": "0.3.0-dev.37",
     "@prisma-next/tsconfig": "0.0.0",
     "@prisma-next/tsdown": "0.0.0"
   },
@@ -25,10 +27,15 @@
   "main": "./dist/index.mjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.mts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/prisma/prisma-next.git",
+    "directory": "packages/2-sql/4-lanes/query-builder"
+  },
   "scripts": {
     "build": "tsdown",
     "test": "vitest run --passWithNoTests",
-    "test:coverage": "vitest run --coverage --passWithNoTests",
+    "~test:coverage": "vitest run --coverage --passWithNoTests",
     "typecheck": "tsc --noEmit",
     "lint": "biome check . --error-on-warnings",
     "lint:fix": "biome check --write .",

package/src/column-reference.ts

@@ -0,0 +1,54 @@
+import type { Brand, StorageHashBase } from '@prisma-next/contract/types';
+import type { ErrorMessage } from './type-errors';
+
+/**
+ * An object representing a reference to a column in a table in the database.
+ *
+ * @template TColumnName The name of the column.
+ * @template TTableName The name of the table this column belongs to.
+ * @template THash The contract storage hash belonging to the database this column is in.
+ */
+export type ColumnReference<
+  TColumnName extends string = string,
+  TTableName extends string = string,
+  THash extends StorageHashBase<string> = StorageHashBase<string>,
+> = {
+  readonly '~name': TColumnName;
+  readonly '~table': TTableName;
+} & Brand<
+  '[info] this column reference belongs to the following table reference:',
+  `${TTableName}@${THash}`
+>;
+
+/**
+ * An error type indicating that the provided column reference is out of the contract's scope.
+ * To be used in reference creators, e.g. `createRef()`.
+ *
+ * @template TMessage The error message.
+ */
+export type ColumnReferenceOutOfContractError<TMessage extends ErrorMessage> = Brand<TMessage>;
+
+/**
+ * A type representing a reference to all columns in the current query context.
+ */
+export type Asterisk = {
+  readonly '~name': '*';
+  readonly '~table': null;
+} & Brand<'[info] referencing all columns in the current query context'>;
+
+/**
+ * A type representing a reference to all columns in a specific table.
+ *
+ * @template TTableName The name of the table whose columns are being referenced.
+ * @template THash The contract storage hash belonging to the database this column is in.
+ */
+export type TableAsterisk<
+  TTableName extends string = string,
+  THash extends StorageHashBase<string> = StorageHashBase<string>,
+> = {
+  readonly '~name': '*';
+  readonly '~table': TTableName;
+} & Brand<
+  '[info] referencing all columns that belong to the following table reference:',
+  `${TTableName}@${THash}`
+>;

package/src/index.ts

@@ -1,2 +1,34 @@
-// SQL query builder lane for Prisma Next
-// This package will contain query builder utilities
+export type {
+  Asterisk,
+  ColumnReference,
+  ColumnReferenceOutOfContractError,
+  TableAsterisk,
+} from './column-reference';
+export {
+  createRef,
+  type Ref,
+} from './ref';
+export { createRoot, type Root } from './root';
+export type { SelectBuilder } from './select-builder';
+export type {
+  ExtractOutputType,
+  Selection,
+  SelectionValue,
+  TableToSelection,
+} from './selection';
+export type {
+  TableReference,
+  TableReferenceOutOfContractError,
+  TableReferenceTooWideError,
+} from './table-reference';
+export type {
+  DrainOuterGeneric,
+  ExactlyOneProperty,
+  IsNever,
+  MergeObjects,
+  Simplify,
+} from './type-atoms';
+export type {
+  ErrorMessage,
+  PreviousFunctionReceivedBadInputError,
+} from './type-errors';

package/src/ref.ts

@@ -0,0 +1,70 @@
+import type { SqlContract } from '@prisma-next/sql-contract/types';
+import type {
+  Asterisk,
+  ColumnReference,
+  ColumnReferenceOutOfContractError,
+  TableAsterisk,
+} from './column-reference';
+import type { TableReference, TableReferenceOutOfContractError } from './table-reference';
+
+/**
+ * A fluent API representing references to tables and columns in a SQL contract.
+ *
+ * @template TContract The contract that describes the database.
+ */
+export type Ref<TContract extends SqlContract> = {
+  readonly [TableName in keyof TContract['storage']['tables'] & string]: TableReference<
+    TableName,
+    TContract['storageHash']
+  > & {
+    readonly [ColumnName in Exclude<
+      keyof TContract['storage']['tables'][TableName]['columns'],
+      keyof TableReference
+    > &
+      string]: ColumnReference<ColumnName, TableName, TContract['storageHash']>;
+  } & {
+    readonly ['*']: TableAsterisk<TableName, TContract['storageHash']>;
+  } & Record<
+      PropertyKey,
+      ColumnReferenceOutOfContractError<`[error] reference to a non-existing column in the '${TableName}' table`>
+    >;
+} & {
+  readonly ['*']: Asterisk;
+} & Record<
+    PropertyKey,
+    TableReferenceOutOfContractError<`[error] reference to a non-existing table in the contract`>
+  >;
+
+/**
+ * Creates a reference object for the given SQL contract.
+ *
+ * @template TContract The contract that describes the database.
+ */
+export function createRef<TContract extends SqlContract>(_contract: TContract): Ref<TContract> {
+  return new Proxy({} as Ref<TContract>, {
+    get(_target, tableName) {
+      if (tableName === '*') {
+        return Object.freeze({
+          '~name': tableName,
+          '~table': null,
+        });
+      }
+
+      return new Proxy(
+        {},
+        {
+          get(_target, columnName) {
+            if (columnName === '~name') {
+              return tableName;
+            }
+
+            return Object.freeze({
+              '~name': columnName,
+              '~table': tableName,
+            });
+          },
+        },
+      );
+    },
+  });
+}

package/src/root.ts

@@ -0,0 +1,63 @@
+import type { SqlContract } from '@prisma-next/sql-contract/types';
+import { SelectBuilder } from './select-builder';
+import type { TableReference, TableReferenceTooWideError } from './table-reference';
+import type { PreviousFunctionReceivedBadInputError } from './type-errors';
+
+/**
+ * The root of all builder.
+ *
+ * @template TContract The contract that describes the database.
+ */
+export class Root<TContract extends SqlContract> {
+  readonly #contract: TContract;
+
+  constructor(contract: TContract) {
+    this.#contract = contract;
+  }
+
+  /**
+   * SQL's `from` clause, where all `select` queries actually start from.
+   *
+   * @param table The table to select from.
+   */
+  from(
+    table: TableReference<never>,
+  ): PreviousFunctionReceivedBadInputError<'[error] invalid table reference in previous `root.from()` call will probably cause runtime errors'>;
+  /**
+   * @template TName The name of the table to select from.
+   */
+  from<TName extends string>(
+    table: string extends TName
+      ? TableReferenceTooWideError<'[error] `root.from()` call received a table reference without a specific table name'>
+      : TableReference<TName, TContract['storageHash']>,
+  ): TName extends string
+    ? SelectBuilder<TContract, Pick<TContract['storage']['tables'], TName>>
+    : PreviousFunctionReceivedBadInputError<'[error] invalid table reference in previous `root.from()` call will probably cause runtime errors'>;
+  from(
+    table: TableReferenceTooWideError<'[error] `root.from()` call received a table reference without a specific table name'>,
+  ): PreviousFunctionReceivedBadInputError<'[error] invalid table reference in previous `root.from()` call will probably cause runtime errors'>;
+  /**
+   * @internal
+   */
+  from(_table: unknown): unknown {
+    // TODO: use runtime table reference value to do something "AST"-related.
+    return new SelectBuilder(this.#contract);
+  }
+}
+
+/**
+ * Creates a new `Root` instance.
+ */
+export function createRoot(
+  contract: never,
+): PreviousFunctionReceivedBadInputError<'[error] root creation will likely fail at runtime given the passed contract is not valid or verified'>;
+/**
+ * @template TContract The contract that describes the database.
+ */
+export function createRoot<TContract extends SqlContract>(contract: TContract): Root<TContract>;
+/**
+ * @internal
+ */
+export function createRoot(contract: unknown): unknown {
+  return new Root(contract as SqlContract);
+}

package/src/select-builder.ts

@@ -0,0 +1,60 @@
+import type { SqlContract } from '@prisma-next/sql-contract/types';
+import type { Asterisk, TableAsterisk } from './column-reference';
+import type { Selection, TableToSelection } from './selection';
+import type { ExactlyOneProperty, IsNever, MergeObjects, Simplify } from './type-atoms';
+import type { PreviousFunctionReceivedBadInputError } from './type-errors';
+
+/**
+ * A builder for SQL `select` queries.
+ *
+ * @template TContract The contract that describes the database.
+ * @template TTables The tables involved in the current `select` query.
+ * @template TSelection The current selection of the `select` query.
+ */
+export class SelectBuilder<
+  TContract extends SqlContract,
+  TTables extends SqlContract['storage']['tables'],
+  TSelection extends Selection = never,
+> {
+  // @ts-expect-error
+  // biome-ignore lint/correctness/noUnusedPrivateClassMembers: will be used soon.
+  readonly #contract: TContract;
+
+  constructor(contract: TContract) {
+    this.#contract = contract;
+  }
+
+  select(
+    asterisk: Asterisk,
+  ): ExactlyOneProperty<TTables> extends true
+    ? SelectBuilder<
+        TContract,
+        TTables,
+        MergeObjects<TSelection, TableToSelection<TContract, keyof TTables & string>>
+      >
+    : PreviousFunctionReceivedBadInputError<'[error] selecting all columns via `*` results in ambiguity when multiple tables are involved in the query'>;
+  select<TTableName extends keyof TTables & string>(
+    asterisk: TableAsterisk<TTableName, TContract['storageHash']>,
+  ): SelectBuilder<
+    TContract,
+    TTables,
+    MergeObjects<TSelection, TableToSelection<TContract, TTableName>>
+  >;
+  select(
+    arg: never,
+  ): PreviousFunctionReceivedBadInputError<'[error] invalid input in previous `select()` call'>;
+  select(..._args: unknown[]): unknown {
+    // TODO: do runtime stuff.
+    return this;
+  }
+
+  // TODO: the return type here is not the real one we'll use eventually.
+  // I'm using something to test the selection stuff.
+  build(): IsNever<TSelection> extends true
+    ? // TODO: either split to two builders or provide a type-level error here.
+      never
+    : Simplify<TSelection> {
+    // TODO: do runtime stuff.
+    return {} as never;
+  }
+}

package/src/selection.ts

@@ -0,0 +1,54 @@
+import type { SqlContract, StorageColumn } from '@prisma-next/sql-contract/types';
+import type { DrainOuterGeneric } from './type-atoms';
+
+/**
+ * A utility type to extract the output type of a referenced column from a contract.
+ *
+ * @template TContract The contract that describes the database.
+ * @template TTableName The name of the table containing the column.
+ * @template TColumnName The name of the column whose output type is to be extracted.
+ */
+export type ExtractOutputType<
+  TContract extends SqlContract,
+  TTableName extends keyof TContract['storage']['tables'] & string,
+  TColumnName extends keyof TContract['storage']['tables'][TTableName]['columns'] & string,
+  _TColumn = TContract['storage']['tables'][TTableName]['columns'][TColumnName],
+> = _TColumn extends StorageColumn
+  ?
+      | (_TColumn['nullable'] extends true ? null : never)
+      | TContract['mappings']['codecTypes'][_TColumn['codecId']]['output']
+  : never;
+
+/**
+ * A type representing a selection of columns in a SQL `select` query in the
+ * most generic form.
+ */
+export type Selection = Record<string, SelectionValue<unknown, unknown>>;
+
+/**
+ * A type representing the value of a selected column in a SQL `select` query.
+ *
+ * @template TOutput The output type of the selected column.
+ * @template TDatatype The database-side datatype of the selected column.
+ */
+export interface SelectionValue<TOutput, TDatatype extends string | unknown = unknown> {
+  readonly '~datatype': TDatatype;
+  readonly '~output': TOutput;
+}
+
+/**
+ * A utility type to convert a table's columns into a {@link Selection}.
+ *
+ * @template TContract The contract that describes the database.
+ * @template TTableName The name of the table whose columns will be included in the selection.
+ */
+export type TableToSelection<
+  TContract extends SqlContract,
+  TTableName extends keyof TContract['storage']['tables'] & string,
+> = DrainOuterGeneric<{
+  readonly [ColumnName in keyof TContract['storage']['tables'][TTableName]['columns'] &
+    string]: SelectionValue<
+    ExtractOutputType<TContract, TTableName, ColumnName>,
+    TContract['storage']['tables'][TTableName]['columns'][ColumnName]['nativeType']
+  >;
+}>;

package/src/table-reference.ts

@@ -0,0 +1,34 @@
+import type { Brand, StorageHashBase } from '@prisma-next/contract/types';
+import type { ErrorMessage } from './type-errors';
+
+/**
+ * An object representing a reference to a table in the database.
+ *
+ * @template TName The name of the table. `string` is all tables, a union of string literals is a set of specific tables, a single string literal is a specific table.
+ * @template THash The contract storage hash belonging to the database this table is in.
+ */
+export type TableReference<
+  TName extends string = string,
+  THash extends StorageHashBase<string> = StorageHashBase<string>,
+> = {
+  readonly '~name': TName;
+} & Brand<
+  '[info] this table reference belongs to the contract with the following storage hash:',
+  THash
+>;
+
+/**
+ * An error type indicating that the provided table reference is out of the contract's scope.
+ * To be used in reference creators, e.g. `createRef()`.
+ *
+ * @template TMessage The error message.
+ */
+export type TableReferenceOutOfContractError<TMessage extends ErrorMessage> = Brand<TMessage>;
+
+/**
+ * An error type indicating that the provided table reference is too wide.
+ * To be used as a `never` alternative in conditional types.
+ *
+ * @template TMessage The error message.
+ */
+export type TableReferenceTooWideError<TMessage extends ErrorMessage> = Brand<TMessage>;

package/src/type-atoms.ts

@@ -0,0 +1,49 @@
+/**
+ * A utility type to drain outer generics from a type. A compiler micro-optimization.
+ *
+ * @template TThing The type to drain.
+ */
+export type DrainOuterGeneric<TThing> = [TThing] extends [unknown] ? TThing : never;
+
+/**
+ * A utility type to ensure that exactly one property of an object type is present.
+ *
+ * @template TObject The object type to check.
+ */
+export type ExactlyOneProperty<TObject extends object> = {
+  [K in keyof TObject]-?: IsNever<Exclude<keyof TObject, K>>;
+}[keyof TObject];
+
+/**
+ * A utility type to merge two objects.
+ *
+ * @template TObject0 The first object.
+ * @template TObject1 The second object.
+ */
+export type MergeObjects<TObject0 extends object, TObject1 extends object> = DrainOuterGeneric<
+  IsNever<TObject0> extends true
+    ? TObject1
+    : {
+        readonly [K in keyof TObject0 | keyof TObject1]: K extends keyof TObject1
+          ? TObject1[K]
+          : K extends keyof TObject0
+            ? TObject0[K]
+            : never;
+      }
+>;
+
+/**
+ * A utility type to determine if a type is `never`.
+ *
+ * @template TThing The type to check.
+ */
+export type IsNever<TThing> = [TThing] extends [never] ? true : false;
+
+/**
+ * A utility type to simplify an object type for better readability.
+ *
+ * @template TObject The object type to simplify.
+ */
+export type Simplify<TObject extends object> = DrainOuterGeneric<
+  { [K in keyof TObject]: TObject[K] } & {}
+>;

package/src/type-errors.ts

@@ -0,0 +1,16 @@
+import type { Brand } from '@prisma-next/contract/types';
+
+/**
+ * An error message type, prefixed with `[error]`.
+ *
+ * @template TMessage The error message.
+ */
+export type ErrorMessage = `[error] ${string}`;
+
+/**
+ * An error type indicating that the previous function call had bad input.
+ * To be used as a return type.
+ *
+ * @template TMessage The error message.
+ */
+export type PreviousFunctionReceivedBadInputError<TMessage extends ErrorMessage> = Brand<TMessage>;