@nkzw/fate 0.0.5 → 0.0.6

package/README.md

@@ -766,7 +766,7 @@ Since clients can send arbitrary selection objects to the server, we need to imp
 Create a `views.ts` file next to your root tRPC router that exports the data views for each type. Here is how you can define a `User` data view for Prisma's `User` model:
 
 ```tsx
-import { dataView, DataViewResult } from '@nkzw/fate/server';
+import { dataView, type Entity } from '@nkzw/fate/server';
 import type { User as PrismaUser } from '../prisma/prisma-client/client.ts';
 
 export const userDataView = dataView<PrismaUser>('User')({
@@ -775,9 +775,7 @@ export const userDataView = dataView<PrismaUser>('User')({
   username: true,
 });
 
-export type User = DataViewResult<typeof userDataView> & {
-  __typename: 'User';
-};
+export type User = Entity<typeof userDataView, 'User'>;
 ```
 
 _Note: Currently, fate provides helpers to integrate with Prisma, but the framework is not coupled to any particular ORM or database. We hope to provide more direct integrations in the future, and are always open to contributions._

package/lib/server.d.mts

@@ -51,7 +51,7 @@ type DataViewConfig<Item$1 extends AnyRecord, Context> = Record<string, DataFiel
  *   title: true,
  * });
  */
-declare function dataView<Item$1 extends AnyRecord, Context = unknown>(typeName?: string): <Fields extends DataViewConfig<Item$1, Context>>(fields: Fields) => DataView<Item$1, Context> & {
+declare function dataView<Item$1 extends AnyRecord, Context = unknown>(typeName: string): <Fields extends DataViewConfig<Item$1, Context>>(fields: Fields) => DataView<Item$1, Context> & {
   readonly [dataViewFieldsKey]: Fields;
 };
 /**
@@ -80,10 +80,14 @@ type ViewFieldConfig<V extends DataView<AnyRecord, unknown>> = V extends {
 } ? Fields : V['fields'];
 type RawFieldResult<Item$1 extends AnyRecord, Key extends PropertyKey, Field extends DataField<Item$1, unknown>> = Field extends true ? Key extends keyof Item$1 ? Item$1[Key] : never : Field extends DataView<infer ChildItem, unknown> ? Key extends keyof Item$1 ? RelationResult<Item$1[Key], DataView<ChildItem, unknown>> : never : Field extends ResolverField<Item$1, unknown> ? ResolverResult<Field> : never;
 type RawDataViewResult<V extends DataView<AnyRecord, unknown>> = V extends DataView<infer Item, unknown> ? { [K in keyof ViewFieldConfig<V>]: RawFieldResult<Item, K, ViewFieldConfig<V>[K]> } : never;
+type DataViewResult<V extends DataView<AnyRecord, unknown>> = Serializable<RawDataViewResult<V>>;
+type WithTypename<T, Name extends string> = T & {
+  __typename: Name;
+};
 /**
- * Resolved and serialized shape returned from a data view.
+ * Resolved entity type from a data view for client use.
  */
-type DataViewResult<V extends DataView<AnyRecord, unknown>> = Serializable<RawDataViewResult<V>>;
+type Entity<TView extends DataView<AnyRecord, unknown>, Name extends string, Replacements extends Record<string, unknown> = Record<string, never>> = WithTypename<Omit<DataViewResult<TView>, keyof Replacements> & Replacements, Name>;
 /**
  * Builds a resolver that applies a client's selection to a server data view,
  * filtering fields, running nested resolvers, and shaping selects.
@@ -160,4 +164,4 @@ declare const withConnection: <TContext>(procedure: ProcedureLike<TContext>) =>
   query: QueryFn<TContext, TItem, ConnectionInputWithAdditional<TAdditionalInput>>;
 }) => ReturnType<ReturnType<ProcedureLike<TContext>["input"]>["query"]>;
 //#endregion
-export { type DataViewResult, connectionArgs, createResolver, dataView, list, resolver, withConnection };
+export { type Entity, connectionArgs, createResolver, dataView, list, resolver, withConnection };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nkzw/fate",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "fate is a modern data client for React.",
   "homepage": "https://github.com/nkzw-tech/fate",
   "repository": {