@wordpress/annotations 3.40.1-next.v.202602271551.0 → 3.40.1

package/build-types/block/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/build-types/block/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/block/index.ts"],"names":[],"mappings":""}

package/build-types/format/annotation.d.ts

@@ -0,0 +1,19 @@
+import type { RichTextValue } from '@wordpress/rich-text';
+import type { Annotation, AnnotationFormat } from '../types';
+/**
+ * Applies given annotations to the given record.
+ *
+ * @param record      The record to apply annotations to.
+ * @param annotations The annotation to apply.
+ * @return A record with the annotations applied.
+ */
+export declare function applyAnnotations(record: RichTextValue, annotations?: Annotation[]): RichTextValue;
+/**
+ * Removes annotations from the given record.
+ *
+ * @param record Record to remove annotations from.
+ * @return The cleaned record.
+ */
+export declare function removeAnnotations(record: RichTextValue): RichTextValue;
+export declare const annotation: AnnotationFormat;
+//# sourceMappingURL=annotation.d.ts.map

package/build-types/format/annotation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"annotation.d.ts","sourceRoot":"","sources":["../../src/format/annotation.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAM1D,OAAO,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAM7D;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC/B,MAAM,EAAE,aAAa,EACrB,WAAW,GAAE,UAAU,EAAO,GAC5B,aAAa,CAkCf;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAE,MAAM,EAAE,aAAa,GAAI,aAAa,CAExE;AAwFD,eAAO,MAAM,UAAU,EAAE,gBAgExB,CAAC"}

package/build-types/format/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/build-types/format/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/format/index.ts"],"names":[],"mappings":""}

package/build-types/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Internal dependencies
+ */
+import './format';
+import './block';
+export { store } from './store';
+//# sourceMappingURL=index.d.ts.map

package/build-types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,UAAU,CAAC;AAClB,OAAO,SAAS,CAAC;AAEjB,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC"}

package/build-types/store/actions.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Internal dependencies
+ */
+import type { AddAnnotationParameters, AnnotationAction } from '../types';
+/**
+ * Adds an annotation to a block.
+ *
+ * The `block` attribute refers to a block ID that needs to be annotated.
+ * `isBlockAnnotation` controls whether or not the annotation is a block
+ * annotation. The `source` is the source of the annotation, this will be used
+ * to identify groups of annotations.
+ *
+ * The `range` property is only relevant if the selector is 'range'.
+ *
+ * @param annotation                    The annotation to add.
+ * @param annotation.blockClientId      The blockClientId to add the annotation to.
+ * @param annotation.richTextIdentifier Identifier for the RichText instance the annotation applies to.
+ * @param annotation.range              The range at which to apply this annotation.
+ * @param annotation.selector           The way to apply this annotation.
+ * @param annotation.source             The source that added the annotation.
+ * @param annotation.id                 The ID the annotation should have. Generates a UUID by default.
+ * @return Action object.
+ */
+export declare function __experimentalAddAnnotation({ blockClientId, richTextIdentifier, range, selector, source, id }: AddAnnotationParameters): AnnotationAction;
+/**
+ * Removes an annotation with a specific ID.
+ *
+ * @param annotationId The annotation to remove.
+ * @return Action object.
+ */
+export declare function __experimentalRemoveAnnotation(annotationId: string): AnnotationAction;
+/**
+ * Updates the range of an annotation.
+ *
+ * @param annotationId ID of the annotation to update.
+ * @param start        The start of the new range.
+ * @param end          The end of the new range.
+ * @return Action object.
+ */
+export declare function __experimentalUpdateAnnotationRange(annotationId: string, start: number, end: number): AnnotationAction;
+/**
+ * Removes all annotations of a specific source.
+ *
+ * @param source The source to remove.
+ * @return Action object.
+ */
+export declare function __experimentalRemoveAnnotationsBySource(source: string): AnnotationAction;
+//# sourceMappingURL=actions.d.ts.map

package/build-types/store/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../src/store/actions.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,OAAO,KAAK,EAAE,uBAAuB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE1E;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,2BAA2B,CAAE,EAC5C,aAAa,EACb,kBAAyB,EACzB,KAAY,EACZ,QAAkB,EAClB,MAAkB,EAClB,EAAW,EACX,EAAE,uBAAuB,GAAI,gBAAgB,CAiB7C;AAED;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAC7C,YAAY,EAAE,MAAM,GAClB,gBAAgB,CAKlB;AAED;;;;;;;GAOG;AACH,wBAAgB,mCAAmC,CAClD,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,GACT,gBAAgB,CAOlB;AAED;;;;;GAKG;AACH,wBAAgB,uCAAuC,CACtD,MAAM,EAAE,MAAM,GACZ,gBAAgB,CAKlB"}

