@isograph/react 0.0.0-main-c89c61e8 → 0.0.0-main-0eb53a17

package/src/react/FragmentReader.tsx

@@ -1,3 +1,4 @@
+import * as React from 'react';
 import {
   type ExtractReadFromStore,
   type IsographEntrypoint,
@@ -6,22 +7,40 @@ import { type FragmentReference } from '../core/FragmentReference';
 import { type NetworkRequestReaderOptions } from '../core/read';
 import { useResult } from './useResult';
 
+export type IsExactlyIntrinsicAttributes<T> = T extends JSX.IntrinsicAttributes
+  ? JSX.IntrinsicAttributes extends T
+    ? true
+    : false
+  : false;
+
 export function FragmentReader<
-  TResult,
-  TEntrypoint extends IsographEntrypoint<any, TResult, any>,
-  TChildrenResult,
->({
-  fragmentReference,
-  networkRequestOptions,
-  children,
-}: {
-  fragmentReference: FragmentReference<
-    ExtractReadFromStore<TEntrypoint>,
-    TResult
-  >;
-  networkRequestOptions?: Partial<NetworkRequestReaderOptions>;
-  children: (data: TResult) => TChildrenResult;
-}): TChildrenResult {
-  const result = useResult(fragmentReference, networkRequestOptions);
-  return children(result);
+  TProps extends Record<any, any>,
+  TEntrypoint extends IsographEntrypoint<any, React.FC<TProps>, any>,
+>(
+  props: IsExactlyIntrinsicAttributes<TProps> extends true
+    ? {
+        fragmentReference: FragmentReference<
+          ExtractReadFromStore<TEntrypoint>,
+          React.FC<TProps>
+        >;
+        additionalProps?: Record<PropertyKey, never>;
+        networkRequestOptions?: Partial<NetworkRequestReaderOptions>;
+      }
+    : {
+        fragmentReference: FragmentReference<
+          ExtractReadFromStore<TEntrypoint>,
+          React.FC<TProps>
+        >;
+        additionalProps: Omit<TProps, keyof JSX.IntrinsicAttributes>;
+        networkRequestOptions?: Partial<NetworkRequestReaderOptions>;
+      },
+): React.ReactNode {
+  const Component = useResult(
+    props.fragmentReference,
+    props.networkRequestOptions,
+  );
+  // TypeScript is not understanding that if additionalProps is Record<PropertyKey, never>,
+  // it means that TProps === JSX.IntrinsicAttributes.
+  // @ts-expect-error
+  return <Component {...props.additionalProps} />;
 }

package/src/react/LoadableFieldReader.tsx

@@ -8,6 +8,9 @@ import { type LoadableField } from '../core/reader';
 import { useClientSideDefer } from '../loadable-hooks/useClientSideDefer';
 import { useResult } from './useResult';
 
+// TODO
+// - LoadableFieldRenderer, which works for @loadable fields that are components,
+//   i.e. just renders the resulting component
 export function LoadableFieldReader<
   TReadFromStore extends UnknownTReadFromStore,
   TResult,

package/src/tests/__isograph/Node/asEconomist/resolver_reader.ts

@@ -16,7 +16,7 @@ const readerAst: ReaderAst<{ data: any, parameters: Record<PropertyKey, never> }
 
 const artifact: EagerReaderArtifact<
   { data: any, parameters: Record<PropertyKey, never> },
-  Link<"Economist"> | null
+  Link | null
 > = {
   kind: "EagerReaderArtifact",
   fieldName: "Node.asEconomist",

package/src/tests/__isograph/Query/linkedUpdate/param_type.ts

@@ -1,4 +1,4 @@
-import { type Node__link__output_type } from '../../Node/link/output_type';
+import type { Link } from '@isograph/react';
 import type { StartUpdate } from '@isograph/react';
 
 export type Query__linkedUpdate__param = {
@@ -15,7 +15,7 @@ A client pointer for the Economist type.
       /**
 A store Link for the Node type.
       */
-      readonly link: Node__link__output_type,
+      readonly link: Link,
       /**
 A client pointer for the Economist type.
       */
@@ -34,12 +34,12 @@ A client pointer for the Economist type.
         name: string,
       } | null),
     } | null),
