@wordpress/shortcode 4.37.1-next.79a2f3cdd.0 → 4.37.1-next.v.0

package/build-types/index.d.ts

@@ -1,24 +1,29 @@
+/**
+ * Internal dependencies
+ */
+import type { ShortcodeAttrs, ShortcodeMatch, ShortcodeOptions, Match, ReplaceCallback, ShortcodeInstance } from './types';
+export * from './types';
 /**
  * Find the next matching shortcode.
  *
- * @param {string} tag   Shortcode tag.
- * @param {string} text  Text to search.
- * @param {number} index Index to start search from.
+ * @param tag   Shortcode tag.
+ * @param text  Text to search.
+ * @param index Index to start search from.
  *
- * @return {import('./types').ShortcodeMatch | undefined} Matched information.
+ * @return Matched information.
  */
-export function next(tag: string, text: string, index?: number): import("./types").ShortcodeMatch | undefined;
+export declare function next(tag: string, text: string, index?: number): ShortcodeMatch | undefined;
 /**
  * Replace matching shortcodes in a block of text.
  *
- * @param {string}                            tag      Shortcode tag.
- * @param {string}                            text     Text to search.
- * @param {import('./types').ReplaceCallback} callback Function to process the match and return
- *                                                     replacement string.
+ * @param tag      Shortcode tag.
+ * @param text     Text to search.
+ * @param callback Function to process the match and return
+ *                 replacement string.
  *
- * @return {string} Text with shortcodes replaced.
+ * @return Text with shortcodes replaced.
  */
-export function replace(tag: string, text: string, callback: import("./types").ReplaceCallback): string;
+export declare function replace(tag: string, text: string, callback: ReplaceCallback): string;
 /**
  * Generate a string from shortcode parameters.
  *
@@ -28,11 +33,11 @@ export function replace(tag: string, text: string, callback: import("./types").R
  * `tag` string, a string or object of `attrs`, a boolean indicating whether to
  * format the shortcode using a `single` tag, and a `content` string.
  *
- * @param {Object} options
+ * @param options Shortcode options.
  *
- * @return {string} String representation of the shortcode.
+ * @return String representation of the shortcode.
  */
-export function string(options: Object): string;
+export declare function string(options: ShortcodeOptions): string;
 /**
  * Generate a RegExp to identify a shortcode.
  *
@@ -49,24 +54,11 @@ export function string(options: Object): string;
  * 6. The closing tag.
  * 7. An extra `]` to allow for escaping shortcodes with double `[[]]`
  *
- * @param {string} tag Shortcode tag.
- *
- * @return {RegExp} Shortcode RegExp.
- */
-export function regexp(tag: string): RegExp;
-/**
- * Generate a Shortcode Object from a RegExp match.
- *
- * Accepts a `match` object from calling `regexp.exec()` on a `RegExp` generated
- * by `regexp()`. `match` can also be set to the `arguments` from a callback
- * passed to `regexp.replace()`.
- *
- * @param {import('./types').Match} match Match array.
+ * @param tag Shortcode tag.
  *
- * @return {InstanceType<import('./types').shortcode>} Shortcode instance.
+ * @return Shortcode RegExp.
  */
-export function fromMatch(match: import("./types").Match): InstanceType<import("./types").shortcode>;
-export * from "./types";
+export declare function regexp(tag: string): RegExp;
 /**
  * Parse shortcode attributes.
  *
@@ -82,13 +74,21 @@ export * from "./types";
  *
  * @param {string} text Serialised shortcode attributes.
  *
- * @return {import('./types').ShortcodeAttrs} Parsed shortcode attributes.
+ * @return {ShortcodeAttrs} Parsed shortcode attributes.
  */
