@ruya.sa/richtext-lexical 3.71.7

package/dist/features/typesServer.d.ts

@@ -0,0 +1,332 @@
+import type { GenericLanguages, I18n, I18nClient } from '@ruya.sa/translations';
+import type { JSONSchema4 } from 'json-schema';
+import type { Klass, LexicalNode, LexicalNodeReplacement, SerializedEditorState, SerializedLexicalNode } from 'lexical';
+import type { Field, FieldSchemaMap, ImportMapGenerators, JsonObject, PayloadComponent, PayloadRequest, PopulateType, ReplaceAny, RequestContext, RichTextField, RichTextHooks, SanitizedConfig, TypedFallbackLocale, ValidateOptions, ValidationFieldError } from '@ruya.sa/payload';
+import type { ServerEditorConfig } from '../lexical/config/types.js';
+import type { Transformer } from '../packages/@lexical/markdown/index.js';
+import type { LexicalRichTextField } from '../types.js';
+import type { HTMLConverter } from './converters/lexicalToHtml_deprecated/converter/types.js';
+import type { BaseClientFeatureProps } from './typesClient.js';
+export type PopulationPromise<T extends SerializedLexicalNode = SerializedLexicalNode> = (args: {
+    context: RequestContext;
+    currentDepth: number;
+    depth: number;
+    draft: boolean;
+    /**
+     * This maps all population promises to the node type
+     */
+    editorPopulationPromises: Map<string, Array<PopulationPromise>>;
+    field: LexicalRichTextField;
+    /**
+     * fieldPromises are used for things like field hooks. They will be awaited before awaiting populationPromises
+     */
+    fieldPromises: Promise<void>[];
+    findMany: boolean;
+    flattenLocales: boolean;
+    node: T;
+    overrideAccess: boolean;
+    parentIsLocalized: boolean;
+    populationPromises: Promise<void>[];
+    req: PayloadRequest;
+    showHiddenFields: boolean;
+    siblingDoc: JsonObject;
+}) => void;
+export type NodeValidation<T extends SerializedLexicalNode = SerializedLexicalNode> = ({ node, nodeValidations, validation, }: {
+    node: T;
+    nodeValidations: Map<string, Array<NodeValidation>>;
+    validation: {
+        options: ValidateOptions<unknown, unknown, RichTextField, SerializedEditorState>;
+        value: SerializedEditorState;
+    };
+}) => Promise<string | true> | string | true;
+export type FeatureProviderProviderServer<UnSanitizedServerFeatureProps = undefined, ServerFeatureProps = UnSanitizedServerFeatureProps, ClientFeatureProps = undefined> = (props?: UnSanitizedServerFeatureProps) => FeatureProviderServer<UnSanitizedServerFeatureProps, ServerFeatureProps, ClientFeatureProps>;
+export type FeatureProviderServer<UnSanitizedServerFeatureProps = undefined, ServerFeatureProps = UnSanitizedServerFeatureProps, ClientFeatureProps = undefined> = {
+    /** Keys of dependencies needed for this feature. These dependencies do not have to be loaded first, but they have to exist, otherwise an error will be thrown. */
+    dependencies?: string[];
+    /**  Keys of priority dependencies needed for this feature. These dependencies have to be loaded first AND have to exist, otherwise an error will be thrown. They will be available in the `feature` property. */
+    dependenciesPriority?: string[];
+    /** Keys of soft-dependencies needed for this feature. These are optional. Payload will attempt to load them before this feature, but doesn't throw an error if that's not possible. */
+    dependenciesSoft?: string[];
+    /**
+     * This is being called during the payload sanitization process
+     */
+    feature: ((props: {
+        config: SanitizedConfig;
+        /** unSanitizedEditorConfig.features, but mapped */
+        featureProviderMap: ServerFeatureProviderMap;
+        isRoot?: boolean;
+        parentIsLocalized: boolean;
+        resolvedFeatures: ResolvedServerFeatureMap;
+        unSanitizedEditorConfig: ServerEditorConfig;
+    }) => Promise<ServerFeature<ServerFeatureProps, ClientFeatureProps>> | ServerFeature<ServerFeatureProps, ClientFeatureProps>) | ServerFeature<ServerFeatureProps, ClientFeatureProps>;
+    key: string;
+    /** Props which were passed into your feature will have to be passed here. This will allow them to be used / read in other places of the code, e.g. wherever you can use useEditorConfigContext */
+    serverFeatureProps: UnSanitizedServerFeatureProps;
+};
+export type AfterReadNodeHookArgs<T extends SerializedLexicalNode> = {
+    /**
+     * Only available in `afterRead` hooks.
+     */
+    currentDepth: number;
+    /**
+     * Only available in `afterRead` hooks.
+     */
+    depth: number;
+    draft: boolean;
+    fallbackLocale: TypedFallbackLocale;
+    /**
+     *  Only available in `afterRead` field hooks.
+     */
+    fieldPromises: Promise<void>[];
+    /** Boolean to denote if this hook is running against finding one, or finding many within the afterRead hook. */
+    findMany: boolean;
+    flattenLocales: boolean;
+    /**
+     * The requested locale.
+     */
+    locale: string;
+    overrideAccess: boolean;
+    /**
+     * Only available in `afterRead` hooks.
+     */
+    populateArg?: PopulateType;
+    /**
+     *  Only available in `afterRead` field hooks.
+     */
+    populationPromises: Promise<void>[];
+    /**
+     * Only available in `afterRead` hooks.
+     */
+    showHiddenFields: boolean;
+    /**
+     * Only available in `afterRead` hooks.
+     */
+    triggerAccessControl: boolean;
+    /**
+     * Only available in `afterRead` hooks.
+     */
+    triggerHooks: boolean;
+};
+export type AfterChangeNodeHookArgs<T extends SerializedLexicalNode> = {
+    /** A string relating to which operation the field type is currently executing within. Useful within beforeValidate, beforeChange, and afterChange hooks to differentiate between create and update operations. */
+    operation: 'create' | 'delete' | 'read' | 'update';
+    /** The value of the node before any changes. Not available in afterRead hooks */
+    originalNode: T;
+    previousNode: T;
+};
+export type BeforeValidateNodeHookArgs<T extends SerializedLexicalNode> = {
+    /** A string relating to which operation the field type is currently executing within. Useful within beforeValidate, beforeChange, and afterChange hooks to differentiate between create and update operations. */
+    operation: 'create' | 'delete' | 'read' | 'update';
+    /** The value of the node before any changes. Not available in afterRead hooks */
+    originalNode: T;
+    overrideAccess: boolean;
+};
+export type BeforeChangeNodeHookArgs<T extends SerializedLexicalNode> = {
+    /**
+     * Only available in `beforeChange` hooks.
+     */
+    errors: ValidationFieldError[];
+    mergeLocaleActions: (() => Promise<void> | void)[];
+    /** A string relating to which operation the field type is currently executing within. Useful within beforeValidate, beforeChange, and afterChange hooks to differentiate between create and update operations. */
+    operation: 'create' | 'delete' | 'read' | 'update';
+    /** The value of the node before any changes. Not available in afterRead hooks */
+    originalNode: T;
+    /**
+     * The original node with locales (not modified by any hooks).
+     */
+    originalNodeWithLocales?: T;
+    previousNode: T;
+    skipValidation: boolean;
+};
+export type BaseNodeHookArgs<T extends SerializedLexicalNode> = {
+    context: RequestContext;
+    /** The value of the node. */
+    node: T;
+    parentRichTextFieldPath: (number | string)[];
+    parentRichTextFieldSchemaPath: string[];
+    /** The payload request object. It is mocked for Local API operations. */
+    req: PayloadRequest;
+};
+export type AfterReadNodeHook<T extends SerializedLexicalNode> = (args: AfterReadNodeHookArgs<T> & BaseNodeHookArgs<T>) => Promise<T> | T;
+export type AfterChangeNodeHook<T extends SerializedLexicalNode> = (args: AfterChangeNodeHookArgs<T> & BaseNodeHookArgs<T>) => Promise<T> | T;
+export type BeforeChangeNodeHook<T extends SerializedLexicalNode> = (args: BaseNodeHookArgs<T> & BeforeChangeNodeHookArgs<T>) => Promise<T> | T;
+export type BeforeValidateNodeHook<T extends SerializedLexicalNode> = (args: BaseNodeHookArgs<T> & BeforeValidateNodeHookArgs<T>) => Promise<T> | T;
+export type NodeWithHooks<T extends LexicalNode = any> = {
+    /**
+     * Allows you to define how a node can be serialized into different formats. Currently, only supports html.
+     * Markdown converters are defined in `markdownTransformers` and not here.
+     *
+     * @deprecated - will be removed in 4.0
+     */
+    converters?: {
+        /**
+         * @deprecated - will be removed in 4.0
+         */
+        html?: HTMLConverter<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>;
+    };
+    /**
+     * If a node includes sub-fields (e.g. block and link nodes), passing those subFields here will make payload
+     * automatically populate, run hooks, and generate component import maps for them
+     */
+    getSubFields?: (args: {
+        /**
+         * Optional. If not provided, all possible sub-fields should be returned.
+         */
+        node?: ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>;
+        req?: PayloadRequest;
+    }) => Field[] | null;
+    /**
+     * If a node includes sub-fields, the sub-fields data needs to be returned here, alongside `getSubFields` which returns their schema.
+     */
+    getSubFieldsData?: (args: {
+        node: ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>;
+        req: PayloadRequest;
+    }) => JsonObject;
+    /**
+     * Allows you to run population logic when a node's data was requested from graphQL.
+     * While `getSubFields` and `getSubFieldsData` automatically handle populating sub-fields (since they run hooks on them), those are only populated in the Rest API.
+     * This is because the Rest API hooks do not have access to the 'depth' property provided by graphQL.
+     * In order for them to be populated correctly in graphQL, the population logic needs to be provided here.
+     */
+    graphQLPopulationPromises?: Array<PopulationPromise<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>>;
+    /**
+     * Just like payload fields, you can provide hooks which are run for this specific node. These are called Node Hooks.
+     */
+    hooks?: {
+        afterChange?: Array<AfterChangeNodeHook<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>>;
+        afterRead?: Array<AfterReadNodeHook<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>>;
+        beforeChange?: Array<BeforeChangeNodeHook<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>>;
+        beforeValidate?: Array<BeforeValidateNodeHook<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>>;
+    };
+    /**
+     * The actual lexical node needs to be provided here. This also supports [lexical node replacements](https://lexical.dev/docs/concepts/node-replacement).
+     */
+    node: Klass<T> | LexicalNodeReplacement;
+    /**
+     * This allows you to provide node validations, which are run when your document is being validated, alongside other payload fields.
+     * You can use it to throw a validation error for a specific node in case its data is incorrect.
+     */
+    validations?: Array<NodeValidation<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>>;
+};
+export type ServerFeature<ServerProps, ClientFeatureProps> = {
+    ClientFeature?: PayloadComponent<never, BaseClientFeatureProps<ClientFeatureProps>>;
+    /**
+     * This determines what props will be available on the Client.
+     */
+    clientFeatureProps?: ClientFeatureProps;
+    /**
+     * Adds payload components to the importMap.
+     *
+     * If an object is provided, the imported components will automatically be made available to the client feature, keyed by the object's keys.
+     */
+    componentImports?: {
+        [key: string]: PayloadComponent;
+    } | ImportMapGenerators[0] | PayloadComponent[];
+    generatedTypes?: {
+        modifyOutputSchema: (args: {
+            collectionIDFieldTypes: {
+                [key: string]: 'number' | 'string';
+            };
+            config?: SanitizedConfig;
+            /**
+             * Current schema which will be modified by this function.
+             */
+            currentSchema: JSONSchema4;
+            field: LexicalRichTextField;
+            i18n?: I18n;
+            /**
+             * Allows you to define new top-level interfaces that can be re-used in the output schema.
+             */
+            interfaceNameDefinitions: Map<string, JSONSchema4>;
+            isRequired: boolean;
+        }) => JSONSchema4;
+    };
+    generateSchemaMap?: (args: {
+        config: SanitizedConfig;
+        field: RichTextField;
+        i18n: I18nClient;
+        props: ServerProps;
+        schemaMap: FieldSchemaMap;
+        schemaPath: string;
+    }) => FieldSchemaMap | null;
+    hooks?: RichTextHooks;
+    /**
+     * Here you can provide i18n translations for your feature. These will only be available on the server and client.
+     *
+     * Translations here are automatically scoped to `lexical.featureKey.yourKey`
+     *
+     * @Example
+     * ```ts
+     * i18n: {
+     *   en: {
+     *     label: 'Horizontal Rule',
+     *   },
+     *   de: {
+     *     label: 'Trennlinie',
+     *   },
+     * }
+     * ```
+     * In order to access these translations, you would use `i18n.t('lexical:horizontalRule:label')`.
+     */
+    i18n?: Partial<GenericLanguages>;
+    markdownTransformers?: (((props: {
+        allNodes: Array<NodeWithHooks>;
+        allTransformers: Transformer[];
+    }) => Transformer) | Transformer)[];
+    nodes?: Array<NodeWithHooks>;
+    /** Props which were passed into your feature will have to be passed here. This will allow them to be used / read in other places of the code, e.g. wherever you can use useEditorConfigContext */
+    sanitizedServerFeatureProps?: ServerProps;
+};
+export type ResolvedServerFeature<ServerProps, ClientFeatureProps> = {
+    order: number;
+} & Required<Pick<FeatureProviderServer<ServerProps, ClientFeatureProps>, 'dependencies' | 'dependenciesPriority' | 'dependenciesSoft' | 'key'>> & ServerFeature<ServerProps, ClientFeatureProps>;
+export type ResolvedServerFeatureMap = Map<string, ResolvedServerFeature<any, any>>;
+export type ServerFeatureProviderMap = Map<string, FeatureProviderServer<any, any, any>>;
+export type SanitizedServerFeatures = {
+    /**  The node types mapped to their converters */
+    converters: {
+        html: HTMLConverter[];
+    };
+    /** The keys of all enabled features */
+    enabledFeatures: string[];
+    generatedTypes: {
+        modifyOutputSchemas: Array<(args: {
+            collectionIDFieldTypes: {
+                [key: string]: 'number' | 'string';
+            };
+            config?: SanitizedConfig;
+            /**
+             * Current schema which will be modified by this function.
+             */
+            currentSchema: JSONSchema4;
+            field: LexicalRichTextField;
+            i18n?: I18n;
+            /**
+             * Allows you to define new top-level interfaces that can be re-used in the output schema.
+             */
+            interfaceNameDefinitions: Map<string, JSONSchema4>;
+            isRequired: boolean;
+        }) => JSONSchema4>;
+    };
+    /**  The node types mapped to their hooks */
+    getSubFields?: Map<string, (args: {
+        node: SerializedLexicalNode;
+        req: PayloadRequest;
+    }) => Field[] | null>;
+    getSubFieldsData?: Map<string, (args: {
+        node: SerializedLexicalNode;
+        req: PayloadRequest;
+    }) => JsonObject>;
+    graphQLPopulationPromises: Map<string, Array<PopulationPromise>>;
+    hooks: RichTextHooks;
+    markdownTransformers: Transformer[];
+    nodeHooks?: {
+        afterChange?: Map<string, Array<AfterChangeNodeHook<SerializedLexicalNode>>>;
+        afterRead?: Map<string, Array<AfterReadNodeHook<SerializedLexicalNode>>>;
+        beforeChange?: Map<string, Array<BeforeChangeNodeHook<SerializedLexicalNode>>>;
+        beforeValidate?: Map<string, Array<BeforeValidateNodeHook<SerializedLexicalNode>>>;
+    }; /**  The node types mapped to their populationPromises */
+    /**  The node types mapped to their validations */
+    validations: Map<string, Array<NodeValidation>>;
+} & Required<Pick<ResolvedServerFeature<any, any>, 'i18n' | 'nodes'>>;
+//# sourceMappingURL=typesServer.d.ts.map