-    set node(value: ({ link: Node__link__output_type } | null)),
+    set node(value: ({ link: Link } | null)),
     readonly john_stuart_mill: ({
       /**
 A store Link for the Node type.
       */
-      readonly link: Node__link__output_type,
+      readonly link: Link,
       /**
 A client pointer for the Economist type.
       */

package/src/tests/__isograph/iso.ts

@@ -16,7 +16,7 @@ import entrypoint_Query__subquery from '../__isograph/Query/subquery/entrypoint'
 // This means that the type of the exported iso literal is exactly
 // the type of the passed-in function, which takes one parameter
 // of type TParam.
-type IdentityWithParam<TParam extends object, TReturnConstraint = unknown> = <TClientFieldReturn extends TReturnConstraint>(
+type IdentityWithParam<TParam extends object> = <TClientFieldReturn>(
   clientField: (param: TParam) => TClientFieldReturn
 ) => (param: TParam) => TClientFieldReturn;
 

package/dist/core/brand.d.ts

@@ -1,2 +0,0 @@
-export type Brand<BaseType, Brand extends symbol | string> = infer _ extends Brand ? BaseType : never;
-//# sourceMappingURL=brand.d.ts.map

package/dist/core/brand.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"brand.d.ts","sourceRoot":"","sources":["../../src/core/brand.ts"],"names":[],"mappings":"AAaA,MAAM,MAAM,KAAK,CACf,QAAQ,EACR,KAAK,SAAS,MAAM,GAAG,MAAM,IAE3B,MAAM,CAAC,SAAS,KAAK,GAAG,QAAQ,GAAG,KAAK,CAAC"}

package/dist/core/brand.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/react/FragmentRenderer.d.ts

@@ -1,15 +0,0 @@
-import * as React from 'react';
-import { type ExtractReadFromStore, type IsographEntrypoint } from '../core/entrypoint';
-import { type FragmentReference } from '../core/FragmentReference';
-import { type NetworkRequestReaderOptions } from '../core/read';
-export type IsExactlyIntrinsicAttributes<T> = T extends JSX.IntrinsicAttributes ? JSX.IntrinsicAttributes extends T ? true : false : false;
-export declare function FragmentRenderer<TProps extends Record<any, any>, TEntrypoint extends IsographEntrypoint<any, React.FC<TProps>, any>>(props: IsExactlyIntrinsicAttributes<TProps> extends true ? {
-    fragmentReference: FragmentReference<ExtractReadFromStore<TEntrypoint>, React.FC<TProps>>;
-    additionalProps?: Record<PropertyKey, never>;
-    networkRequestOptions?: Partial<NetworkRequestReaderOptions>;
-} : {
-    fragmentReference: FragmentReference<ExtractReadFromStore<TEntrypoint>, React.FC<TProps>>;
-    additionalProps: Omit<TProps, keyof JSX.IntrinsicAttributes>;
-    networkRequestOptions?: Partial<NetworkRequestReaderOptions>;
-}): React.ReactNode;
-//# sourceMappingURL=FragmentRenderer.d.ts.map

package/dist/react/FragmentRenderer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"FragmentRenderer.d.ts","sourceRoot":"","sources":["../../src/react/FragmentRenderer.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EACL,KAAK,oBAAoB,EACzB,KAAK,kBAAkB,EACxB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAGhE,MAAM,MAAM,4BAA4B,CAAC,CAAC,IAAI,CAAC,SAAS,GAAG,CAAC,mBAAmB,GAC3E,GAAG,CAAC,mBAAmB,SAAS,CAAC,GAC/B,IAAI,GACJ,KAAK,GACP,KAAK,CAAC;AAEV,wBAAgB,gBAAgB,CAC9B,MAAM,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,EAC/B,WAAW,SAAS,kBAAkB,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,EAElE,KAAK,EAAE,4BAA4B,CAAC,MAAM,CAAC,SAAS,IAAI,GACpD;IACE,iBAAiB,EAAE,iBAAiB,CAClC,oBAAoB,CAAC,WAAW,CAAC,EACjC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CACjB,CAAC;IACF,eAAe,CAAC,EAAE,MAAM,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IAC7C,qBAAqB,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;CAC9D,GACD;IACE,iBAAiB,EAAE,iBAAiB,CAClC,oBAAoB,CAAC,WAAW,CAAC,EACjC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CACjB,CAAC;IACF,eAAe,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAC7D,qBAAqB,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;CAC9D,GACJ,KAAK,CAAC,SAAS,CASjB"}

package/dist/react/FragmentRenderer.js

@@ -1,35 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FragmentRenderer = FragmentRenderer;
-const React = __importStar(require("react"));
-const useResult_1 = require("./useResult");
-function FragmentRenderer(props) {
-    const Component = (0, useResult_1.useResult)(props.fragmentReference, props.networkRequestOptions);
-    // TypeScript is not understanding that if additionalProps is Record<PropertyKey, never>,
-    // it means that TProps === JSX.IntrinsicAttributes.
-    // @ts-expect-error
-    return React.createElement(Component, Object.assign({}, props.additionalProps));
-}

package/dist/react/LoadableFieldRenderer.d.ts

@@ -1,13 +0,0 @@
-import * as React from 'react';
-import { type FetchOptions } from '../core/check';
-import { ExtractParameters, type UnknownTReadFromStore } from '../core/FragmentReference';
-import { type NetworkRequestReaderOptions } from '../core/read';
-import { type LoadableField } from '../core/reader';
-export declare function LoadableFieldRenderer<TReadFromStore extends UnknownTReadFromStore, TProvidedArgs extends object, TChildrenResult, TProps>(props: {
-    loadableField: LoadableField<TReadFromStore, React.FC<TProps>, Omit<ExtractParameters<TReadFromStore>, keyof TProvidedArgs>>;
-    args: Omit<ExtractParameters<TReadFromStore>, keyof TProvidedArgs>;
-    fetchOptions?: FetchOptions<React.FC<TProps>>;
-    networkRequestOptions?: Partial<NetworkRequestReaderOptions>;
-    additionalProps: Omit<TProps, keyof JSX.IntrinsicAttributes>;
-}): TChildrenResult;
-//# sourceMappingURL=LoadableFieldRenderer.d.ts.map

package/dist/react/LoadableFieldRenderer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"LoadableFieldRenderer.d.ts","sourceRoot":"","sources":["../../src/react/LoadableFieldRenderer.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,eAAe,CAAC;AAClD,OAAO,EACL,iBAAiB,EACjB,KAAK,qBAAqB,EAC3B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAIpD,wBAAgB,qBAAqB,CACnC,cAAc,SAAS,qBAAqB,EAC5C,aAAa,SAAS,MAAM,EAC5B,eAAe,EACf,MAAM,EACN,KAAK,EAAE;IACP,aAAa,EAAE,aAAa,CAC1B,cAAc,EACd,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,EAChB,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,EAAE,MAAM,aAAa,CAAC,CAC7D,CAAC;IAEF,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,EAAE,MAAM,aAAa,CAAC,CAAC;IACnE,YAAY,CAAC,EAAE,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAC9C,qBAAqB,CAAC,EAAE,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAC7D,eAAe,EAAE,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,mBAAmB,CAAC,CAAC;CAC9D,GAAG,eAAe,CAalB"}

package/dist/react/LoadableFieldRenderer.js

@@ -1,37 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LoadableFieldRenderer = LoadableFieldRenderer;
-const React = __importStar(require("react"));
-const useClientSideDefer_1 = require("../loadable-hooks/useClientSideDefer");
-const useResult_1 = require("./useResult");
-function LoadableFieldRenderer(props) {
-    const { fragmentReference } = (0, useClientSideDefer_1.useClientSideDefer)(props.loadableField, props.args, props.fetchOptions);
-    const Component = (0, useResult_1.useResult)(fragmentReference, props.networkRequestOptions);
-    // TODO we probably can figure out a way to convince TypeScript of
-    // the validity of this.
-    // @ts-expect-error
-    return React.createElement(Component, Object.assign({}, props.additionalProps));
-}

package/src/core/brand.ts

@@ -1,18 +0,0 @@
-// Suppress the TypeScript compiler warning for this branded-type trick.
-// See discussion: https://github.com/microsoft/TypeScript/issues/202#issuecomment-436900738
-// Pattern: “Brand<BaseType, Brand>” leverages TypeScript conditional and `infer` types to create a pseudo-nominal type,
-// enabling BaseType to be treated as distinct only when tagged with Brand, even though Brand doesn't exist at runtime.
-//
-// Explanation:
-// - Brand extends `symbol | string` acts as a “brand” identifier.
-// - The type uses a conditional check `infer _ extends Brand ? BaseType : never` to strip out BaseType when the branding doesn't match.
-// - This yields a branded type system: `Brand<string, "UserId">` is not accidentally assignable to `Brand<string, "ProductId">`.
-//
-// Usage: Helps enforce semantic distinctions (e.g., distinguishing user IDs from product IDs) even when their runtime values are both strings.
-//
-// Caveat: This is purely a compile-time trick—Brand is erased in emitted JavaScript, so runtime checks must rely on other mechanisms.
-export type Brand<
-  BaseType,
-  Brand extends symbol | string,
-  // @ts-ignore
-> = infer _ extends Brand ? BaseType : never;

package/src/react/FragmentRenderer.tsx

@@ -1,46 +0,0 @@
-import * as React from 'react';
-import {
-  type ExtractReadFromStore,
-  type IsographEntrypoint,
-} from '../core/entrypoint';
-import { type FragmentReference } from '../core/FragmentReference';
-import { type NetworkRequestReaderOptions } from '../core/read';
-import { useResult } from './useResult';
-
-export type IsExactlyIntrinsicAttributes<T> = T extends JSX.IntrinsicAttributes
-  ? JSX.IntrinsicAttributes extends T
-    ? true
-    : false
-  : false;
-
-export function FragmentRenderer<
-  TProps extends Record<any, any>,
-  TEntrypoint extends IsographEntrypoint<any, React.FC<TProps>, any>,
->(
-  props: IsExactlyIntrinsicAttributes<TProps> extends true
-    ? {
-        fragmentReference: FragmentReference<
-          ExtractReadFromStore<TEntrypoint>,
-          React.FC<TProps>
-        >;
-        additionalProps?: Record<PropertyKey, never>;
-        networkRequestOptions?: Partial<NetworkRequestReaderOptions>;
-      }
-    : {
-        fragmentReference: FragmentReference<
-          ExtractReadFromStore<TEntrypoint>,
-          React.FC<TProps>
-        >;
-        additionalProps: Omit<TProps, keyof JSX.IntrinsicAttributes>;
-        networkRequestOptions?: Partial<NetworkRequestReaderOptions>;
-      },
-): React.ReactNode {
-  const Component = useResult(
-    props.fragmentReference,
-    props.networkRequestOptions,
-  );
-  // TypeScript is not understanding that if additionalProps is Record<PropertyKey, never>,
-  // it means that TProps === JSX.IntrinsicAttributes.
-  // @ts-expect-error
-  return <Component {...props.additionalProps} />;
-}

package/src/react/LoadableFieldRenderer.tsx

@@ -1,41 +0,0 @@
-import * as React from 'react';
-import { type FetchOptions } from '../core/check';
-import {
-  ExtractParameters,
-  type UnknownTReadFromStore,
-} from '../core/FragmentReference';
-import { type NetworkRequestReaderOptions } from '../core/read';
-import { type LoadableField } from '../core/reader';
-import { useClientSideDefer } from '../loadable-hooks/useClientSideDefer';
-import { useResult } from './useResult';
-
-export function LoadableFieldRenderer<
-  TReadFromStore extends UnknownTReadFromStore,
-  TProvidedArgs extends object,
-  TChildrenResult,
-  TProps,
->(props: {
-  loadableField: LoadableField<
-    TReadFromStore,
-    React.FC<TProps>,
-    Omit<ExtractParameters<TReadFromStore>, keyof TProvidedArgs>
-  >;
-  // TODO we can improve this to not require args if its an empty object
-  args: Omit<ExtractParameters<TReadFromStore>, keyof TProvidedArgs>;
-  fetchOptions?: FetchOptions<React.FC<TProps>>;
-  networkRequestOptions?: Partial<NetworkRequestReaderOptions>;
-  additionalProps: Omit<TProps, keyof JSX.IntrinsicAttributes>;
-}): TChildrenResult {
-  const { fragmentReference } = useClientSideDefer(
-    props.loadableField,
-    props.args,
-    props.fetchOptions,
-  );
-
-  const Component = useResult(fragmentReference, props.networkRequestOptions);
-
-  // TODO we probably can figure out a way to convince TypeScript of
-  // the validity of this.
-  // @ts-expect-error
-  return <Component {...props.additionalProps} />;
-}

package/src/tests/__isograph/Economist/link/output_type.ts

@@ -1,2 +0,0 @@
-import type { Link } from '@isograph/react';
-export type Economist__link__output_type = Link<"Economist">;

package/src/tests/__isograph/Node/link/output_type.ts

@@ -1,3 +0,0 @@
-import type { Link } from '@isograph/react';
-export type Node__link__output_type = 
-  | Link<"Economist">;

package/src/tests/__isograph/tsconfig.json

@@ -1,8 +0,0 @@
-{
-    "compilerOptions": {
-        "noUnusedLocals": false,
-        "noUnusedParameters": false,
-        "jsx": "preserve",
-        "esModuleInterop": true
-    }
-}