-export const attrs: ((text: any) => {
-    named: {};
-    numeric: string[];
-}) & import("memize").MemizeMemoizedFunction;
-export default shortcode;
+export declare const attrs: ((text: string) => ShortcodeAttrs) & import("memize").MemizeMemoizedFunction;
+/**
+ * Generate a Shortcode Object from a RegExp match.
+ *
+ * Accepts a `match` object from calling `regexp.exec()` on a `RegExp` generated
+ * by `regexp()`. `match` can also be set to the `arguments` from a callback
+ * passed to `regexp.replace()`.
+ *
+ * @param match Match array.
+ *
+ * @return Shortcode instance.
+ */
+export declare function fromMatch(match: Match): ShortcodeInstance;
 /**
  * Creates a shortcode instance.
  *
@@ -96,8 +96,48 @@ export default shortcode;
  * containing a `tag` string, a string or object of `attrs`, a string indicating
  * the `type` of the shortcode ('single', 'self-closing', or 'closed'), and a
  * `content` string.
- *
- * @type {import('./types').shortcode} Shortcode instance.
  */
-declare const shortcode: import("./types").shortcode;
+declare class Shortcode implements ShortcodeInstance {
+    tag: string;
+    type?: 'self-closing' | 'closed' | 'single';
+    content?: string;
+    attrs: ShortcodeAttrs;
+    static next: typeof next;
+    static replace: typeof replace;
+    static string: typeof string;
+    static regexp: typeof regexp;
+    static attrs: ((text: string) => ShortcodeAttrs) & import("memize").MemizeMemoizedFunction;
+    static fromMatch: typeof fromMatch;
+    constructor(options: ShortcodeOptions);
+    /**
+     * Get a shortcode attribute.
+     *
+     * Automatically detects whether `attr` is named or numeric and routes it
+     * accordingly.
+     *
+     * @param attr Attribute key.
+     *
+     * @return Attribute value.
+     */
+    get(attr: string | number): string | undefined;
+    /**
+     * Set a shortcode attribute.
+     *
+     * Automatically detects whether `attr` is named or numeric and routes it
+     * accordingly.
+     *
+     * @param attr  Attribute key.
+     * @param value Attribute value.
+     *
+     * @return Shortcode instance.
+     */
+    set(attr: string | number, value: string): this;
+    /**
+     * Transform the shortcode into a string.
+     *
+     * @return String representation of the shortcode.
+     */
+    string(): string;
+}
+export default Shortcode;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.js"],"names":[],"mappings":"AAOA;;;;;;;;GAQG;AACH,0BANW,MAAM,QACN,MAAM,UACN,MAAM,GAEL,OAAO,SAAS,EAAE,cAAc,GAAG,SAAS,CAqCvD;AAED;;;;;;;;;GASG;AACH,6BAPW,MAAM,QACN,MAAM,YACN,OAAO,SAAS,EAAE,eAAe,GAGhC,MAAM,CAoBjB;AAED;;;;;;;;;;;;GAYG;AACH,gCAJW,MAAM,GAEL,MAAM,CAIjB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,4BAJW,MAAM,GAEL,MAAM,CASjB;AAiED;;;;;;;;;;GAUG;AACH,iCAJW,OAAO,SAAS,EAAE,KAAK,GAEtB,YAAY,CAAC,OAAO,SAAS,EAAE,SAAS,CAAC,CAmBpD;;AA3FD;;;;;;;;;;;;;;;;GAgBG;AACH;;;6CA4CI;;AAgCJ;;;;;;;;;GASG;AACH,yBAFU,OAAO,SAAS,EAAE,SAAS,CA2CnC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,OAAO,KAAK,EACX,cAAc,EACd,cAAc,EACd,gBAAgB,EAChB,KAAK,EACL,eAAe,EACf,iBAAiB,EACjB,MAAM,SAAS,CAAC;AAEjB,cAAc,SAAS,CAAC;AAExB;;;;;;;;GAQG;AACH,wBAAgB,IAAI,CACnB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,KAAK,GAAE,MAAU,GACf,cAAc,GAAG,SAAS,CAmC5B;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CACtB,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,eAAe,UAwBzB;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,MAAM,CAAE,OAAO,EAAE,gBAAgB,GAAI,MAAM,CAE1D;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,MAAM,CAAE,GAAG,EAAE,MAAM,GAAI,MAAM,CAO5C;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,KAAK,8EA4Cf,CAAC;AAEJ;;;;;;;;;;GAUG;AACH,wBAAgB,SAAS,CAAE,KAAK,EAAE,KAAK,GAAI,iBAAiB,CAiB3D;AAED;;;;;;;GAOG;AACH,cAAM,SAAU,YAAW,iBAAiB;IAE3C,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,cAAc,CAAC;IAGtB,MAAM,CAAC,IAAI,cAAQ;IACnB,MAAM,CAAC,OAAO,iBAAW;IACzB,MAAM,CAAC,MAAM,gBAAU;IACvB,MAAM,CAAC,MAAM,gBAAU;IACvB,MAAM,CAAC,KAAK,+EAAS;IACrB,MAAM,CAAC,SAAS,mBAAa;gBAEhB,OAAO,EAAE,gBAAgB;IAwCtC;;;;;;;;;OASG;IACH,GAAG,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,GAAI,MAAM,GAAG,SAAS;IAOhD;;;;;;;;;;OAUG;IACH,GAAG,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,GAAI,IAAI;IASjD;;;;OAIG;IACH,MAAM,IAAI,MAAM;CAiChB;AAED,eAAe,SAAS,CAAC"}

