@khanacademy/wonder-blocks-data 10.1.0 → 10.1.2

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @khanacademy/wonder-blocks-data
 
+## 10.1.2
+
+### Patch Changes
+
+-   Updated dependencies [779b031d]
+    -   @khanacademy/wonder-blocks-core@4.9.0
+
+## 10.1.1
+
+### Patch Changes
+
+-   d816af08: Update build and test configs use TypeScript
+-   3891f544: Update babel config to include plugins that Storybook needed
+-   3813715d: Update wonder-stuff dependencies (non-functional changes)
+-   0d28bb1c: Configured TypeScript
+-   3d05f764: Fix HOCs and other type errors
+-   c2ec4902: Update eslint configuration, fix lint
+-   2983c05b: Include 'types' field in package.json
+-   77ff6a66: Generate Flow types from TypeScript types
+-   ec8d4b7f: Fix miscellaneous TypeScript errors
+-   Updated dependencies [d816af08]
+-   Updated dependencies [3891f544]
+-   Updated dependencies [0d28bb1c]
+-   Updated dependencies [873f4a14]
+-   Updated dependencies [3d05f764]
+-   Updated dependencies [c2ec4902]
+-   Updated dependencies [2983c05b]
+-   Updated dependencies [77ff6a66]
+-   Updated dependencies [ec8d4b7f]
+    -   @khanacademy/wonder-blocks-core@4.8.0
+
 ## 10.1.0
 
 ### Minor Changes

package/dist/components/data.d.ts

@@ -0,0 +1,52 @@
+import * as React from "react";
+import { WhenClientSide } from "../hooks/use-hydratable-effect";
+import type { Result, ValidCacheData } from "../util/types";
+type Props<
+/**
+ * The type of data resolved by the handler's fulfillRequest method.
+ */
+TData extends ValidCacheData> = {
+    /**
+     * A unique identifier for the request.
+     *
+     * This should not be shared by other uses of this component.
+     */
+    requestId: string;
+    /**
+     * This defines how the request is fulfilled.
+     *
+     * If this is changed without changing the ID, there are cases where the
+     * old handler result may be given. This is not a supported mode of
+     * operation.
+     */
+    handler: () => Promise<TData>;
+    /**
+     * How the hook should behave when rendering client-side for the first time.
+     *
+     * This controls how the hook hydrates and executes when client-side.
+     *
+     * Default is `OnClientRender.ExecuteWhenNoSuccessResult`.
+     */
+    clientBehavior?: typeof WhenClientSide[keyof typeof WhenClientSide];
+    /**
+     * When true, the children will be rendered with the existing result
+     * until the pending load is completed. Otherwise, the children will be
+     * given a loading state until the request is fulfilled.
+     *
+     * Defaults to false.
+     */
+    retainResultOnChange?: boolean;
+    /**
+     * A function that will render the content of this component using the
+     * loading state and data or error that gets retrieved from cache or loaded
+     * via the request if no cached value is available.
+     */
+    children: (result: Result<TData>) => React.ReactElement;
+};
+/**
+ * This component is the main component of Wonder Blocks Data. With this, data
+ * requirements can be placed in a React application in a manner that will
+ * support server-side rendering and efficient caching.
+ */
+declare const Data: React.FC<Props<any>>;
+export default Data;

package/dist/components/data.js.flow

