@microsoft/rayfin-data 1.32.0 → 1.33.0-beta.1

package/dist/client/DataApi.d.ts

@@ -12,7 +12,7 @@ export type TypedDataClients<TSchema extends EntitySchema> = {
  *
  * Use the `createDataApi` factory function to create instances instead of instantiating directly.
  *
- * @template TSchema - Object type mapping entity names to their types
+ * @typeParam TSchema - Object type mapping entity names to their types
  */
 export declare class DataApi<TSchema extends EntitySchema = Record<string, any>> {
     private apiClient;
@@ -35,7 +35,7 @@ export declare class DataApi<TSchema extends EntitySchema = Record<string, any>>
 /**
  * Create a type-safe DataApi instance for interacting with Data API Builder GraphQL endpoints.
  *
- * @template TSchema - Object type mapping entity names to their types
+ * @typeParam TSchema - Object type mapping entity names to their types
  * @param apiClient - The ApiClient instance for making HTTP requests
  * @returns A fully typed DataApi instance with direct entity access
  *

package/dist/client/DataApi.js

@@ -5,7 +5,7 @@ import { GraphQLEntityClient } from '../graphql/GraphQLEntityClient.js';
  *
  * Use the `createDataApi` factory function to create instances instead of instantiating directly.
  *
- * @template TSchema - Object type mapping entity names to their types
+ * @typeParam TSchema - Object type mapping entity names to their types
  */
 export class DataApi {
     apiClient;
@@ -78,7 +78,7 @@ export class DataApi {
 /**
  * Create a type-safe DataApi instance for interacting with Data API Builder GraphQL endpoints.
  *
- * @template TSchema - Object type mapping entity names to their types
+ * @typeParam TSchema - Object type mapping entity names to their types
  * @param apiClient - The ApiClient instance for making HTTP requests
  * @returns A fully typed DataApi instance with direct entity access
  *

package/dist/graphql/GraphQLEntityClient.d.ts

@@ -39,7 +39,7 @@ export declare class GraphQLEntityClient<TSchema extends EntitySchema, TEntity e
     private extractMutationResult;
     /**
      * Transforms flat FK fields (e.g. category_id) in mutation responses back into
-     * nested relationship objects (e.g. category: { id: "..." }) based on the
+     * nested relationship objects (e.g. `category: { id: "..." }`) based on the
      * relationship keys present in the original input.
      */
     private nestRelationshipFields;

package/dist/graphql/GraphQLEntityClient.js

@@ -237,7 +237,7 @@ export class GraphQLEntityClient {
     }
     /**
      * Transforms flat FK fields (e.g. category_id) in mutation responses back into
-     * nested relationship objects (e.g. category: { id: "..." }) based on the
+     * nested relationship objects (e.g. `category: { id: "..." }`) based on the
      * relationship keys present in the original input.
      */
     nestRelationshipFields(responseData, inputData) {

package/dist/graphql/GraphQLQueryBuilder.d.ts

@@ -3,8 +3,8 @@ import type { EntitySchema, FilterInput, OrderByInput, PagedResult, FieldSelecti
 /**
  * Fluent GraphQL query builder for constructing and executing complex queries.
  *
- * @template TSchema The entity schema type
- * @template TEntity The specific entity name
+ * @typeParam TSchema - The entity schema type
+ * @typeParam TEntity - The specific entity name
  */
 export declare class GraphQLQueryBuilder<TSchema extends EntitySchema, TEntity extends keyof TSchema> {
     private graphqlClient;

package/dist/graphql/GraphQLQueryBuilder.js

@@ -5,8 +5,8 @@ import { formatGraphQLValue } from './formatValue.js';
 /**
  * Fluent GraphQL query builder for constructing and executing complex queries.
  *
- * @template TSchema The entity schema type
- * @template TEntity The specific entity name
+ * @typeParam TSchema - The entity schema type
+ * @typeParam TEntity - The specific entity name
  */
 export class GraphQLQueryBuilder {
     graphqlClient;

package/dist/graphql/types.d.ts

@@ -120,7 +120,7 @@ export type OrderByInput<T> = {
     [K in keyof T]?: 'asc' | 'desc';
 };
 /**
- * Extracts the primary key field from an entity using the centralized {@link PrimaryKeyField} type.
+ * Extracts the primary key field from an entity using the centralized `PrimaryKeyField` type.
  *
  * @see {@link RelationshipInput} for usage in mutation input types
  */
@@ -157,7 +157,7 @@ export type RelationshipInput<T> = T | PrimaryKeyOnly<T>;
  * Detects if a type is a relationship (object with a primary key that's not a primitive wrapper).
  *
  * @remarks
- * A relationship is detected as an object type that has a {@link PrimaryKeyField} property,
+ * A relationship is detected as an object type that has a `PrimaryKeyField` property,
  * but is not a Date or Array (which are object types but not relationships).
  */
 export type IsRelationship<T> = PrimaryKeyField extends keyof T ? T extends Date | Array<any> ? false : true : false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/rayfin-data",
-  "version": "1.32.0",
+  "version": "1.33.0-beta.1",
   "description": "Type-safe client library for Data API Builder endpoints",
   "type": "module",
   "main": "./dist/index.js",
@@ -13,8 +13,8 @@
     "assets/docs"
   ],
   "dependencies": {
-    "@microsoft/rayfin-lib": "1.32.0",
-    "@microsoft/rayfin-core": "1.32.0"
+    "@microsoft/rayfin-lib": "1.33.0-beta.1",
+    "@microsoft/rayfin-core": "1.33.0-beta.1"
   },
   "devDependencies": {
     "@types/node": "^20.0.0",