package/build-types/types.d.ts

@@ -11,6 +11,30 @@ export type ShortcodeAttrs = {
      */
     numeric: string[];
 };
+/**
+ * Shortcode object.
+ */
+export interface Shortcode {
+    /**
+     * Shortcode tag.
+     */
+    tag: string;
+    /**
+     * Shortcode attributes.
+     */
+    attrs: ShortcodeAttrs;
+    /**
+     * Shortcode content.
+     */
+    content?: string;
+    /**
+     * Shortcode type: `self-closing`, `closed`, or `single`.
+     */
+    type?: 'self-closing' | 'closed' | 'single';
+}
+/**
+ * Shortcode match result.
+ */
 export type ShortcodeMatch = {
     /**
      * Index the shortcode is found at.
@@ -26,7 +50,7 @@ export type ShortcodeMatch = {
     shortcode: Shortcode;
 };
 /**
- * Shortcode options.
+ * Shortcode options for creating a new shortcode.
  */
 export interface ShortcodeOptions {
     /**
@@ -47,136 +71,45 @@ export interface ShortcodeOptions {
     type?: 'self-closing' | 'closed' | 'single';
 }
 /**
- * Shortcode object.
+ * Match array from regexp.exec() or arguments from replace callback.
+ */
+export type Match = NonNullable<ReturnType<RegExp['exec']>> | IArguments | ArrayLike<string>;
+/**
+ * Callback function for replace operations.
  */
-export interface Shortcode extends ShortcodeOptions {
-    /**
-     * Shortcode attributes.
-     */
-    attrs: ShortcodeAttrs;
-}
-export type Match = NonNullable<ReturnType<RegExp['exec']>> | Array<string>;
 export type ReplaceCallback = (shortcode: Shortcode) => string;
 /**
- * WordPress Shortcode instance.
+ * Shortcode instance returned by the constructor.
  */
-export interface shortcode {
-    new (options: Partial<ShortcodeOptions>): Shortcode & {
-        /**
-         * Transform the shortcode into a string.
-         *
-         * @return {string} String representation of the shortcode.
-         */
-        string: () => string;
-        /**
-         * Get a shortcode attribute.
-         *
-         * Automatically detects whether `attr` is named or numeric and routes it
-         * accordingly.
-         *
-         * @param {(number|string)} attr Attribute key.
-         *
-         * @return {string} Attribute value.
-         */
-        get: (attr: string | number) => string | undefined;
-        /**
-         * Set a shortcode attribute.
-         *
-         * Automatically detects whether `attr` is named or numeric and routes it
-         * accordingly.
-         *
-         * @param {(number|string)} attr  Attribute key.
-         * @param {string}          value Attribute value.
-         *
-         * @return {InstanceType< shortcode >} Shortcode instance.
-         */
-        set: (attr: string | number, value: string) => InstanceType<shortcode>;
-    };
-    /**
-     * Parse shortcode attributes.
-     *
-     * Shortcodes accept many types of attributes. These can chiefly be divided into
-     * named and numeric attributes:
-     *
-     * Named attributes are assigned on a key/value basis, while numeric attributes
-     * are treated as an array.
-     *
-     * Named attributes can be formatted as either `name="value"`, `name='value'`,
-     * or `name=value`. Numeric attributes can be formatted as `"value"` or just
-     * `value`.
-     *
-     * @param text Serialised shortcode attributes.
-     *
-     * @return Parsed shortcode attributes.
-     */
-    attrs: (text: string) => ShortcodeAttrs;
-    /**
-     * Generate a Shortcode Object from a RegExp match.
-     *
-     * Accepts a `match` object from calling `regexp.exec()` on a `RegExp` generated
-     * by `regexp()`. `match` can also be set to the `arguments` from a callback
-     * passed to `regexp.replace()`.
-     *
-     * @param match Match array.
-     *
-     * @return  Shortcode instance.
-     */
-    fromMatch: (match: Match) => InstanceType<shortcode>;
+export interface ShortcodeInstance extends Shortcode {
     /**
-     * Find the next matching shortcode.
-     *
-     * @param tag   Shortcode tag.
-     * @param text  Text to search.
-     * @param index Index to start search from.
+     * Transform the shortcode into a string.
      *
-     * @return Matched information.
+     * @return String representation of the shortcode.
      */
-    next: (tag: string, text: string, index?: number) => ShortcodeMatch | undefined;
+    string: () => string;
     /**
-     * Generate a RegExp to identify a shortcode.
-     *
-     * The base regex is functionally equivalent to the one found in
-     * `get_shortcode_regex()` in `wp-includes/shortcodes.php`.
+     * Get a shortcode attribute.
      *
-     * Capture groups:
+     * Automatically detects whether `attr` is named or numeric and routes it
+     * accordingly.
      *
-     * 1. An extra `[` to allow for escaping shortcodes with double `[[]]`
-     * 2. The shortcode name
-     * 3. The shortcode argument list
-     * 4. The self closing `/`
-     * 5. The content of a shortcode when it wraps some content.
-     * 6. The closing tag.
-     * 7. An extra `]` to allow for escaping shortcodes with double `[[]]`
+     * @param attr Attribute key.
      *
-     * @param tag Shortcode tag.
-     *
-     * @return Shortcode RegExp.
-     */
-    regexp: (tag: string) => RegExp;
-    /**
-     * Replace matching shortcodes in a block of text.
-     *
-     * @param tag      Shortcode tag.
-     * @param text     Text to search.
-     * @param callback Function to process the match and return
-     *                 replacement string.
-     *
-     * @return Text with shortcodes replaced.
+     * @return Attribute value.
      */
-    replace: (tag: string, text: string, callback: ReplaceCallback) => string;
+    get: (attr: string | number) => string | undefined;
     /**
-     * Generate a string from shortcode parameters.
-     *
-     * Creates a shortcode instance and returns a string.
+     * Set a shortcode attribute.
      *
-     * Accepts the same `options` as the `shortcode()` constructor, containing a
-     * `tag` string, a string or object of `attrs`, a boolean indicating whether to
-     * format the shortcode using a `single` tag, and a `content` string.
+     * Automatically detects whether `attr` is named or numeric and routes it
+     * accordingly.
      *
-     * @param options
+     * @param attr  Attribute key.
+     * @param value Attribute value.
      *
-     * @return  String representation of the shortcode.
+     * @return Shortcode instance.
      */
-    string: (options: ShortcodeOptions) => string;
+    set: (attr: string | number, value: string) => ShortcodeInstance;
 }
 //# sourceMappingURL=types.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAAE,CAAC;IAE5C;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAE,cAAc,CAAE,GAAG,MAAM,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,SAAU,SAAQ,gBAAgB;IAClD;;OAEG;IACH,KAAK,EAAE,cAAc,CAAC;CACtB;AAED,MAAM,MAAM,KAAK,GACd,WAAW,CAAE,UAAU,CAAE,MAAM,CAAE,MAAM,CAAE,CAAE,CAAE,GAC7C,KAAK,CAAE,MAAM,CAAE,CAAC;AAEnB,MAAM,MAAM,eAAe,GAAG,CAAE,SAAS,EAAE,SAAS,KAAM,MAAM,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB,KAAM,OAAO,EAAE,OAAO,CAAE,gBAAgB,CAAE,GAAI,SAAS,GAAG;QACzD;;;;WAIG;QACH,MAAM,EAAE,MAAM,MAAM,CAAC;QAErB;;;;;;;;;WASG;QACH,GAAG,EAAE,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,KAAM,MAAM,GAAG,SAAS,CAAC;QAErD;;;;;;;;;;WAUG;QACH,GAAG,EAAE,CACJ,IAAI,EAAE,MAAM,GAAG,MAAM,EACrB,KAAK,EAAE,MAAM,KACT,YAAY,CAAE,SAAS,CAAE,CAAC;KAC/B,CAAC;IAEF;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,EAAE,CAAE,IAAI,EAAE,MAAM,KAAM,cAAc,CAAC;IAE1C;;;;;;;;;;OAUG;IACH,SAAS,EAAE,CAAE,KAAK,EAAE,KAAK,KAAM,YAAY,CAAE,SAAS,CAAE,CAAC;IAEzD;;;;;;;;OAQG;IACH,IAAI,EAAE,CACL,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,MAAM,EACZ,KAAK,CAAC,EAAE,MAAM,KACV,cAAc,GAAG,SAAS,CAAC;IAEhC;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,EAAE,CAAE,GAAG,EAAE,MAAM,KAAM,MAAM,CAAC;IAElC;;;;;;;;;OASG;IACH,OAAO,EAAE,CAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,KAAM,MAAM,CAAC;IAE5E;;;;;;;;;;;;OAYG;IACH,MAAM,EAAE,CAAE,OAAO,EAAE,gBAAgB,KAAM,MAAM,CAAC;CAChD"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAAE,CAAC;IAE5C;;OAEG;IACH,OAAO,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,SAAS;IACzB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,EAAE,cAAc,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAE,cAAc,CAAE,GAAG,MAAM,CAAC;IAE3C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,cAAc,GAAG,QAAQ,GAAG,QAAQ,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,MAAM,KAAK,GACd,WAAW,CAAE,UAAU,CAAE,MAAM,CAAE,MAAM,CAAE,CAAE,CAAE,GAC7C,UAAU,GACV,SAAS,CAAE,MAAM,CAAE,CAAC;AAEvB;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,CAAE,SAAS,EAAE,SAAS,KAAM,MAAM,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,SAAS;IACnD;;;;OAIG;IACH,MAAM,EAAE,MAAM,MAAM,CAAC;IAErB;;;;;;;;;OASG;IACH,GAAG,EAAE,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,KAAM,MAAM,GAAG,SAAS,CAAC;IAErD;;;;;;;;;;OAUG;IACH,GAAG,EAAE,CAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,KAAM,iBAAiB,CAAC;CACnE"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/shortcode",
-	"version": "4.37.1-next.79a2f3cdd.0",
+	"version": "4.37.1-next.v.0+500f87dd8",
 	"description": "Shortcode module for WordPress.",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -49,5 +49,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "6a324496a37d9a333a11d4d7fe5fb93b8152a5ba"
+	"gitHead": "ca0db0ee8ac2116cd307650136027d26d0cdd9bd"
 }