@player-tools/dsl 0.5.0--canary.62.1176 → 0.5.0-next.0

package/dist/index.d.ts

@@ -1,404 +0,0 @@
-import * as _player_ui_types from '@player-ui/types';
-import { Asset as Asset$1, Navigation as Navigation$1, Expression, Schema, NavigationFlowViewState, NavigationFlowState, NavigationFlow, ExpressionObject, Flow } from '@player-ui/types';
-import * as React$1 from 'react';
-import React__default, { PropsWithChildren } from 'react';
-import { PropertyNode, ObjectNode, JsonNode, JsonType } from 'react-json-reconciler';
-export * from 'react-json-reconciler';
-import { SyncWaterfallHook, SyncHook, AsyncSeriesWaterfallHook, AsyncSeriesHook } from 'tapable-ts';
-
-declare type TemplateInstanceRefStringContext = 'binding' | 'expression';
-interface TemplateRefStringOptions {
-    /** If this template string is inside of another binding or expression */
-    nestedContext?: TemplateInstanceRefStringContext;
-}
-interface TemplateInstanceRefStringOptions {
-    /** The array of strings for the template */
-    strings: TemplateStringsArray;
-    /** the other data that's present in the template */
-    other: Array<string | TemplateStringType>;
-    /** If this template string is inside of another binding or expression */
-    nestedContext?: TemplateInstanceRefStringContext;
-    /** Convert the value to a reference nested in the given context */
-    toRefString: (options: TemplateRefStringOptions | undefined, value: string) => string;
-}
-declare const OpaqueIdentifier: unique symbol;
-declare type TemplateStringType = React$1.ReactElement & {
-    /** An identifier to show that this is a template type */
-    [OpaqueIdentifier]: true;
-    /** The value of the template string when in another string */
-    toString: () => string;
-    /** the raw value of the template string */
-    toValue: () => string;
-    /** the dereferenced value when used in another */
-    toRefString: (options?: TemplateRefStringOptions) => string;
-};
-declare type BindingTemplateInstance = TemplateStringType & {
-    /** An identifier for a binding instance */
-    __type: 'binding';
-};
-declare type ExpressionTemplateInstance = TemplateStringType & {
-    /** The identifier for an expression instance */
-    __type: 'expression';
-};
-/** A react component for rendering a template string type */
-declare const TemplateStringComponent: (props: {
-    /** The string value of the child template string */
-    value: string;
-}) => React$1.ReactElement<{
-    value: string;
-}, string | React$1.JSXElementConstructor<any>>;
-/** A tagged-template constructor for a binding  */
-declare const binding: (strings: TemplateStringsArray, ...nested: Array<TemplateStringType | string>) => BindingTemplateInstance;
-/** A tagged-template constructor for an expression */
-declare const expression: (strings: TemplateStringsArray, ...nested: Array<ExpressionTemplateInstance | BindingTemplateInstance | string>) => ExpressionTemplateInstance;
-/** Check if a value is a template string */
-declare const isTemplateStringInstance: (val: unknown) => val is BindingTemplateInstance | ExpressionTemplateInstance;
-
-declare type WithChildren<T = Record<string, unknown>> = T & {
-    /** child nodes */
-    children?: React.ReactNode;
-};
-declare type RemoveUnknownIndex<T> = {
-    [P in keyof T as T[P] extends unknown ? unknown extends T[P] ? never : P : P]: T[P];
-};
-declare type AddUnknownIndex<T> = T & {
-    [key: string]: unknown;
-};
-/** Make an ID prop optional an a type */
-declare type OmitProp<T, K extends string> = {
-    [P in keyof T as P extends K ? never : P]: T[P];
-};
-interface PlayerApplicability {
-    /** An expression to evaluate to determine if this node should appear in a view or not */
-    applicability?: BindingTemplateInstance | ExpressionTemplateInstance | boolean;
-}
-declare type AssetPropsWithChildren<T extends Asset$1> = WithChildren<WithTemplateTypes<OmitProp<RemoveUnknownIndex<T>, 'id' | 'type'> & Partial<Pick<Asset$1, 'id'>>> & PlayerApplicability>;
-declare type SwapKeysToType<T, K extends keyof T, NewType> = {
-    [P in keyof T]: P extends K ? NewType : T[P];
-};
-declare type WithTemplateTypes<T> = T extends Record<any, any> ? {
-    [P in keyof T]: WithTemplateTypes<T[P]>;
-} : T | BindingTemplateInstance | ExpressionTemplateInstance;
-declare type ValidKeys = 'exp' | 'onStart' | 'onEnd';
-declare type DeepReplace<T, Old, New> = {
-    [P in keyof T]: T[P] extends Old ? P extends ValidKeys ? New : DeepReplace<T[P], Old, New> : T[P] extends (infer R)[] ? DeepReplace<R, Old, New>[] : T[P] extends object ? DeepReplace<T[P], Old, New> : Extract<T[P], Old> extends Old ? DeepReplace<Extract<T[P], object>, Old, New> | Exclude<T[P], Old | object> | New : T[P];
-};
-declare type Navigation = DeepReplace<Navigation$1, Expression, ExpressionTemplateInstance | ExpressionTemplateInstance[] | Expression>;
-interface toJsonOptions {
-    /**
-     * List of string keys that should not be parsed in a special way
-     * default is 'applicability'
-     */
-    propertiesToSkip?: string[];
-}
-
-declare type AssetProps = PlayerApplicability & {
-    /** id of the asset */
-    id?: string;
-    /** the asset type */
-    type: string;
-    /** Any other properties on the asset */
-    children?: React__default.ReactNode;
-    /** other things that we don't know about */
-    [key: string]: unknown;
-};
-declare const SlotContext: React__default.Context<{
-    /** The property name for the slot */
-    propertyName: string;
-    /** If the slot represents an array */
-    isArray: boolean;
-    /** If the items in the slot should be wrapped in an "asset" object */
-    wrapInAsset: boolean;
-    /** Other props to add to the slot */
-    additionalProperties?: any;
-    /** The ref to the property node */
-    ref: React__default.RefObject<PropertyNode>;
-    /** A text component if we hit a string but expect an asset */
-    TextComp?: React__default.ComponentType<{}> | undefined;
-    /** A component to create a collection asset is we get an array but need a single element */
-    CollectionComp?: React__default.ComponentType<{}> | undefined;
-} | undefined>;
-/**
- * Wraps the children in an `asset` object.
- * Additional props are added to the top level object
- */
-declare const AssetWrapper: React__default.ForwardRefExoticComponent<Omit<WithChildren<{
-    [key: string]: any;
-}>, "ref"> & React__default.RefAttributes<ObjectNode>>;
-/** Create a ID property for a node */
-declare const GeneratedIDProperty: (props: {
-    /** the id to use if supplied by the user */
-    id?: string;
-}) => React__default.JSX.Element;
-/** An asset */
-declare const Asset: React__default.ForwardRefExoticComponent<Omit<AssetProps, "ref"> & React__default.RefAttributes<ObjectNode>>;
-declare const View: React__default.ForwardRefExoticComponent<Omit<PlayerApplicability & {
-    [key: string]: unknown;
-    /** id of the asset */
-    id?: string | undefined;
-    /** the asset type */
-    type: string;
-    /** Any other properties on the asset */
-    children?: React__default.ReactNode;
-} & _player_ui_types.Asset<string> & {
-    validation?: _player_ui_types.Validation.CrossfieldReference[] | undefined;
-}, "ref"> & React__default.RefAttributes<ObjectNode>>;
-/** A component to generate a named property slot */
-declare const Slot: (props: {
-    /** The name of the slot */
-    name: string;
-    /** if the slot is an array or single object */
-    isArray?: boolean;
-    /** if each item should be wrapped in an asset */
-    wrapInAsset?: boolean;
-    /** Any children to render in the slot */
-    children?: React__default.ReactNode;
-    /** Other properties to add to the slot */
-    additionalProperties?: any;
-    /** A text component if we hit a string but expect an asset */
-    TextComp?: React__default.ComponentType;
-    /** A component to create a collection asset is we get an array but need a single element */
-    CollectionComp?: React__default.ComponentType;
-}) => React__default.JSX.Element;
-/** Create a slot for a given property */
-declare function createSlot<SlotProps = unknown>(options: {
-    /** The name of the slot */
-    name: string;
-    /** if the slot is an array or single object */
-    isArray?: boolean;
-    /** if each item should be wrapped in an asset */
-    wrapInAsset?: boolean;
-    /** Any children to render in the slot */
-    children?: React__default.ReactNode;
-    /** A text component if we hit a string but expect an asset */
-    TextComp?: React__default.ComponentType;
-    /** A component to create a collection asset is we get an array but need a single element */
-    CollectionComp?: React__default.ComponentType;
-}): (props: {
-    /** An object to include in this property */
-    children?: React__default.ReactNode;
-} & SlotProps) => React__default.JSX.Element;
-
-declare const IndexSuffixStopContext: React__default.Context<boolean>;
-/** Get the generated id */
-declare const useGetIdPrefix: () => string;
-/** Add a suffix to a generated id */
-declare const IDSuffixProvider: (props: WithChildren<{
-    /** The suffix to append */
-    suffix: string;
-}>) => React__default.JSX.Element;
-/** Override the generated id with the supplied one */
-declare const IDProvider: (props: WithChildren<{
-    /** The new id to use  */
-    id?: string;
-}>) => React__default.JSX.Element;
-/** Get the index of an item in a slot */
-declare const useIndexInSlot: (ref: React__default.RefObject<JsonNode>) => number;
-/** Add the index to the id path when in an array slot */
-declare const IDSuffixIndexProvider: (props: WithChildren<{
-    /** The ref to use */
-    wrapperRef: React__default.RefObject<JsonNode>;
-    /** if the suffix is in a template, the id to use */
-    templateIndex?: string;
-}>) => React__default.JSX.Element;
-/** Wrap a slot with the index if in an array slot */
-declare const OptionalIDSuffixProvider: (props: WithChildren<{
-    /** The ref to walk upwards and use as an index */
-    wrapperRef: React__default.RefObject<JsonNode>;
-    /** if the suffix is in a template, the id to use */
-    templateIndex?: string;
-}>) => React__default.JSX.Element;
-
-/** Get an array version of the value */
-declare function toArray<T>(val: T | Array<T>): Array<T>;
-/** Create a component version  */
-declare function toJsonElement(value: any, indexOrKey?: number | string, options?: toJsonOptions): React$1.ReactElement;
-/** Create a fragment for the properties */
-declare function toJsonProperties(value: Record<string, any>, options?: toJsonOptions): React$1.JSX.Element[];
-/** Create a text asset if needed */
-declare function normalizeText(options: {
-    /** The current node */
-    node: React$1.ReactNode;
-    /** A component to render a text asset */
-    TextComp?: React$1.ComponentType<any>;
-}): React$1.ReactNode;
-/** Create a collection if needed */
-declare function normalizeToCollection(options: {
-    /** the node to look at */
-    node: React$1.ReactNode;
-    /** A Text asset */
-    TextComp?: React$1.ComponentType;
-    /** A collection asset */
-    CollectionComp?: React$1.ComponentType<any>;
-}): string | number | boolean | Iterable<React$1.ReactNode> | React$1.JSX.Element | null | undefined;
-declare type ReactChildArray = ReturnType<typeof React$1.Children.toArray>;
-/**
- *
- * Hoisted from https://github.com/gregberge/react-flatten-children/blob/master/src/index.tsx
- * Peer dependencies were wrong and can't be reasonably patch it everywhere
- */
-declare function flattenChildren(children: React$1.ReactNode): ReactChildArray;
-
-interface SwitchProps {
-    /** defaults to a staticSwitch */
-    isDynamic?: boolean;
-}
-/**
- * Switches allow users to fork content between 1 or more assets
- */
-declare const Switch: {
-    (props: PropsWithChildren<SwitchProps>): React__default.JSX.Element;
-    Case: (props: PropsWithChildren<CaseProps>) => React__default.JSX.Element;
-};
-interface CaseProps {
-    /** the test for this case statement */
-    exp?: ExpressionTemplateInstance | BindingTemplateInstance | boolean;
-}
-
-interface TemplateContextType {
-    /** The number of nested templates */
-    depth: number;
-}
-declare const TemplateContext: React__default.Context<TemplateContextType>;
-interface TemplateProps {
-    /** The source binding */
-    data: BindingTemplateInstance;
-    /** The target property */
-    output?: string;
-    /** The template value */
-    children: React__default.ReactNode;
-    /** boolean that specifies whether template should recompute when data changes */
-    dynamic?: boolean;
-}
-/** A template allows users to dynamically map over an array of data */
-declare const Template: (props: TemplateProps) => React__default.JSX.Element;
-
-declare const SchemaTypeName: unique symbol;
-/**
- * Generator for `Schema.Schema` Objects
- */
-declare class SchemaGenerator {
-    private children;
-    private generatedDataTypes;
-    private logger;
-    hooks: {
-        createSchemaNode: SyncWaterfallHook<[node: Schema.DataType<unknown>, originalProperty: Record<string | symbol, unknown>], Record<string, any>>;
-    };
-    constructor(logger?: LoggingInterface);
-    /**
-     * Converts an object to a `Schema.Schema` representation
-     * Note: uses iteration to prevent potentially very deep recursion on large objects
-     */
-    toSchema: (schema: any) => Schema.Schema;
-    /**
-     * Processes the children of an object Node
-     * Newly discovered children get added to the provided array
-     */
-    private processChild;
-    /**
-     * Make an intermediate `Schema.DataType` object given a name
-     */
-    private makePlaceholderType;
-    /**
-     * Make an intermediate `Schema.DataType` object with array support given a name
-     */
-    private makePlaceholderArrayType;
-}
-declare type MakeArrayIntoIndexRef<T extends any[]> = {
-    [key: number]: MakeBindingRefable<T[0]>;
-    /** Used when referencing bindings from within a template */
-    _index_: MakeBindingRefable<T[0]>;
-} & BindingTemplateInstance;
-declare type MakeBindingRefable<T> = {
-    [P in keyof T]: T[P] extends object[] ? MakeArrayIntoIndexRef<T[P]> : T[P] extends unknown[] ? T[P] : MakeBindingRefable<T[P]>;
-} & BindingTemplateInstance;
-/**
- * Adds bindings to an object so that the object can be directly used in JSX
- */
-declare function makeBindingsForObject<Type>(obj: Type, arrayAccessorKeys?: string[]): MakeBindingRefable<Type>;
-/**
- * Generates binding for an object property
- */
-declare const getBindingFromObject: (obj: any) => BindingTemplateInstance;
-/**
- * Returns the binding string from an object path
- */
-declare const getBindingStringFromObject: (obj: any) => string;
-/**
- * Returns the ref string from an object path
- */
-declare const getRefStringFromObject: (obj: any) => string;
-
-declare type NavigationFlowReactViewState = Omit<NavigationFlowViewState, 'ref'> & {
-    /** The view element */
-    ref: React.ReactElement | string;
-};
-declare type NavFlowState = Exclude<NavigationFlowState, NavigationFlowViewState> | NavigationFlowReactViewState;
-declare type NavigationFlowWithReactView = Pick<NavigationFlow, 'startState' | 'onStart' | 'onEnd'> & {
-    [key: string]: undefined | string | Expression | ExpressionObject | NavFlowState;
-};
-declare type NavigationWithReactViews = Pick<Navigation$1, 'BEGIN'> & Record<string, string | NavigationFlowWithReactView>;
-declare type FlowWithoutUnknown = RemoveUnknownIndex<Flow>;
-declare type FlowWithReactViews = AddUnknownIndex<Omit<FlowWithoutUnknown, 'views' | 'navigation'> & {
-    /** An array of JSX view elements */
-    views?: Array<React.ReactElement>;
-    /** The navigation element */
-    navigation?: NavigationWithReactViews;
-}>;
-declare type DSLFlow = FlowWithReactViews;
-interface DSLSchema {
-    [key: string]: Schema.DataType | DSLSchema;
-}
-declare type SerializeType = 'view' | 'flow' | 'schema' | 'navigation';
-declare type SerializablePlayerExportTypes = React.ReactElement | FlowWithReactViews | Schema.Schema | Navigation$1;
-declare type LoggingInterface = Pick<Console, 'warn' | 'error' | 'log'>;
-declare type CompilationResult = {
-    /** What type of file is generated */
-    contentType: string;
-    /** The output path */
-    outputFile: string;
-    /** the input file */
-    inputFile: string;
-};
-declare type CompilerReturn = {
-    /** the JSON value of the source */
-    value: JsonType | undefined;
-    /** The sourcemap of the content */
-    sourceMap?: string;
-};
-/** The different type of default content items the compiler handles */
-declare const DefaultCompilerContentTypes: readonly ["view", "flow", "schema"];
-declare type DefaultCompilerContentType = typeof DefaultCompilerContentTypes[number];
-/** Helper function to determine whether a content type is compiler default */
-declare function isDefaultCompilerContentType(t: string): t is DefaultCompilerContentType;
-interface SerializeContext {
-    /** The type of the content being compiled */
-    type: DefaultCompilerContentType;
-}
-
-/**
- * Argument passed to the DSLCompiler onEnd hook
- * Defined as an object so additional fields can be added later without breaking API
- * */
-interface OnEndArg {
-    /** target output directory **/
-    output: string;
-}
-/** A compiler for transforming DSL content into JSON */
-declare class DSLCompiler {
-    readonly logger: LoggingInterface;
-    hooks: {
-        schemaGenerator: SyncHook<[SchemaGenerator], Record<string, any>>;
-        preProcessFlow: AsyncSeriesWaterfallHook<[object], Record<string, any>>;
-        postProcessFlow: AsyncSeriesWaterfallHook<[Flow<_player_ui_types.Asset<string>>], Record<string, any>>;
-        onEnd: AsyncSeriesHook<[OnEndArg], Record<string, any>>;
-    };
-    constructor(logger?: LoggingInterface);
-    /** Convert an object (flow, view, schema, etc) into it's JSON representation */
-    serialize(value: unknown, context?: SerializeContext): Promise<CompilerReturn | undefined>;
-}
-
-/** Basic way of identifying the type of file based on the default content export */
-declare const fingerprintContent: (content: unknown, filename?: string) => DefaultCompilerContentType | undefined;
-
-export { AddUnknownIndex, Asset, AssetProps, AssetPropsWithChildren, AssetWrapper, BindingTemplateInstance, CaseProps, CompilationResult, CompilerReturn, DSLCompiler, DSLFlow, DSLSchema, DefaultCompilerContentType, ExpressionTemplateInstance, FlowWithReactViews, FlowWithoutUnknown, GeneratedIDProperty, IDProvider, IDSuffixIndexProvider, IDSuffixProvider, IndexSuffixStopContext, LoggingInterface, MakeArrayIntoIndexRef, MakeBindingRefable, NavFlowState, Navigation, NavigationFlowReactViewState, NavigationFlowWithReactView, NavigationWithReactViews, OmitProp, OnEndArg, OptionalIDSuffixProvider, PlayerApplicability, RemoveUnknownIndex, SchemaGenerator, SchemaTypeName, SerializablePlayerExportTypes, SerializeContext, SerializeType, Slot, SlotContext, SwapKeysToType, Switch, SwitchProps, Template, TemplateContext, TemplateContextType, TemplateInstanceRefStringContext, TemplateInstanceRefStringOptions, TemplateProps, TemplateRefStringOptions, TemplateStringComponent, TemplateStringType, View, WithChildren, WithTemplateTypes, binding, createSlot, expression, fingerprintContent, flattenChildren, getBindingFromObject, getBindingStringFromObject, getRefStringFromObject, isDefaultCompilerContentType, isTemplateStringInstance, makeBindingsForObject, normalizeText, normalizeToCollection, toArray, toJsonElement, toJsonOptions, toJsonProperties, useGetIdPrefix, useIndexInSlot };