package/dist/features/typesServer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesServer.d.ts","sourceRoot":"","sources":["../../src/features/typesServer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAA;AAC/E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,KAAK,EACV,KAAK,EACL,WAAW,EACX,sBAAsB,EACtB,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,SAAS,CAAA;AAChB,OAAO,KAAK,EACV,KAAK,EACL,cAAc,EACd,mBAAmB,EACnB,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,UAAU,EACV,cAAc,EACd,aAAa,EACb,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,oBAAoB,EACrB,MAAM,kBAAkB,CAAA;AAEzB,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AACpE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AACzE,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AACvD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0DAA0D,CAAA;AAC7F,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAA;AAE9D,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,qBAAqB,GAAG,qBAAqB,IAAI,CAAC,IAAI,EAAE;IAC9F,OAAO,EAAE,cAAc,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,OAAO,CAAA;IACd;;OAEG;IACH,wBAAwB,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAA;IAC/D,KAAK,EAAE,oBAAoB,CAAA;IAC3B;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAA;IAC9B,QAAQ,EAAE,OAAO,CAAA;IACjB,cAAc,EAAE,OAAO,CAAA;IACvB,IAAI,EAAE,CAAC,CAAA;IACP,cAAc,EAAE,OAAO,CAAA;IACvB,iBAAiB,EAAE,OAAO,CAAA;IAC1B,kBAAkB,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAA;IACnC,GAAG,EAAE,cAAc,CAAA;IACnB,gBAAgB,EAAE,OAAO,CAAA;IACzB,UAAU,EAAE,UAAU,CAAA;CACvB,KAAK,IAAI,CAAA;AAEV,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,qBAAqB,GAAG,qBAAqB,IAAI,CAAC,EACrF,IAAI,EACJ,eAAe,EACf,UAAU,GACX,EAAE;IACD,IAAI,EAAE,CAAC,CAAA;IACP,eAAe,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC,CAAA;IACnD,UAAU,EAAE;QACV,OAAO,EAAE,eAAe,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,qBAAqB,CAAC,CAAA;QAChF,KAAK,EAAE,qBAAqB,CAAA;KAC7B,CAAA;CACF,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,GAAG,MAAM,GAAG,IAAI,CAAA;AAE5C,MAAM,MAAM,6BAA6B,CACvC,6BAA6B,GAAG,SAAS,EACzC,kBAAkB,GAAG,6BAA6B,EAClD,kBAAkB,GAAG,SAAS,IAC5B,CACF,KAAK,CAAC,EAAE,6BAA6B,KAClC,qBAAqB,CAAC,6BAA6B,EAAE,kBAAkB,EAAE,kBAAkB,CAAC,CAAA;AAEjG,MAAM,MAAM,qBAAqB,CAC/B,6BAA6B,GAAG,SAAS,EACzC,kBAAkB,GAAG,6BAA6B,EAClD,kBAAkB,GAAG,SAAS,IAC5B;IACF,kKAAkK;IAClK,YAAY,CAAC,EAAE,MAAM,EAAE,CAAA;IACvB,iNAAiN;IACjN,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC/B,uLAAuL;IACvL,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAE3B;;OAEG;IACH,OAAO,EACH,CAAC,CAAC,KAAK,EAAE;QACP,MAAM,EAAE,eAAe,CAAA;QACvB,mDAAmD;QACnD,kBAAkB,EAAE,wBAAwB,CAAA;QAC5C,MAAM,CAAC,EAAE,OAAO,CAAA;QAChB,iBAAiB,EAAE,OAAO,CAAA;QAE1B,gBAAgB,EAAE,wBAAwB,CAAA;QAE1C,uBAAuB,EAAE,kBAAkB,CAAA;KAC5C,KACG,OAAO,CAAC,aAAa,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC,GAC9D,aAAa,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAC,GAC1D,aAAa,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAAA;IACzD,GAAG,EAAE,MAAM,CAAA;IACX,kMAAkM;IAClM,kBAAkB,EAAE,6BAA6B,CAAA;CAClD,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,CAAC,SAAS,qBAAqB,IAAI;IACnE;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,OAAO,CAAA;IACd,cAAc,EAAE,mBAAmB,CAAA;IACnC;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAA;IAC9B,gHAAgH;IAChH,QAAQ,EAAE,OAAO,CAAA;IACjB,cAAc,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd,cAAc,EAAE,OAAO,CAAA;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,CAAA;IAC1B;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,CAAA;IACnC;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAA;IACzB;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAA;IAC7B;;OAEG;IACH,YAAY,EAAE,OAAO,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,uBAAuB,CAAC,CAAC,SAAS,qBAAqB,IAAI;IACrE,kNAAkN;IAClN,SAAS,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAClD,iFAAiF;IACjF,YAAY,EAAE,CAAC,CAAA;IACf,YAAY,EAAE,CAAC,CAAA;CAChB,CAAA;AACD,MAAM,MAAM,0BAA0B,CAAC,CAAC,SAAS,qBAAqB,IAAI;IACxE,kNAAkN;IAClN,SAAS,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAClD,iFAAiF;IACjF,YAAY,EAAE,CAAC,CAAA;IACf,cAAc,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,qBAAqB,IAAI;IACtE;;OAEG;IACH,MAAM,EAAE,oBAAoB,EAAE,CAAA;IAC9B,kBAAkB,EAAE,CAAC,MAAM,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,EAAE,CAAA;IAClD,kNAAkN;IAClN,SAAS,EAAE,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAClD,iFAAiF;IACjF,YAAY,EAAE,CAAC,CAAA;IACf;;OAEG;IACH,uBAAuB,CAAC,EAAE,CAAC,CAAA;IAC3B,YAAY,EAAE,CAAC,CAAA;IAEf,cAAc,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,qBAAqB,IAAI;IAC9D,OAAO,EAAE,cAAc,CAAA;IACvB,6BAA6B;IAC7B,IAAI,EAAE,CAAC,CAAA;IACP,uBAAuB,EAAE,CAAC,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;IAC5C,6BAA6B,EAAE,MAAM,EAAE,CAAA;IACvC,yEAAyE;IACzE,GAAG,EAAE,cAAc,CAAA;CACpB,CAAA;AAED,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,qBAAqB,IAAI,CAC/D,IAAI,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,KACjD,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAEnB,MAAM,MAAM,mBAAmB,CAAC,CAAC,SAAS,qBAAqB,IAAI,CACjE,IAAI,EAAE,uBAAuB,CAAC,CAAC,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,KACnD,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAEnB,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,qBAAqB,IAAI,CAClE,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC,KACpD,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAEnB,MAAM,MAAM,sBAAsB,CAAC,CAAC,SAAS,qBAAqB,IAAI,CACpE,IAAI,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,0BAA0B,CAAC,CAAC,CAAC,KACtD,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;AAGnB,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,GAAG,IAAI;IACvD;;;;;OAKG;IACH,UAAU,CAAC,EAAE;QACX;;WAEG;QACH,IAAI,CAAC,EAAE,aAAa,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;KAC3E,CAAA;IACD;;;OAGG;IACH,YAAY,CAAC,EAAE,CAAC,IAAI,EAAE;QACpB;;WAEG;QACH,IAAI,CAAC,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;QAC3D,GAAG,CAAC,EAAE,cAAc,CAAA;KACrB,KAAK,KAAK,EAAE,GAAG,IAAI,CAAA;IACpB;;OAEG;IACH,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE;QACxB,IAAI,EAAE,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAA;QAC1D,GAAG,EAAE,cAAc,CAAA;KACpB,KAAK,UAAU,CAAA;IAChB;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,KAAK,CAC/B,iBAAiB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CACxE,CAAA;IACD;;OAEG;IACH,KAAK,CAAC,EAAE;QACN,WAAW,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;QAC9F,SAAS,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;QAC1F,YAAY,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;QAChG,cAAc,CAAC,EAAE,KAAK,CACpB,sBAAsB,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAC7E,CAAA;KACF,CAAA;IACD;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,sBAAsB,CAAA;IACvC;;;OAGG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC,EAAE,WAAW,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAA;CAC1F,CAAA;AAED,MAAM,MAAM,aAAa,CAAC,WAAW,EAAE,kBAAkB,IAAI;IAC3D,aAAa,CAAC,EAAE,gBAAgB,CAAC,KAAK,EAAE,sBAAsB,CAAC,kBAAkB,CAAC,CAAC,CAAA;IACnF;;OAEG;IACH,kBAAkB,CAAC,EAAE,kBAAkB,CAAA;IACvC;;;;OAIG;IACH,gBAAgB,CAAC,EACb;QACE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAA;KAChC,GACD,mBAAmB,CAAC,CAAC,CAAC,GACtB,gBAAgB,EAAE,CAAA;IACtB,cAAc,CAAC,EAAE;QACf,kBAAkB,EAAE,CAAC,IAAI,EAAE;YACzB,sBAAsB,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAA;aAAE,CAAA;YAC9D,MAAM,CAAC,EAAE,eAAe,CAAA;YACxB;;eAEG;YACH,aAAa,EAAE,WAAW,CAAA;YAC1B,KAAK,EAAE,oBAAoB,CAAA;YAC3B,IAAI,CAAC,EAAE,IAAI,CAAA;YACX;;eAEG;YACH,wBAAwB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;YAClD,UAAU,EAAE,OAAO,CAAA;SACpB,KAAK,WAAW,CAAA;KAClB,CAAA;IACD,iBAAiB,CAAC,EAAE,CAAC,IAAI,EAAE;QACzB,MAAM,EAAE,eAAe,CAAA;QACvB,KAAK,EAAE,aAAa,CAAA;QACpB,IAAI,EAAE,UAAU,CAAA;QAChB,KAAK,EAAE,WAAW,CAAA;QAClB,SAAS,EAAE,cAAc,CAAA;QACzB,UAAU,EAAE,MAAM,CAAA;KACnB,KAAK,cAAc,GAAG,IAAI,CAAA;IAC3B,KAAK,CAAC,EAAE,aAAa,CAAA;IACrB;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAA;IAChC,oBAAoB,CAAC,EAAE,CACnB,CAAC,CAAC,KAAK,EAAE;QAAE,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;QAAC,eAAe,EAAE,WAAW,EAAE,CAAA;KAAE,KAAK,WAAW,CAAC,GAC5F,WAAW,CACd,EAAE,CAAA;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,CAAA;IAE5B,kMAAkM;IAClM,2BAA2B,CAAC,EAAE,WAAW,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,WAAW,EAAE,kBAAkB,IAAI;IACnE,KAAK,EAAE,MAAM,CAAA;CACd,GAAG,QAAQ,CACV,IAAI,CACF,qBAAqB,CAAC,WAAW,EAAE,kBAAkB,CAAC,EACtD,cAAc,GAAG,sBAAsB,GAAG,kBAAkB,GAAG,KAAK,CACrE,CACF,GACC,aAAa,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAA;AAEhD,MAAM,MAAM,wBAAwB,GAAG,GAAG,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;AAEnF,MAAM,MAAM,wBAAwB,GAAG,GAAG,CAAC,MAAM,EAAE,qBAAqB,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAA;AAExF,MAAM,MAAM,uBAAuB,GAAG;IACpC,iDAAiD;IACjD,UAAU,EAAE;QACV,IAAI,EAAE,aAAa,EAAE,CAAA;KACtB,CAAA;IACD,uCAAuC;IACvC,eAAe,EAAE,MAAM,EAAE,CAAA;IACzB,cAAc,EAAE;QACd,mBAAmB,EAAE,KAAK,CACxB,CAAC,IAAI,EAAE;YACL,sBAAsB,EAAE;gBAAE,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAA;aAAE,CAAA;YAC9D,MAAM,CAAC,EAAE,eAAe,CAAA;YACxB;;eAEG;YACH,aAAa,EAAE,WAAW,CAAA;YAC1B,KAAK,EAAE,oBAAoB,CAAA;YAC3B,IAAI,CAAC,EAAE,IAAI,CAAA;YACX;;eAEG;YACH,wBAAwB,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;YAClD,UAAU,EAAE,OAAO,CAAA;SACpB,KAAK,WAAW,CAClB,CAAA;KACF,CAAA;IACD,4CAA4C;IAE5C,YAAY,CAAC,EAAE,GAAG,CAChB,MAAM,EACN,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,qBAAqB,CAAC;QAAC,GAAG,EAAE,cAAc,CAAA;KAAE,KAAK,KAAK,EAAE,GAAG,IAAI,CAC/E,CAAA;IACD,gBAAgB,CAAC,EAAE,GAAG,CACpB,MAAM,EACN,CAAC,IAAI,EAAE;QAAE,IAAI,EAAE,qBAAqB,CAAC;QAAC,GAAG,EAAE,cAAc,CAAA;KAAE,KAAK,UAAU,CAC3E,CAAA;IACD,yBAAyB,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAC,CAAA;IAChE,KAAK,EAAE,aAAa,CAAA;IACpB,oBAAoB,EAAE,WAAW,EAAE,CAAA;IACnC,SAAS,CAAC,EAAE;QACV,WAAW,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QAC5E,SAAS,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QACxE,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,oBAAoB,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QAC9E,cAAc,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,sBAAsB,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;KACnF,CAAA,CAAC,yDAAyD;IAC3D,kDAAkD;IAClD,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC,CAAA;CAChD,GAAG,QAAQ,CAAC,IAAI,CAAC,qBAAqB,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAA"}