package/build-types/store/constants.d.ts

@@ -0,0 +1,5 @@
+/**
+ * The identifier for the data store.
+ */
+export declare const STORE_NAME = "core/annotations";
+//# sourceMappingURL=constants.d.ts.map

package/build-types/store/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/store/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,UAAU,qBAAqB,CAAC"}

package/build-types/store/index.d.ts

@@ -0,0 +1,9 @@
+import * as selectors from './selectors';
+import * as actions from './actions';
+/**
+ * Store definition for the annotations namespace.
+ *
+ * @see https://github.com/WordPress/gutenberg/blob/HEAD/packages/data/README.md#createReduxStore
+ */
+export declare const store: import("@wordpress/data").StoreDescriptor<import("@wordpress/data").ReduxStoreConfig<unknown, typeof actions, typeof selectors>>;
+//# sourceMappingURL=index.d.ts.map

package/build-types/store/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/store/index.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,SAAS,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,OAAO,MAAM,WAAW,CAAC;AAOrC;;;;GAIG;AACH,eAAO,MAAM,KAAK,kIAIf,CAAC"}

package/build-types/store/reducer.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Internal dependencies
+ */
+import type { AnnotationAction, AnnotationsState } from '../types';
+/**
+ * Reducer managing annotations.
+ *
+ * @param state  The annotations currently shown in the editor.
+ * @param action Dispatched action.
+ * @return Updated state.
+ */
+export declare function annotations(state: AnnotationsState | undefined, action: AnnotationAction): AnnotationsState;
+export default annotations;
+//# sourceMappingURL=reducer.d.ts.map

package/build-types/store/reducer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reducer.d.ts","sourceRoot":"","sources":["../../src/store/reducer.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EACX,gBAAgB,EAChB,gBAAgB,EAGhB,MAAM,UAAU,CAAC;AA8DlB;;;;;;GAMG;AACH,wBAAgB,WAAW,CAC1B,KAAK,EAAE,gBAAgB,YAAK,EAC5B,MAAM,EAAE,gBAAgB,GACtB,gBAAgB,CA4ElB;eAEc,WAAW"}

package/build-types/store/selectors.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Internal dependencies
+ */
+import type { AnnotationsState, Annotation } from '../types';
+/**
+ * Returns the annotations for a specific client ID.
+ *
+ * @param state         Editor state.
+ * @param blockClientId The ID of the block to get the annotations for.
+ * @return The annotations applicable to this block.
+ */
+export declare const __experimentalGetAnnotationsForBlock: ((state: AnnotationsState, blockClientId: string) => Annotation[]) & import("rememo").EnhancedSelector;
+export declare function __experimentalGetAllAnnotationsForBlock(state: AnnotationsState, blockClientId: string): Annotation[];
+/**
+ * Returns the annotations that apply to the given RichText instance.
+ *
+ * Both a blockClientId and a richTextIdentifier are required. This is because
+ * a block might have multiple `RichText` components. This does mean that every
+ * block needs to implement annotations itself.
+ *
+ * @param state              Editor state.
+ * @param blockClientId      The client ID for the block.
+ * @param richTextIdentifier Unique identifier that identifies the given RichText.
+ * @return All the annotations relevant for the `RichText`.
+ */
+export declare const __experimentalGetAnnotationsForRichText: ((state: AnnotationsState, blockClientId: string, richTextIdentifier: string) => Annotation[]) & import("rememo").EnhancedSelector;
+/**
+ * Returns all annotations in the editor state.
+ *
+ * @param state Editor state.
+ * @return All annotations currently applied.
+ */
+export declare function __experimentalGetAnnotations(state: AnnotationsState): Annotation[];
+//# sourceMappingURL=selectors.d.ts.map