@@ -0,0 +1,63 @@
+/**
+ * Flowtype definitions for data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import { WhenClientSide } from "../hooks/use-hydratable-effect";
+import type { Result, ValidCacheData } from "../util/types";
+declare type Props<TData: ValidCacheData> = {
+  /**
+   * A unique identifier for the request.
+   *
+   * This should not be shared by other uses of this component.
+   */
+  requestId: string,
+
+  /**
+   * This defines how the request is fulfilled.
+   *
+   * If this is changed without changing the ID, there are cases where the
+   * old handler result may be given. This is not a supported mode of
+   * operation.
+   */
+  handler: () => Promise<TData>,
+
+  /**
+   * How the hook should behave when rendering client-side for the first time.
+   *
+   * This controls how the hook hydrates and executes when client-side.
+   *
+   * Default is `OnClientRender.ExecuteWhenNoSuccessResult`.
+   */
+  clientBehavior?: $ElementType<
+    typeof WhenClientSide,
+    $Keys<typeof WhenClientSide>
+  >,
+
+  /**
+   * When true, the children will be rendered with the existing result
+   * until the pending load is completed. Otherwise, the children will be
+   * given a loading state until the request is fulfilled.
+   *
+   * Defaults to false.
+   */
+  retainResultOnChange?: boolean,
+
+  /**
+   * A function that will render the content of this component using the
+   * loading state and data or error that gets retrieved from cache or loaded
+   * via the request if no cached value is available.
+   */
+  children: (result: Result<TData>) => React.Element<>,
+  ...
+};
+/**
+ * This component is the main component of Wonder Blocks Data. With this, data
+ * requirements can be placed in a React application in a manner that will
+ * support server-side rendering and efficient caching.
+ */
+declare var Data: React.FC<Props<any>>;
+declare export default typeof Data;

package/dist/components/gql-router.d.ts

@@ -0,0 +1,24 @@
+import * as React from "react";
+import type { GqlContext, GqlFetchFn } from "../util/gql-types";
+type Props<TContext extends GqlContext> = {
+    /**
+     * The default context to be used by operations when no context is provided.
+     */
+    defaultContext: TContext;
+    /**
+     * The function to use when fetching requests.
+     */
+    fetch: GqlFetchFn<any, any, TContext>;
+    /**
+     * The children to be rendered inside the router.
+     */
+    children: React.ReactNode;
+};
+/**
+ * Configure GraphQL routing for GraphQL hooks and components.
+ *
+ * These can be nested. Components and hooks relying on the GraphQL routing
+ * will use the configuration from their closest ancestral GqlRouter.
+ */
+export declare const GqlRouter: React.FC<Props<any>>;
+export {};

package/dist/components/gql-router.js.flow

@@ -0,0 +1,33 @@
+/**
+ * Flowtype definitions for gql-router
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import type { GqlContext, GqlFetchFn } from "../util/gql-types";
+declare type Props<TContext: GqlContext> = {
+  /**
+   * The default context to be used by operations when no context is provided.
+   */
+  defaultContext: TContext,
+
+  /**
+   * The function to use when fetching requests.
+   */
+  fetch: GqlFetchFn<any, any, TContext>,
+
+  /**
+   * The children to be rendered inside the router.
+   */
+  children: React.Node,
+  ...
+};
+/**
+ * Configure GraphQL routing for GraphQL hooks and components.
+ *
+ * These can be nested. Components and hooks relying on the GraphQL routing
+ * will use the configuration from their closest ancestral GqlRouter.
+ */
+declare export var GqlRouter: React.FC<Props<any>>;

package/dist/components/intercept-context.d.ts

@@ -0,0 +1,10 @@
+import * as React from "react";
+import type { ValidCacheData } from "../util/types";
+type InterceptContextData = ReadonlyArray<(requestId: string) => Promise<ValidCacheData | null | undefined> | null | undefined>;
+/**
+ * InterceptContext defines a map from request ID to interception methods.
+ *
+ * INTERNAL USE ONLY
+ */
+declare const InterceptContext: React.Context<InterceptContextData>;
+export default InterceptContext;

package/dist/components/intercept-context.js.flow

@@ -0,0 +1,19 @@
+/**
+ * Flowtype definitions for intercept-context
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import type { ValidCacheData } from "../util/types";
+declare type InterceptContextData = $ReadOnlyArray<
+  (requestId: string) => Promise<ValidCacheData | null | void> | null | void
+>;
+/**
+ * InterceptContext defines a map from request ID to interception methods.
+ *
+ * INTERNAL USE ONLY
+ */
+declare var InterceptContext: React.Context<InterceptContextData>;
+declare export default typeof InterceptContext;

package/dist/components/intercept-requests.d.ts

