@webcoder49/code-input 2.8.3 → 2.8.4

package/README.md

@@ -1,4 +1,4 @@
-# code-input
+# [code-input.js](https://v2.code-input-js.org/)
 
 ![Click to Switch](https://img.shields.io/static/v1?label=&message=Click%20to%20Switch:%20&color=grey&style=for-the-badge)[![Website and Demos](https://img.shields.io/static/v1?label=&message=Website&color=444400&style=for-the-badge)](https://code-input-js.org)[![GitHub](https://img.shields.io/static/v1?label=&message=GitHub&color=black&style=for-the-badge&logo=github)](https://github.com/WebCoder49/code-input)[![Codeberg](https://img.shields.io/static/v1?label=&message=Codeberg&color=navy&style=for-the-badge&logo=codeberg)](https://codeberg.org/code-input-js/code-input-js)[![Yarn](https://img.shields.io/static/v1?label=&message=Yarn&color=purple&style=for-the-badge&logo=yarn)](https://yarnpkg.com/package?name=@webcoder49/code-input)[![NPM](https://img.shields.io/static/v1?label=&message=NPM&color=red&style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@webcoder49/code-input)
 

package/code-input.d.ts

@@ -424,7 +424,7 @@ export class CodeInput extends HTMLTextAreaElement { // Tries to implement texta
   /**
    * When the code-input's template is registered, this contains its codeInput.Template object.
    */
-  templateObject?: readonly Template
+  /*readonly*/ templateObject?: Template // `readonly` commented for backwards compatibility
   /**
    * Exposed child textarea element for user to input code in; in this version of code-input you shouldn't need to access
    * it because most textarea functionality is present on the code-input element itself.

package/docs/_index.md

@@ -8,7 +8,7 @@ title = 'Flexible Syntax Highlighted Editable Textareas'
 
 ## Download
 
-*`code-input.js` is free, libre, open source software under the MIT (AKA Expat) license.* You have choices! **Download it from the Git repository on [GitHub](https://github.com/WebCoder49/code-input/tree/v2.8.3) or [Codeberg](https://codeberg.org/code-input-js/code-input-js/), [in a ZIP archive](/release/code-input-js-v2.8.3.zip), [in a TAR.GZ archive](/release/code-input-js-v2.8.3.tar.gz), or from `@webcoder49/code-input` on the NPM registry ([Yarn](https://yarnpkg.com/package?name=@webcoder49/code-input), [NPM](https://npmjs.com/package/@webcoder49/code-input), etc.).**
+*`code-input.js` is free, libre, open source software under the MIT (AKA Expat) license.* You have choices! **Download it from the Git repository on [GitHub](https://github.com/WebCoder49/code-input/tree/v2.8.4) or [Codeberg](https://codeberg.org/code-input-js/code-input-js/), [in a ZIP archive](/release/code-input-js-v2.8.4.zip), [in a TAR.GZ archive](/release/code-input-js-v2.8.4.tar.gz), or from `@webcoder49/code-input` on the NPM registry ([Yarn](https://yarnpkg.com/package?name=@webcoder49/code-input), [NPM](https://npmjs.com/package/@webcoder49/code-input), etc.).**
 
 [Want to contribute to the code? You're very welcome to! See here.](#contributing)
 

package/esm/README.md

@@ -7,7 +7,7 @@ If you are using Yarn, NPM, or a similar package manager, the files should have
 Otherwise, after changing directory to the one containing this file:
 
 - If you have Node.js installed, run `node generate.mjs`.
-- If you don't have Node.js installed but are on a POSIX-like system with `bash`/`zsh`, run `sh ./generate.sh`.
+- If you don't have Node.js installed but are on a POSIX-like system with `bash`/`zsh`, run `sh ./generate.sh`. (This uses features like `grep -o`, so won't work on *absolutely all* POSIX systems. It works on many computers though, so try it out first!) **Security-wise, we don't prevent JavaScript**
 - If neither of the above are true, install Node.js or (slightly harder; look online) a POSIX/"Linux" compatible shell.
 
 ## Extra Information

package/esm/code-input.d.mts

@@ -109,7 +109,7 @@ export class CodeInput extends HTMLTextAreaElement { // Tries to implement texta
   /**
    * When the code-input's template is registered, this contains its codeInput.Template object.
    */
-  templateObject?: readonly Template
+  /*readonly*/ templateObject?: Template // `readonly` commented for backwards compatibility
   /**
    * Exposed child textarea element for user to input code in; in this version of code-input you shouldn't need to access
    * it because most textarea functionality is present on the code-input element itself.
@@ -151,4 +151,27 @@ export class CodeInput extends HTMLTextAreaElement { // Tries to implement texta
  * @param {Object} template - a Template object instance - see `codeInput.templates`  
  */
 export function registerTemplate(templateName: string, template: Template): void;
-export default { Plugin, Template, CodeInput, registerTemplate };
+
+
+    // Prepare the default export:
+
+    // Values under the default export
+    declare const _default: {
+        Plugin: typeof Plugin;
+        Template: typeof Template;
+        CodeInput: typeof CodeInput;
+        registerTemplate: typeof registerTemplate;
+    }
+
+    // Type aliases to prevent ambiguous 'Plugin = Plugin'
+    declare type _Plugin = Plugin;
+    declare type _Template = Template;
+    declare type _CodeInput = CodeInput;
+    // Types under the default export
+    declare namespace _default {
+        export type Plugin = _Plugin;
+        export type Template = _Template;
+        export type CodeInput = _CodeInput;
+    }
+
+    export default _default;

package/esm/plugins/auto-close-brackets.d.mts

@@ -1,15 +1,16 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
-import { Plugin, CodeInput } from "../code-input.d.mts";
+import type { Plugin, CodeInput } from "../code-input.d.mts";
   /**
    * Automatically closes pairs of brackets/quotes/other syntaxes in code, but also lets you choose the brackets this
    * is activated for.
    * Files: auto-close-brackets.js
    */
-  export default class AutoCloseBrackets extends Plugin {
+  declare class AutoCloseBrackets extends Plugin {
     /**
      * Create an auto-close brackets plugin to pass into a template
      * @param {Object} bracketPairs Opening brackets mapped to closing brackets, default and example {"(": ")", "[": "]", "{": "}", '"': '"'}. All brackets must only be one character.
      */
     constructor(bracketPairs?: Object);
   }
+export default AutoCloseBrackets;

package/esm/plugins/auto-close-brackets.mjs

@@ -1,7 +1,7 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
 import { Plugin } from "../code-input.mjs";
-const plugins = {};
+let plugins = {};
 /**
  * Automatically close pairs of brackets/quotes/other syntaxes in code, but also optionally choose the brackets this
  * is activated for.

package/esm/plugins/autocomplete.d.mts

@@ -1,14 +1,15 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
-import { Plugin, CodeInput } from "../code-input.d.mts";
+import type { Plugin, CodeInput } from "../code-input.d.mts";
   /**
    * Display a popup under the caret using the text in the code-input element. This works well with autocomplete suggestions.
    * Files: autocomplete.js / autocomplete.css
    */
-  export default class Autocomplete extends Plugin {
+  declare class Autocomplete extends Plugin {
     /**
      * Pass in a function to create a plugin that displays the popup that takes in (popup element, textarea, textarea.selectionEnd).
      * @param {(popupElement: HTMLElement, textarea: HTMLTextAreaElement, selectionEnd: number, selectionStart?: number) => void} updatePopupCallback  a function to display the popup that takes in (popup element, textarea, textarea.selectionEnd).
      */
     constructor(updatePopupCallback: (popupElem: HTMLElement, textarea: HTMLTextAreaElement, selectionEnd: number, selectionStart?: number) => void);
   }
+export default Autocomplete;

package/esm/plugins/autocomplete.mjs

@@ -1,7 +1,7 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
 import { Plugin } from "../code-input.mjs";
-const plugins = {};
+let plugins = {};
 /**
  * Display a popup under the caret using the text in the code-input element. This works well with autocomplete suggestions.
  * Files: autocomplete.js / autocomplete.css

package/esm/plugins/autodetect.d.mts

@@ -1,11 +1,12 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
-import { Plugin, CodeInput } from "../code-input.d.mts";
+import type { Plugin, CodeInput } from "../code-input.d.mts";
   /**
    * Autodetect the language live and change the `lang` attribute using the syntax highlighter's 
    * autodetect capabilities. Works with highlight.js only.
    * Files: autodetect.js
    */
-  export default class Autodetect extends Plugin {
+  declare class Autodetect extends Plugin {
     constructor();
   }
+export default Autodetect;

package/esm/plugins/autodetect.mjs

@@ -1,7 +1,7 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
 import { Plugin } from "../code-input.mjs";
-const plugins = {};
+let plugins = {};
 /**
  * Autodetect the language live and change the `lang` attribute using the syntax highlighter's 
  * autodetect capabilities. Works with highlight.js only.

package/esm/plugins/find-and-replace.d.mts

@@ -1,11 +1,11 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
-import { Plugin, CodeInput } from "../code-input.d.mts";
+import type { Plugin, CodeInput } from "../code-input.d.mts";
   /**
    * Add Find-and-Replace (Ctrl/Cmd+F for find, Ctrl+H for replace by default) functionality to the code editor.
    * Files: find-and-replace.js / find-and-replace.css
    */
-  export default class FindAndReplace extends Plugin {
+  declare class FindAndReplace extends Plugin {
     /**
      * Create a find-and-replace command plugin to pass into a template. To ensure keyboard shortcuts remain intuitive, set the alwaysCtrl parameter to false.
      * @param {boolean} useCtrlF Should Ctrl/Cmd+F be overridden for find-and-replace find functionality? Either way, you can also trigger it yourself using (instance of this plugin)`.showPrompt(code-input element, false)`.
@@ -43,3 +43,4 @@ import { Plugin, CodeInput } from "../code-input.d.mts";
      */
     showPrompt(codeInputElement: CodeInput, replacePartExpanded: boolean): void;
   }
+export default FindAndReplace;

package/esm/plugins/find-and-replace.mjs

@@ -1,7 +1,7 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
 import { Plugin } from "../code-input.mjs";
-const plugins = {};
+let plugins = {};
 /**
  * Add Find-and-Replace (Ctrl/Cmd+F for find, Ctrl+H for replace by default) functionality to the code editor.
  * Files: find-and-replace.js / find-and-replace.css

package/esm/plugins/go-to-line.d.mts

@@ -1,11 +1,11 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
-import { Plugin, CodeInput } from "../code-input.d.mts";
+import type { Plugin, CodeInput } from "../code-input.d.mts";
   /**
    * Add Go-To-Line (Ctrl/Cmd+G by default) functionality to the code editor.
    * Files: go-to-line.js / go-to-line.css
    */
-  export default class GoToLine extends Plugin {
+  declare class GoToLine extends Plugin {
     /**
      * Create a go-to-line command plugin to pass into a template.
      * @param {boolean} useCtrlG Should Ctrl/Cmd+G be overridden for go-to-line functionality? Either way, you can trigger it yourself using (instance of this plugin)`.showPrompt(code-input element)`.
@@ -28,3 +28,4 @@ import { Plugin, CodeInput } from "../code-input.d.mts";
     */
     showPrompt(codeInput: CodeInput): void;
   }
+export default GoToLine;

package/esm/plugins/go-to-line.mjs

@@ -1,7 +1,7 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
 import { Plugin } from "../code-input.mjs";
-const plugins = {};
+let plugins = {};
 /**
  * Add Go-To-Line (Ctrl/Cmd+G by default) functionality to the code editor.
  * Files: go-to-line.js / go-to-line.css

package/esm/plugins/indent.d.mts

@@ -1,12 +1,12 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
-import { Plugin, CodeInput } from "../code-input.d.mts";
+import type { Plugin, CodeInput } from "../code-input.d.mts";
   /**
    * Adds indentation using the `Tab` key, and auto-indents after a newline, as well as making it 
    * possible to indent/unindent multiple lines using Tab/Shift+Tab
    * Files: indent.js
    */
-  export default class Indent extends Plugin {
+  declare class Indent extends Plugin {
     /**
      * Create an indentation plugin to pass into a template
      * @param {boolean} defaultSpaces Should the Tab key enter spaces rather than tabs? Defaults to false.
@@ -20,3 +20,4 @@ import { Plugin, CodeInput } from "../code-input.d.mts";
       tabForNavigation?: string;
     });
   }
+export default Indent;

package/esm/plugins/indent.mjs

@@ -1,7 +1,7 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
 import { Plugin } from "../code-input.mjs";
-const plugins = {};
+let plugins = {};
 /**
  * Add indentation using the `Tab` key, and auto-indents after a newline, as well as making it 
  * possible to indent/unindent multiple lines using Tab/Shift+Tab

package/esm/plugins/select-token-callbacks.d.mts

@@ -1,18 +1,18 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
-import { Plugin, CodeInput } from "../code-input.d.mts";
+import type { Plugin, CodeInput } from "../code-input.d.mts";
   /**
    * Make tokens in the <pre><code> element that are included within the selected text of the <code-input>
-   * gain a CSS export default class while selected, or trigger JavaScript callbacks.
+   * gain a CSS class while selected, or trigger JavaScript callbacks.
    * Files: select-token-callbacks.js
    */
-  class SelectTokenCallbacks extends Plugin {
+  declare class SelectTokenCallbacks extends Plugin {
     /**
      * Set up the behaviour of tokens text-selected in the `<code-input>` element, and the exact definition of a token being text-selected.
      * 
      * All parameters are optional. If you provide no arguments to the constructor, this will dynamically apply the "code-input_select-token-callbacks_selected" class to selected tokens only, for you to style via CSS.
      * 
-     * @param {codeInput.plugins.SelectTokenCallbacks.TokenSelectorCallbacks} tokenSelectorCallbacks What to do with text-selected tokens. See docstrings for the TokenSelectorCallbacks class.
+     * @param {SelectTokenCallbacks.TokenSelectorCallbacks} tokenSelectorCallbacks What to do with text-selected tokens. See docstrings for the TokenSelectorCallbacks class.
      * @param {boolean} onlyCaretNotSelection If true, tokens will only be marked as selected when no text is selected but rather the caret is inside them (start of selection == end of selection). Default false.
      * @param {boolean} caretAtStartIsSelected Whether the caret or text selection's end being just before the first character of a token means said token is selected. Default true.
      * @param {boolean} caretAtEndIsSelected Whether the caret or text selection's start being just after the last character of a token means said token is selected. Default true.
@@ -20,10 +20,10 @@ import { Plugin, CodeInput } from "../code-input.d.mts";
      * @param {boolean} partiallySelectedTokensAreSelected Whether tokens for which only some of their text is selected should be treated as selected. Default true.
      * @param {boolean} parentTokensAreSelected Whether all parent tokens of selected tokens should be treated as selected. Default true.
      */
-    constructor(tokenSelectorCallbacks?: codeInput.plugins.SelectTokenCallbacks.TokenSelectorCallbacks, onlyCaretNotSelection?: boolean, caretAtStartIsSelected?: boolean, caretAtEndIsSelected?: boolean, createSubTokens?: boolean, partiallySelectedTokensAreSelected?: boolean, parentTokensAreSelected?: boolean);
+    constructor(tokenSelectorCallbacks?: SelectTokenCallbacks.TokenSelectorCallbacks, onlyCaretNotSelection?: boolean, caretAtStartIsSelected?: boolean, caretAtEndIsSelected?: boolean, createSubTokens?: boolean, partiallySelectedTokensAreSelected?: boolean, parentTokensAreSelected?: boolean);
   }
 
-  namespace SelectTokenCallbacks {
+  declare namespace SelectTokenCallbacks {
     /**
      * A data structure specifying what should be done with tokens when they are selected, and also allows for previously selected
      * tokens to be dealt with each time the selection changes. See the constructor and the createClassSynchronisation static method.
@@ -46,6 +46,7 @@ import { Plugin, CodeInput } from "../code-input.d.mts";
        * @param {string} selectedClass The CSS class that will be present on tokens only when they are part of the selected text in the `<code-input>` element. Defaults to "code-input_select-token-callbacks_selected".
        * @returns {TokenSelectorCallbacks} A new TokenSelectorCallbacks instance that encodes this behaviour.
        */
-      static createClassSynchronisation(selectedClass?: string): codeInput.plugins.SelectTokenCallbacks.TokenSelectorCallbacks;
+      static createClassSynchronisation(selectedClass?: string): SelectTokenCallbacks.TokenSelectorCallbacks;
     }
   }
+export default SelectTokenCallbacks;

package/esm/plugins/select-token-callbacks.mjs

@@ -1,7 +1,7 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
 import { Plugin } from "../code-input.mjs";
-const plugins = {};
+let plugins = {};
 /**
  * Make tokens in the <pre><code> element that are included within the selected text of the <code-input>
  * gain a CSS class while selected, or trigger JavaScript callbacks.

package/esm/plugins/special-chars.d.mts

@@ -1,6 +1,6 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
-import { Plugin, CodeInput } from "../code-input.d.mts";
+import type { Plugin, CodeInput } from "../code-input.d.mts";
   /**
    * Render special characters and control characters as a symbol with their hex code.
    * Files: special-chars.js, special-chars.css
@@ -13,7 +13,7 @@ import { Plugin, CodeInput } from "../code-input.d.mts";
    *
    * See https://github.com/WebCoder49/code-input/issues?q=is%3Aissue%20state%3Aopen%20specialchars
    */
-  export default class SpecialChars extends Plugin {
+  declare class SpecialChars extends Plugin {
     /**
      * Create a special characters plugin instance.
      * Default = covers many non-renderable ASCII characters.
@@ -23,3 +23,4 @@ import { Plugin, CodeInput } from "../code-input.d.mts";
      */
     constructor(colorInSpecialChars?: boolean, inheritTextColor?: boolean, specialCharRegExp?: RegExp);
   }
+export default SpecialChars;

package/esm/plugins/special-chars.mjs

@@ -1,7 +1,7 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
 import { Plugin } from "../code-input.mjs";
-const plugins = {};
+let plugins = {};
 /**
  * Render special characters and control characters as a symbol with their hex code.
  * Files: special-chars.js, special-chars.css

package/esm/plugins/test.d.mts

@@ -1,6 +1,6 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
-import { Plugin, CodeInput } from "../code-input.d.mts";
+import type { Plugin, CodeInput } from "../code-input.d.mts";
   /**
    * JavaScript example of a plugin, which brings extra,
    * non-central optional functionality to code-input.
@@ -8,9 +8,10 @@ import { Plugin, CodeInput } from "../code-input.d.mts";
    * to the `plugins` argument when registering a template,
    * for example like this:
    * ```javascript
-   * codeInput.registerTemplate("syntax-highlighted", codeInput.templates.hljs(hljs, [new codeInput.plugins.Test()]));
+   * codeInput.registerTemplate("syntax-highlighted", codeInput.templates.hljs(hljs, [new Test()]));
    * ```
    */
-  export default class Test extends Plugin {
+  declare class Test extends Plugin {
     constructor();
   }
+export default Test;

package/esm/plugins/test.mjs

@@ -1,7 +1,7 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
 import { Plugin } from "../code-input.mjs";
-const plugins = {};
+let plugins = {};
 /**
  * Copy this to create a plugin, which brings extra,
  * non-central optional functionality to code-input.

package/esm/templates/hljs.d.mts

@@ -1,6 +1,6 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
-import { Template, Plugin } from "../code-input.d.mts";
+import type { Template, Plugin } from "../code-input.d.mts";
   /**
    * A template that uses highlight.js syntax highlighting (https://highlightjs.org/).
    */

package/esm/templates/prism.d.mts

@@ -1,6 +1,6 @@
 // NOTICE: This code is @generated from code outside the esm directory. Please do not edit it to contribute!
 
-import { Template, Plugin } from "../code-input.d.mts";
+import type { Template, Plugin } from "../code-input.d.mts";
   /**
    * A template that uses Prism.js syntax highlighting (https://prismjs.com/).
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webcoder49/code-input",
-  "version": "2.8.3",
+  "version": "2.8.4",
   "description": "An editable <textarea> that supports *any* syntax highlighting algorithm, for code or something else. Also, added plugins.",
   "browser": "code-input.js",
   "exports": {