package/dist/features/typesServer.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=typesServer.js.map

package/dist/features/typesServer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typesServer.js","names":[],"sources":["../../src/features/typesServer.ts"],"sourcesContent":["import type { GenericLanguages, I18n, I18nClient } from '@ruya.sa/translations'\nimport type { JSONSchema4 } from 'json-schema'\nimport type {\n  Klass,\n  LexicalNode,\n  LexicalNodeReplacement,\n  SerializedEditorState,\n  SerializedLexicalNode,\n} from 'lexical'\nimport type {\n  Field,\n  FieldSchemaMap,\n  ImportMapGenerators,\n  JsonObject,\n  PayloadComponent,\n  PayloadRequest,\n  PopulateType,\n  ReplaceAny,\n  RequestContext,\n  RichTextField,\n  RichTextHooks,\n  SanitizedConfig,\n  TypedFallbackLocale,\n  ValidateOptions,\n  ValidationFieldError,\n} from '@ruya.sa/payload'\n\nimport type { ServerEditorConfig } from '../lexical/config/types.js'\nimport type { Transformer } from '../packages/@lexical/markdown/index.js'\nimport type { LexicalRichTextField } from '../types.js'\nimport type { HTMLConverter } from './converters/lexicalToHtml_deprecated/converter/types.js'\nimport type { BaseClientFeatureProps } from './typesClient.js'\n\nexport type PopulationPromise<T extends SerializedLexicalNode = SerializedLexicalNode> = (args: {\n  context: RequestContext\n  currentDepth: number\n  depth: number\n  draft: boolean\n  /**\n   * This maps all population promises to the node type\n   */\n  editorPopulationPromises: Map<string, Array<PopulationPromise>>\n  field: LexicalRichTextField\n  /**\n   * fieldPromises are used for things like field hooks. They will be awaited before awaiting populationPromises\n   */\n  fieldPromises: Promise<void>[]\n  findMany: boolean\n  flattenLocales: boolean\n  node: T\n  overrideAccess: boolean\n  parentIsLocalized: boolean\n  populationPromises: Promise<void>[]\n  req: PayloadRequest\n  showHiddenFields: boolean\n  siblingDoc: JsonObject\n}) => void\n\nexport type NodeValidation<T extends SerializedLexicalNode = SerializedLexicalNode> = ({\n  node,\n  nodeValidations,\n  validation,\n}: {\n  node: T\n  nodeValidations: Map<string, Array<NodeValidation>>\n  validation: {\n    options: ValidateOptions<unknown, unknown, RichTextField, SerializedEditorState>\n    value: SerializedEditorState\n  }\n}) => Promise<string | true> | string | true\n\nexport type FeatureProviderProviderServer<\n  UnSanitizedServerFeatureProps = undefined,\n  ServerFeatureProps = UnSanitizedServerFeatureProps,\n  ClientFeatureProps = undefined,\n> = (\n  props?: UnSanitizedServerFeatureProps,\n) => FeatureProviderServer<UnSanitizedServerFeatureProps, ServerFeatureProps, ClientFeatureProps>\n\nexport type FeatureProviderServer<\n  UnSanitizedServerFeatureProps = undefined,\n  ServerFeatureProps = UnSanitizedServerFeatureProps,\n  ClientFeatureProps = undefined,\n> = {\n  /** Keys of dependencies needed for this feature. These dependencies do not have to be loaded first, but they have to exist, otherwise an error will be thrown. */\n  dependencies?: string[]\n  /**  Keys of priority dependencies needed for this feature. These dependencies have to be loaded first AND have to exist, otherwise an error will be thrown. They will be available in the `feature` property. */\n  dependenciesPriority?: string[]\n  /** Keys of soft-dependencies needed for this feature. These are optional. Payload will attempt to load them before this feature, but doesn't throw an error if that's not possible. */\n  dependenciesSoft?: string[]\n\n  /**\n   * This is being called during the payload sanitization process\n   */\n  feature:\n    | ((props: {\n        config: SanitizedConfig\n        /** unSanitizedEditorConfig.features, but mapped */\n        featureProviderMap: ServerFeatureProviderMap\n        isRoot?: boolean\n        parentIsLocalized: boolean\n        // other resolved features, which have been loaded before this one. All features declared in 'dependencies' should be available here\n        resolvedFeatures: ResolvedServerFeatureMap\n        // unSanitized EditorConfig,\n        unSanitizedEditorConfig: ServerEditorConfig\n      }) =>\n        | Promise<ServerFeature<ServerFeatureProps, ClientFeatureProps>>\n        | ServerFeature<ServerFeatureProps, ClientFeatureProps>)\n    | ServerFeature<ServerFeatureProps, ClientFeatureProps>\n  key: string\n  /** Props which were passed into your feature will have to be passed here. This will allow them to be used / read in other places of the code, e.g. wherever you can use useEditorConfigContext */\n  serverFeatureProps: UnSanitizedServerFeatureProps\n}\n\nexport type AfterReadNodeHookArgs<T extends SerializedLexicalNode> = {\n  /**\n   * Only available in `afterRead` hooks.\n   */\n  currentDepth: number\n  /**\n   * Only available in `afterRead` hooks.\n   */\n  depth: number\n  draft: boolean\n  fallbackLocale: TypedFallbackLocale\n  /**\n   *  Only available in `afterRead` field hooks.\n   */\n  fieldPromises: Promise<void>[]\n  /** Boolean to denote if this hook is running against finding one, or finding many within the afterRead hook. */\n  findMany: boolean\n  flattenLocales: boolean\n  /**\n   * The requested locale.\n   */\n  locale: string\n  overrideAccess: boolean\n  /**\n   * Only available in `afterRead` hooks.\n   */\n  populateArg?: PopulateType\n  /**\n   *  Only available in `afterRead` field hooks.\n   */\n  populationPromises: Promise<void>[]\n  /**\n   * Only available in `afterRead` hooks.\n   */\n  showHiddenFields: boolean\n  /**\n   * Only available in `afterRead` hooks.\n   */\n  triggerAccessControl: boolean\n  /**\n   * Only available in `afterRead` hooks.\n   */\n  triggerHooks: boolean\n}\n\nexport type AfterChangeNodeHookArgs<T extends SerializedLexicalNode> = {\n  /** A string relating to which operation the field type is currently executing within. Useful within beforeValidate, beforeChange, and afterChange hooks to differentiate between create and update operations. */\n  operation: 'create' | 'delete' | 'read' | 'update'\n  /** The value of the node before any changes. Not available in afterRead hooks */\n  originalNode: T\n  previousNode: T\n}\nexport type BeforeValidateNodeHookArgs<T extends SerializedLexicalNode> = {\n  /** A string relating to which operation the field type is currently executing within. Useful within beforeValidate, beforeChange, and afterChange hooks to differentiate between create and update operations. */\n  operation: 'create' | 'delete' | 'read' | 'update'\n  /** The value of the node before any changes. Not available in afterRead hooks */\n  originalNode: T\n  overrideAccess: boolean\n}\n\nexport type BeforeChangeNodeHookArgs<T extends SerializedLexicalNode> = {\n  /**\n   * Only available in `beforeChange` hooks.\n   */\n  errors: ValidationFieldError[]\n  mergeLocaleActions: (() => Promise<void> | void)[]\n  /** A string relating to which operation the field type is currently executing within. Useful within beforeValidate, beforeChange, and afterChange hooks to differentiate between create and update operations. */\n  operation: 'create' | 'delete' | 'read' | 'update'\n  /** The value of the node before any changes. Not available in afterRead hooks */\n  originalNode: T\n  /**\n   * The original node with locales (not modified by any hooks).\n   */\n  originalNodeWithLocales?: T\n  previousNode: T\n\n  skipValidation: boolean\n}\n\nexport type BaseNodeHookArgs<T extends SerializedLexicalNode> = {\n  context: RequestContext\n  /** The value of the node. */\n  node: T\n  parentRichTextFieldPath: (number | string)[]\n  parentRichTextFieldSchemaPath: string[]\n  /** The payload request object. It is mocked for Local API operations. */\n  req: PayloadRequest\n}\n\nexport type AfterReadNodeHook<T extends SerializedLexicalNode> = (\n  args: AfterReadNodeHookArgs<T> & BaseNodeHookArgs<T>,\n) => Promise<T> | T\n\nexport type AfterChangeNodeHook<T extends SerializedLexicalNode> = (\n  args: AfterChangeNodeHookArgs<T> & BaseNodeHookArgs<T>,\n) => Promise<T> | T\n\nexport type BeforeChangeNodeHook<T extends SerializedLexicalNode> = (\n  args: BaseNodeHookArgs<T> & BeforeChangeNodeHookArgs<T>,\n) => Promise<T> | T\n\nexport type BeforeValidateNodeHook<T extends SerializedLexicalNode> = (\n  args: BaseNodeHookArgs<T> & BeforeValidateNodeHookArgs<T>,\n) => Promise<T> | T\n\n// Define the node with hooks that use the node's exportJSON return type\nexport type NodeWithHooks<T extends LexicalNode = any> = {\n  /**\n   * Allows you to define how a node can be serialized into different formats. Currently, only supports html.\n   * Markdown converters are defined in `markdownTransformers` and not here.\n   *\n   * @deprecated - will be removed in 4.0\n   */\n  converters?: {\n    /**\n     * @deprecated - will be removed in 4.0\n     */\n    html?: HTMLConverter<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>\n  }\n  /**\n   * If a node includes sub-fields (e.g. block and link nodes), passing those subFields here will make payload\n   * automatically populate, run hooks, and generate component import maps for them\n   */\n  getSubFields?: (args: {\n    /**\n     * Optional. If not provided, all possible sub-fields should be returned.\n     */\n    node?: ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>\n    req?: PayloadRequest\n  }) => Field[] | null\n  /**\n   * If a node includes sub-fields, the sub-fields data needs to be returned here, alongside `getSubFields` which returns their schema.\n   */\n  getSubFieldsData?: (args: {\n    node: ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>\n    req: PayloadRequest\n  }) => JsonObject\n  /**\n   * Allows you to run population logic when a node's data was requested from graphQL.\n   * While `getSubFields` and `getSubFieldsData` automatically handle populating sub-fields (since they run hooks on them), those are only populated in the Rest API.\n   * This is because the Rest API hooks do not have access to the 'depth' property provided by graphQL.\n   * In order for them to be populated correctly in graphQL, the population logic needs to be provided here.\n   */\n  graphQLPopulationPromises?: Array<\n    PopulationPromise<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>\n  >\n  /**\n   * Just like payload fields, you can provide hooks which are run for this specific node. These are called Node Hooks.\n   */\n  hooks?: {\n    afterChange?: Array<AfterChangeNodeHook<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>>\n    afterRead?: Array<AfterReadNodeHook<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>>\n    beforeChange?: Array<BeforeChangeNodeHook<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>>\n    beforeValidate?: Array<\n      BeforeValidateNodeHook<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>\n    >\n  }\n  /**\n   * The actual lexical node needs to be provided here. This also supports [lexical node replacements](https://lexical.dev/docs/concepts/node-replacement).\n   */\n  node: Klass<T> | LexicalNodeReplacement\n  /**\n   * This allows you to provide node validations, which are run when your document is being validated, alongside other payload fields.\n   * You can use it to throw a validation error for a specific node in case its data is incorrect.\n   */\n  validations?: Array<NodeValidation<ReturnType<ReplaceAny<T, LexicalNode>['exportJSON']>>>\n}\n\nexport type ServerFeature<ServerProps, ClientFeatureProps> = {\n  ClientFeature?: PayloadComponent<never, BaseClientFeatureProps<ClientFeatureProps>>\n  /**\n   * This determines what props will be available on the Client.\n   */\n  clientFeatureProps?: ClientFeatureProps\n  /**\n   * Adds payload components to the importMap.\n   *\n   * If an object is provided, the imported components will automatically be made available to the client feature, keyed by the object's keys.\n   */\n  componentImports?:\n    | {\n        [key: string]: PayloadComponent\n      }\n    | ImportMapGenerators[0]\n    | PayloadComponent[]\n  generatedTypes?: {\n    modifyOutputSchema: (args: {\n      collectionIDFieldTypes: { [key: string]: 'number' | 'string' }\n      config?: SanitizedConfig\n      /**\n       * Current schema which will be modified by this function.\n       */\n      currentSchema: JSONSchema4\n      field: LexicalRichTextField\n      i18n?: I18n\n      /**\n       * Allows you to define new top-level interfaces that can be re-used in the output schema.\n       */\n      interfaceNameDefinitions: Map<string, JSONSchema4>\n      isRequired: boolean\n    }) => JSONSchema4\n  }\n  generateSchemaMap?: (args: {\n    config: SanitizedConfig\n    field: RichTextField\n    i18n: I18nClient\n    props: ServerProps\n    schemaMap: FieldSchemaMap\n    schemaPath: string\n  }) => FieldSchemaMap | null\n  hooks?: RichTextHooks\n  /**\n   * Here you can provide i18n translations for your feature. These will only be available on the server and client.\n   *\n   * Translations here are automatically scoped to `lexical.featureKey.yourKey`\n   *\n   * @Example\n   * ```ts\n   * i18n: {\n   *   en: {\n   *     label: 'Horizontal Rule',\n   *   },\n   *   de: {\n   *     label: 'Trennlinie',\n   *   },\n   * }\n   * ```\n   * In order to access these translations, you would use `i18n.t('lexical:horizontalRule:label')`.\n   */\n  i18n?: Partial<GenericLanguages>\n  markdownTransformers?: (\n    | ((props: { allNodes: Array<NodeWithHooks>; allTransformers: Transformer[] }) => Transformer)\n    | Transformer\n  )[]\n  nodes?: Array<NodeWithHooks>\n\n  /** Props which were passed into your feature will have to be passed here. This will allow them to be used / read in other places of the code, e.g. wherever you can use useEditorConfigContext */\n  sanitizedServerFeatureProps?: ServerProps\n}\n\nexport type ResolvedServerFeature<ServerProps, ClientFeatureProps> = {\n  order: number\n} & Required<\n  Pick<\n    FeatureProviderServer<ServerProps, ClientFeatureProps>,\n    'dependencies' | 'dependenciesPriority' | 'dependenciesSoft' | 'key'\n  >\n> &\n  ServerFeature<ServerProps, ClientFeatureProps>\n\nexport type ResolvedServerFeatureMap = Map<string, ResolvedServerFeature<any, any>>\n\nexport type ServerFeatureProviderMap = Map<string, FeatureProviderServer<any, any, any>>\n\nexport type SanitizedServerFeatures = {\n  /**  The node types mapped to their converters */\n  converters: {\n    html: HTMLConverter[]\n  }\n  /** The keys of all enabled features */\n  enabledFeatures: string[]\n  generatedTypes: {\n    modifyOutputSchemas: Array<\n      (args: {\n        collectionIDFieldTypes: { [key: string]: 'number' | 'string' }\n        config?: SanitizedConfig\n        /**\n         * Current schema which will be modified by this function.\n         */\n        currentSchema: JSONSchema4\n        field: LexicalRichTextField\n        i18n?: I18n\n        /**\n         * Allows you to define new top-level interfaces that can be re-used in the output schema.\n         */\n        interfaceNameDefinitions: Map<string, JSONSchema4>\n        isRequired: boolean\n      }) => JSONSchema4\n    >\n  }\n  /**  The node types mapped to their hooks */\n\n  getSubFields?: Map<\n    string,\n    (args: { node: SerializedLexicalNode; req: PayloadRequest }) => Field[] | null\n  >\n  getSubFieldsData?: Map<\n    string,\n    (args: { node: SerializedLexicalNode; req: PayloadRequest }) => JsonObject\n  >\n  graphQLPopulationPromises: Map<string, Array<PopulationPromise>>\n  hooks: RichTextHooks\n  markdownTransformers: Transformer[]\n  nodeHooks?: {\n    afterChange?: Map<string, Array<AfterChangeNodeHook<SerializedLexicalNode>>>\n    afterRead?: Map<string, Array<AfterReadNodeHook<SerializedLexicalNode>>>\n    beforeChange?: Map<string, Array<BeforeChangeNodeHook<SerializedLexicalNode>>>\n    beforeValidate?: Map<string, Array<BeforeValidateNodeHook<SerializedLexicalNode>>>\n  } /**  The node types mapped to their populationPromises */\n  /**  The node types mapped to their validations */\n  validations: Map<string, Array<NodeValidation>>\n} & Required<Pick<ResolvedServerFeature<any, any>, 'i18n' | 'nodes'>>\n"],"mappings":"AAgXA","ignoreList":[]}

package/dist/features/upload/client/component/index.d.ts

@@ -0,0 +1,12 @@
+import { type ElementFormatType } from 'lexical';
+import React from 'react';
+import type { UploadData } from '../../server/nodes/UploadNode.js';
+import './index.scss';
+export type ElementProps = {
+    className: string;
+    data: UploadData;
+    format?: ElementFormatType;
+    nodeKey: string;
+};
+export declare const UploadComponent: React.FC<ElementProps>;
+//# sourceMappingURL=index.d.ts.map

package/dist/features/upload/client/component/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/upload/client/component/index.tsx"],"names":[],"mappings":"AAeA,OAAO,EAAiB,KAAK,iBAAiB,EAAE,MAAM,SAAS,CAAA;AAE/D,OAAO,KAA2D,MAAM,OAAO,CAAA;AAG/E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAA;AASlE,OAAO,cAAc,CAAA;AAMrB,MAAM,MAAM,YAAY,GAAG;IACzB,SAAS,EAAE,MAAM,CAAA;IACjB,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,CAAC,EAAE,iBAAiB,CAAA;IAC1B,OAAO,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,eAAO,MAAM,eAAe,EAAE,KAAK,CAAC,EAAE,CAAC,YAAY,CA4MlD,CAAA"}

package/dist/features/upload/client/component/index.js

@@ -0,0 +1,210 @@
+'use client';
+
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { useLexicalComposerContext } from '@lexical/react/LexicalComposerContext.js';
+import { useLexicalEditable } from '@lexical/react/useLexicalEditable';
+import { getTranslation } from '@ruya.sa/translations';
+import { Button, formatDrawerSlug, Thumbnail, useConfig, useEditDepth, usePayloadAPI, useTranslation } from '@ruya.sa/ui';
+import { $getNodeByKey } from 'lexical';
+import { formatAdminURL, isImage } from '@ruya.sa/payload/shared';
+import React, { useCallback, useId, useReducer, useRef, useState } from 'react';
+import { useEditorConfigContext } from '../../../../lexical/config/client/EditorConfigProvider.js';
+import { FieldsDrawer } from '../../../../utilities/fieldsDrawer/Drawer.js';
+import { useLexicalDocumentDrawer } from '../../../../utilities/fieldsDrawer/useLexicalDocumentDrawer.js';
+import { useLexicalDrawer } from '../../../../utilities/fieldsDrawer/useLexicalDrawer.js';
+import { INSERT_UPLOAD_WITH_DRAWER_COMMAND } from '../drawer/commands.js';
+const initialParams = {
+  depth: 0
+};
+export const UploadComponent = props => {
+  const {
+    className: baseClass,
+    data: {
+      fields,
+      relationTo,
+      value
+    },
+    format,
+    nodeKey
+  } = props;
+  if (typeof value === 'object') {
+    throw new Error('Upload value should be a string or number. The Lexical Upload component should not receive the populated value object.');
+  }
+  const {
+    config: {
+      routes: {
+        api
+      },
+      serverURL
+    },
+    getEntityConfig
+  } = useConfig();
+  const uploadRef = useRef(null);
+  const {
+    uuid
+  } = useEditorConfigContext();
+  const editDepth = useEditDepth();
+  const [editor] = useLexicalComposerContext();
+  const {
+    editorConfig,
+    fieldProps: {
+      schemaPath
+    }
+  } = useEditorConfigContext();
+  const isEditable = useLexicalEditable();
+  const {
+    i18n,
+    t
+  } = useTranslation();
+  const [cacheBust, dispatchCacheBust] = useReducer(state => state + 1, 0);
+  const [relatedCollection] = useState(() => getEntityConfig({
+    collectionSlug: relationTo
+  }));
+  const componentID = useId();
+  const extraFieldsDrawerSlug = formatDrawerSlug({
+    slug: `lexical-upload-drawer-` + uuid + componentID,
+    depth: editDepth
+  });
+  // Need to use hook to initialize useEffect that restores cursor position
+  const {
+    toggleDrawer
+  } = useLexicalDrawer(extraFieldsDrawerSlug, true);
+  const {
+    closeDocumentDrawer,
+    DocumentDrawer,
+    DocumentDrawerToggler
+  } = useLexicalDocumentDrawer({
+    id: value,
+    collectionSlug: relatedCollection.slug
+  });
+  // Get the referenced document
+  const [{
+    data
+  }, {
+    setParams
+  }] = usePayloadAPI(formatAdminURL({
+    apiRoute: api,
+    path: `/${relatedCollection.slug}/${value}`,
+    serverURL
+  }), {
+    initialParams
+  });
+  const thumbnailSRC = data?.thumbnailURL || data?.url;
+  const removeUpload = useCallback(() => {
+    editor.update(() => {
+      $getNodeByKey(nodeKey)?.remove();
+    });
+  }, [editor, nodeKey]);
+  const updateUpload = useCallback(_data => {
+    setParams({
+      ...initialParams,
+      cacheBust
+    });
+    dispatchCacheBust();
+    closeDocumentDrawer();
+  }, [setParams, cacheBust, closeDocumentDrawer]);
+  const hasExtraFields = editorConfig?.resolvedFeatureMap?.get('upload')?.sanitizedClientFeatureProps.collections?.[relatedCollection.slug]?.hasExtraFields;
+  const onExtraFieldsDrawerSubmit = useCallback((_, data_0) => {
+    // Update lexical node (with key nodeKey) with new data
+    editor.update(() => {
+      const uploadNode = $getNodeByKey(nodeKey);
+      if (uploadNode) {
+        const newData = {
+          ...uploadNode.getData(),
+          fields: data_0
+        };
+        uploadNode.setData(newData);
+      }
+    });
+  }, [editor, nodeKey]);
+  const aspectRatio = thumbnailSRC && data?.width && data?.height ? data.width > data.height ? 'landscape' : 'portrait' : 'landscape';
+  return /*#__PURE__*/_jsxs("div", {
+    className: `${baseClass}__contents ${baseClass}__contents--${aspectRatio}`,
+    "data-align": format || undefined,
+    "data-filename": data?.filename,
+    ref: uploadRef,
+    children: [/*#__PURE__*/_jsxs("div", {
+      className: `${baseClass}__card`,
+      children: [/*#__PURE__*/_jsxs("div", {
+        className: `${baseClass}__media`,
+        children: [/*#__PURE__*/_jsx(Thumbnail, {
+          collectionSlug: relationTo,
+          fileSrc: isImage(data?.mimeType) ? thumbnailSRC : null,
+          height: data?.height,
+          size: "none",
+          width: data?.width
+        }), isEditable && /*#__PURE__*/_jsx("div", {
+          className: `${baseClass}__overlay ${baseClass}__floater`,
+          children: /*#__PURE__*/_jsxs("div", {
+            className: `${baseClass}__actions`,
+            role: "toolbar",
+            children: [hasExtraFields ? /*#__PURE__*/_jsx(Button, {
+              buttonStyle: "icon-label",
+              className: `${baseClass}__upload-drawer-toggler`,
+              disabled: !isEditable,
+              el: "button",
+              icon: "edit",
+              onClick: toggleDrawer,
+              round: true,
+              size: "medium",
+              tooltip: t('fields:editRelationship')
+            }) : null, /*#__PURE__*/_jsx(Button, {
+              buttonStyle: "icon-label",
+              className: `${baseClass}__swap-drawer-toggler`,
+              disabled: !isEditable,
+              el: "button",
+              icon: "swap",
+              onClick: () => {
+                editor.dispatchCommand(INSERT_UPLOAD_WITH_DRAWER_COMMAND, {
+                  replace: {
+                    nodeKey
+                  }
+                });
+              },
+              round: true,
+              size: "medium",
+              tooltip: t('fields:swapUpload')
+            }), /*#__PURE__*/_jsx(Button, {
+              buttonStyle: "icon-label",
+              className: `${baseClass}__removeButton`,
+              disabled: !isEditable,
+              icon: "x",
+              onClick: e => {
+                e.preventDefault();
+                removeUpload();
+              },
+              round: true,
+              size: "medium",
+              tooltip: t('fields:removeUpload')
+            })]
+          })
+        })]
+      }), /*#__PURE__*/_jsxs("div", {
+        className: `${baseClass}__metaOverlay ${baseClass}__floater`,
+        children: [/*#__PURE__*/_jsx(DocumentDrawerToggler, {
+          className: `${baseClass}__doc-drawer-toggler`,
+          children: /*#__PURE__*/_jsx("strong", {
+            className: `${baseClass}__filename`,
+            children: data?.filename || t('general:untitled')
+          })
+        }), /*#__PURE__*/_jsx("div", {
+          className: `${baseClass}__collectionLabel`,
+          children: getTranslation(relatedCollection.labels.singular, i18n)
+        })]
+      })]
+    }), value ? /*#__PURE__*/_jsx(DocumentDrawer, {
+      onSave: updateUpload
+    }) : null, hasExtraFields ? /*#__PURE__*/_jsx(FieldsDrawer, {
+      data: fields,
+      drawerSlug: extraFieldsDrawerSlug,
+      drawerTitle: t('general:editLabel', {
+        label: getTranslation(relatedCollection.labels.singular, i18n)
+      }),
+      featureKey: "upload",
+      handleDrawerSubmit: onExtraFieldsDrawerSubmit,
+      schemaPath: schemaPath,
+      schemaPathSuffix: relatedCollection.slug
+    }) : null]
+  });
+};
+//# sourceMappingURL=index.js.map