@@ -0,0 +1,42 @@
+import * as React from "react";
+import type { ValidCacheData } from "../util/types";
+type Props<TData extends ValidCacheData> = {
+    /**
+     * Called to intercept and possibly handle the request.
+     * If this returns null, the request will be handled by ancestor
+     * any ancestor interceptors, and ultimately, the original request
+     * handler, otherwise, this interceptor is handling the request.
+     *
+     * Interceptors are called in ancestor precedence, with the closest
+     * interceptor ancestor being called first, and the furthest ancestor
+     * being called last.
+     *
+     * Beware: Interceptors do not care about what data they are intercepting,
+     * so make sure to only intercept requests that you recognize from the
+     * identifier.
+     */
+    interceptor: (requestId: string) => Promise<TData> | null | undefined;
+    /**
+     * The children to render within this component. Any requests by `Data`
+     * components that use same ID as this component will be intercepted.
+     * If `InterceptRequests` is used within `children`, that interception will
+     * be given a chance to intercept first.
+     */
+    children: React.ReactNode;
+};
+/**
+ * This component provides a mechanism to intercept data requests.
+ * This is for use in testing.
+ *
+ * This component is not recommended for use in production code as it
+ * can prevent predictable functioning of the Wonder Blocks Data framework.
+ * One possible side-effect is that inflight requests from the interceptor could
+ * be picked up by `Data` component requests from outside the children of this
+ * component.
+ *
+ * Interceptions within the same component tree are chained such that the
+ * interceptor closest to the intercepted request is called first, and the
+ * furthest interceptor is called last.
+ */
+declare const InterceptRequests: React.FC<Props<any>>;
+export default InterceptRequests;

package/dist/components/intercept-requests.js.flow

@@ -0,0 +1,51 @@
+/**
+ * Flowtype definitions for intercept-requests
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+import type { ValidCacheData } from "../util/types";
+declare type Props<TData: ValidCacheData> = {
+  /**
+   * Called to intercept and possibly handle the request.
+   * If this returns null, the request will be handled by ancestor
+   * any ancestor interceptors, and ultimately, the original request
+   * handler, otherwise, this interceptor is handling the request.
+   *
+   * Interceptors are called in ancestor precedence, with the closest
+   * interceptor ancestor being called first, and the furthest ancestor
+   * being called last.
+   *
+   * Beware: Interceptors do not care about what data they are intercepting,
+   * so make sure to only intercept requests that you recognize from the
+   * identifier.
+   */
+  interceptor: (requestId: string) => Promise<TData> | null | void,
+
+  /**
+   * The children to render within this component. Any requests by `Data`
+   * components that use same ID as this component will be intercepted.
+   * If `InterceptRequests` is used within `children`, that interception will
+   * be given a chance to intercept first.
+   */
+  children: React.Node,
+  ...
+};
+/**
+ * This component provides a mechanism to intercept data requests.
+ * This is for use in testing.
+ *
+ * This component is not recommended for use in production code as it
+ * can prevent predictable functioning of the Wonder Blocks Data framework.
+ * One possible side-effect is that inflight requests from the interceptor could
+ * be picked up by `Data` component requests from outside the children of this
+ * component.
+ *
+ * Interceptions within the same component tree are chained such that the
+ * interceptor closest to the intercepted request is called first, and the
+ * furthest interceptor is called last.
+ */
+declare var InterceptRequests: React.FC<Props<any>>;
+declare export default typeof InterceptRequests;

package/dist/components/track-data.d.ts

@@ -0,0 +1,11 @@
+import * as React from "react";
+type TrackDataProps = {
+    children: React.ReactNode;
+};
+/**
+ * Component to enable data request tracking when server-side rendering.
+ */
+export default class TrackData extends React.Component<TrackDataProps> {
+    render(): React.ReactElement;
+}
+export {};

package/dist/components/track-data.js.flow

@@ -0,0 +1,18 @@
+/**
+ * Flowtype definitions for track-data
+ * Generated by Flowgen from a Typescript Definition
+ * Flowgen v1.21.0
+ * @flow
+ */
+
+import * as React from "react";
+declare type TrackDataProps = {
+  children: React.Node,
+  ...
+};
+/**
+ * Component to enable data request tracking when server-side rendering.
+ */
+declare export default class TrackData extends React.Component<TrackDataProps> {
+  render(): React.Element<>;
+}