package/build-types/store/selectors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"selectors.d.ts","sourceRoot":"","sources":["../../src/store/selectors.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAW7D;;;;;;GAMG;AACH,eAAO,MAAM,oCAAoC,WACvC,gBAAgB,iBAAiB,MAAM,KAAI,UAAU,EAAE,qCAQhE,CAAC;AAEF,wBAAgB,uCAAuC,CACtD,KAAK,EAAE,gBAAgB,EACvB,aAAa,EAAE,MAAM,GACnB,UAAU,EAAE,CAEd;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,uCAAuC,WAE3C,gBAAgB,iBACR,MAAM,sBACD,MAAM,KACxB,UAAU,EAAE,qCAoBf,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,4BAA4B,CAC3C,KAAK,EAAE,gBAAgB,GACrB,UAAU,EAAE,CAId"}

package/build-types/types.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Represents a range in text content.
+ */
+export interface AnnotationRange {
+    /** The offset where the annotation should start. */
+    start: number;
+    /** The offset where the annotation should end. */
+    end: number;
+}
+/**
+ * Represents an annotation selector type.
+ */
+export type AnnotationSelector = 'range' | 'block';
+/**
+ * Base annotation interface.
+ */
+export interface Annotation {
+    /** Unique identifier for the annotation. */
+    id: string;
+    /** The block client ID this annotation applies to. */
+    blockClientId: string;
+    /** The source that created this annotation. */
+    source: string;
+    /** The type of selector used for this annotation. */
+    selector: AnnotationSelector;
+    /** Rich text identifier for range annotations. */
+    richTextIdentifier?: string | null;
+    /** Range for range-based annotations. */
+    range?: AnnotationRange | null;
+    /** Start position for annotations returned from selectors. */
+    start?: number;
+    /** End position for annotations returned from selectors. */
+    end?: number;
+}
+/**
+ * Parameters for adding an annotation.
+ */
+export interface AddAnnotationParameters {
+    /** The blockClientId to add the annotation to. */
+    blockClientId: string;
+    /** Identifier for the RichText instance the annotation applies to. */
+    richTextIdentifier?: string | null;
+    /** The range at which to apply this annotation. */
+    range?: AnnotationRange | null;
+    /** The way to apply this annotation. */
+    selector?: AnnotationSelector;
+    /** The source that added the annotation. */
+    source?: string;
+    /** The ID the annotation should have. Generates a UUID by default. */
+    id?: string;
+}
+/**
+ * Store state interface.
+ */
+export type AnnotationsState = Partial<Record<string, Annotation[]>>;
+/**
+ * Action types.
+ */
+export type AnnotationAction = {
+    type: 'ANNOTATION_ADD';
+    id: string;
+    blockClientId: string;
+    richTextIdentifier: string | null;
+    source: string;
+    selector: AnnotationSelector;
+    range?: AnnotationRange;
+} | {
+    type: 'ANNOTATION_REMOVE';
+    annotationId: string;
+} | {
+    type: 'ANNOTATION_UPDATE_RANGE';
+    annotationId: string;
+    start: number;
+    end: number;
+} | {
+    type: 'ANNOTATION_REMOVE_SOURCE';
+    source: string;
+};
+/**
+ * Format registration interface for annotations.
+ */
+export interface AnnotationFormat {
+    name: string;
+    title: string;
+    tagName: string;
+    className: string;
+    attributes: {
+        className: string;
+        id: string;
+    };
+    interactive: boolean;
+    object: boolean;
+    edit: () => null;
+    __experimentalGetPropsForEditableTreePreparation: (select: any, props: {
+        richTextIdentifier: string;
+        blockClientId: string;
+    }) => {
+        annotations: Annotation[];
+    };
+    __experimentalCreatePrepareEditableTree: (props: {
+        annotations: Annotation[];
+    }) => (formats: any[], text: string) => any[];
+    __experimentalGetPropsForEditableTreeChangeHandler: (dispatch: any) => {
+        removeAnnotation: (annotationId: string) => void;
+        updateAnnotationRange: (annotationId: string, start: number, end: number) => void;
+    };
+    __experimentalCreateOnChangeEditableValue: (props: {
+        removeAnnotation: (annotationId: string) => void;
+        updateAnnotationRange: (annotationId: string, start: number, end: number) => void;
+        annotations: Annotation[];
+    }) => (formats: any[]) => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/build-types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC/B,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,GAAG,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,GAAG,OAAO,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,UAAU;IAC1B,4CAA4C;IAC5C,EAAE,EAAE,MAAM,CAAC;IACX,sDAAsD;IACtD,aAAa,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,CAAC;IACf,qDAAqD;IACrD,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,kDAAkD;IAClD,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,yCAAyC;IACzC,KAAK,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAC/B,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,4DAA4D;IAC5D,GAAG,CAAC,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,kDAAkD;IAClD,aAAa,EAAE,MAAM,CAAC;IACtB,sEAAsE;IACtE,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,mDAAmD;IACnD,KAAK,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC;IAC/B,wCAAwC;IACxC,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,4CAA4C;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sEAAsE;IACtE,EAAE,CAAC,EAAE,MAAM,CAAC;CACZ;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAE,MAAM,CAAE,MAAM,EAAE,UAAU,EAAE,CAAE,CAAE,CAAC;AAEzE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACzB;IACA,IAAI,EAAE,gBAAgB,CAAC;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,KAAK,CAAC,EAAE,eAAe,CAAC;CACvB,GACD;IACA,IAAI,EAAE,mBAAmB,CAAC;IAC1B,YAAY,EAAE,MAAM,CAAC;CACpB,GACD;IACA,IAAI,EAAE,yBAAyB,CAAC;IAChC,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACX,GACD;IACA,IAAI,EAAE,0BAA0B,CAAC;IACjC,MAAM,EAAE,MAAM,CAAC;CACd,CAAC;AAEL;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE;QACX,SAAS,EAAE,MAAM,CAAC;QAClB,EAAE,EAAE,MAAM,CAAC;KACX,CAAC;IACF,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,MAAM,IAAI,CAAC;IACjB,gDAAgD,EAAE,CACjD,MAAM,EAAE,GAAG,EACX,KAAK,EAAE;QACN,kBAAkB,EAAE,MAAM,CAAC;QAC3B,aAAa,EAAE,MAAM,CAAC;KACtB,KACG;QACJ,WAAW,EAAE,UAAU,EAAE,CAAC;KAC1B,CAAC;IACF,uCAAuC,EAAE,CAAE,KAAK,EAAE;QACjD,WAAW,EAAE,UAAU,EAAE,CAAC;KAC1B,KAAM,CAAE,OAAO,EAAE,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,KAAM,GAAG,EAAE,CAAC;IACjD,kDAAkD,EAAE,CAAE,QAAQ,EAAE,GAAG,KAAM;QACxE,gBAAgB,EAAE,CAAE,YAAY,EAAE,MAAM,KAAM,IAAI,CAAC;QACnD,qBAAqB,EAAE,CACtB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,KACP,IAAI,CAAC;KACV,CAAC;IACF,yCAAyC,EAAE,CAAE,KAAK,EAAE;QACnD,gBAAgB,EAAE,CAAE,YAAY,EAAE,MAAM,KAAM,IAAI,CAAC;QACnD,qBAAqB,EAAE,CACtB,YAAY,EAAE,MAAM,EACpB,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,KACP,IAAI,CAAC;QACV,WAAW,EAAE,UAAU,EAAE,CAAC;KAC1B,KAAM,CAAE,OAAO,EAAE,GAAG,EAAE,KAAM,IAAI,CAAC;CAClC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/annotations",
-	"version": "3.40.1-next.v.202602271551.0+464abe399",
+	"version": "3.40.1",
 	"description": "Annotate content in the Gutenberg editor.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -41,10 +41,10 @@
 	"react-native": "src/index",
 	"wpScript": true,
 	"dependencies": {
-		"@wordpress/data": "^10.40.1-next.v.202602271551.0+464abe399",
-		"@wordpress/hooks": "^4.40.1-next.v.202602271551.0+464abe399",
-		"@wordpress/i18n": "^6.13.1-next.v.202602271551.0+464abe399",
-		"@wordpress/rich-text": "^7.40.1-next.v.202602271551.0+464abe399",
+		"@wordpress/data": "^10.40.1",
+		"@wordpress/hooks": "^4.40.1",
+		"@wordpress/i18n": "^6.13.1",
+		"@wordpress/rich-text": "^7.40.1",
 		"uuid": "^9.0.1"
 	},
 	"peerDependencies": {
@@ -53,5 +53,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "95aa7055a5757219e2d96a91efc69f7dd1b2d4c3"
+	"gitHead": "adb6623c9f32490cfc73c7ac7f122578c1f10c65"
 }