@khanacademy/wonder-blocks-data 10.0.5 → 10.1.1

package/src/__docs__/types.scoped-cache.stories.mdx

@@ -1,114 +0,0 @@
-import {Meta} from "@storybook/addon-docs";
-
-<Meta
-    title="Data / Types / ScopedCache"
-    parameters={{
-        chromatic: {
-            disableSnapshot: true,
-        },
-    }}
-/>
-
-# ScopedCache
-
-```ts
-interface ScopedCache {
-    set(scope: string, id: string, value: ValidCacheData): void;
-
-    /**
-     * Retrieve a value from the cache.
-     */
-    get(scope: string, id: string): ?ValidCacheData;
-
-    /**
-     * Purge an item from the cache.
-     */
-    purge(scope: string, id: string): void;
-
-    /**
-     * Purge a scope of items that match the given predicate.
-     *
-     * If the predicate is omitted, then all items in the scope are purged.
-     */
-    purgeScope(
-        scope: string,
-        predicate?: (id: string, value: ValidCacheData) => boolean,
-    ): void;
-
-    /**
-     * Purge all items from the cache that match the given predicate.
-     *
-     * If the predicate is omitted, then all items in the cache are purged.
-     */
-    purgeAll(
-        predicate?: (
-            scope: string,
-            id: string,
-            value: ValidCacheData,
-        ) => boolean,
-    ): void;
-}
-```
-
-This interface defines how to interact with a scoped cache, such as [`ScopedInMemoryCache`](/docs/data-exports-scopedinmemorycache--page).
-
-## set()
-
-```ts
-set(
-    scope: string,
-    id: string,
-    value: TValue,
-): void;
-```
-
-Sets a value in the cache within a given scope.
-
-### Throws
-
-| Error Type | Error Name | Reason |
-| ------ | ------ | ------ |
-| [`DataError`](/docs/data-exports-dataerror--page) | `InvalidInputDataError` | `id` and `scope` must be non-empty strings |
-| [`DataError`](/docs/data-exports-dataerror--page) | `InvalidInputDataError` | `value` must be a non-function value |
-
-## get()
-
-```ts
-get(scope: string, id: string): ?ValidCacheData;
-```
-
-Gets a value from the cache. If a value with the given identifier (`id`) is not found within the given scope (`scope`) of the cache, `null` is returned.
-
-## purge()
-
-```ts
-purge(scope: string, id: string): void;
-```
-
-Purges the value from the cache. If a value with the given identifier (`id`) is not found within the given scope (`scope`) of the cache, nothing happens.
-
-## purgeScope()
-
-```ts
-purgeScope(
-    scope: string,
-    predicate?: (id: string, value: ValidCacheData) => boolean,
-): void;
-```
-
-Purges items within a given scope (`scope`) of the cache from that scope. If a predicate is provided, only items for which the predicate returns `true` will be purged; otherwise, the entire scope will be purged.
-
-## purgeAll()
-
-```ts
-purgeAll(
-    predicate?: (
-        scope: string,
-        id: string,
-        value: ValidCacheData,
-    ) => boolean,
-): void;
-```
-
-Purges all items from the cache. If a predicate is provided, only items for which the predicate returns `true` will be purged; otherwise, the entire cache will be purged.
-

package/src/__docs__/types.valid-cache-data.stories.mdx

@@ -1,23 +0,0 @@
-import {Meta} from "@storybook/addon-docs";
-
-<Meta
-    title="Data / Types / ValidCacheData"
-    parameters={{
-        chromatic: {
-            disableSnapshot: true,
-        },
-    }}
-/>
-
-# ValidCacheData
-
-```ts
-type ValidCacheData =
-    | string
-    | boolean
-    | number
-    | {...}
-    | Array<?ValidCacheData>;
-```
-
-This type represents the data that is allowed into the various caches provided and used by Wonder Blocks Data.

package/src/index.js

@@ -1,55 +0,0 @@
-// @flow
-// TODO(somewhatabstract, FEI-4174): Update eslint-plugin-import when they
-// have fixed:
-// https://github.com/import-js/eslint-plugin-import/issues/2073
-// eslint-disable-next-line import/named
-export {FetchPolicy} from "./util/types.js";
-export type {
-    ErrorOptions,
-    ResponseCache,
-    CachedResponse,
-    Result,
-    RawScopedCache,
-    ValidCacheData,
-    ScopedCache,
-} from "./util/types.js";
-
-export * from "./util/hydration-cache-api.js";
-export * from "./util/request-api.js";
-export {purgeCaches} from "./util/purge-caches.js";
-export {default as TrackData} from "./components/track-data.js";
-export {default as Data} from "./components/data.js";
-export {default as InterceptRequests} from "./components/intercept-requests.js";
-export {DataError, DataErrors} from "./util/data-error.js";
-export {useServerEffect} from "./hooks/use-server-effect.js";
-export {useCachedEffect} from "./hooks/use-cached-effect.js";
-export {useSharedCache, SharedCache} from "./hooks/use-shared-cache.js";
-export {
-    useHydratableEffect,
-    // TODO(somewhatabstract, FEI-4174): Update eslint-plugin-import when they
-    // have fixed:
-    // https://github.com/import-js/eslint-plugin-import/issues/2073
-    // eslint-disable-next-line import/named
-    WhenClientSide,
-} from "./hooks/use-hydratable-effect.js";
-export {ScopedInMemoryCache} from "./util/scoped-in-memory-cache.js";
-export {SerializableInMemoryCache} from "./util/serializable-in-memory-cache.js";
-export {Status} from "./util/status.js";
-
-////////////////////////////////////////////////////////////////////////////////
-// GraphQL
-////////////////////////////////////////////////////////////////////////////////
-export {getGqlRequestId} from "./util/get-gql-request-id.js";
-export {getGqlDataFromResponse} from "./util/get-gql-data-from-response.js";
-export {graphQLDocumentNodeParser} from "./util/graphql-document-node-parser.js";
-export {toGqlOperation} from "./util/to-gql-operation.js";
-export {GqlRouter} from "./components/gql-router.js";
-export {useGql} from "./hooks/use-gql.js";
-export {GqlError, GqlErrors} from "./util/gql-error.js";
-export type {
-    GqlContext,
-    GqlOperation,
-    GqlOperationType,
-    GqlFetchOptions,
-    GqlFetchFn,
-} from "./util/gql-types.js";

package/src/util/gql-router-context.js

@@ -1,6 +0,0 @@
-// @flow
-import * as React from "react";
-import type {GqlRouterConfiguration} from "./gql-types.js";
-
-export const GqlRouterContext: React.Context<?GqlRouterConfiguration<any>> =
-    React.createContext<?GqlRouterConfiguration<any>>(null);

package/src/util/graphql-types.js

@@ -1,30 +0,0 @@
-// @flow
-// NOTE(somewhatabstract):
-// These types are bare minimum to support document parsing. They're derived
-// from graphql@14.5.8, the last version that provided flow types.
-// Doing this avoids us having to take a dependency on that library just for
-// these types.
-export interface DefinitionNode {
-    +kind: string;
-}
-
-export type VariableDefinitionNode = {
-    +kind: "VariableDefinition",
-    ...
-};
-
-export interface OperationDefinitionNode extends DefinitionNode {
-    +kind: "OperationDefinition";
-    +operation: string;
-    +variableDefinitions: $ReadOnlyArray<VariableDefinitionNode>;
-    +name?: {|
-        +kind: mixed,
-        +value: string,
-    |};
-}
-
-export type DocumentNode = {
-    +kind: "Document",
-    +definitions: $ReadOnlyArray<DefinitionNode>,
-    ...
-};