nxt-highlightjs 20.0.0 → 21.0.0

package/package.json

@@ -2,10 +2,13 @@
   "name": "nxt-highlightjs",
   "description": "Angular code highlighting directives with optional line numbers and support for SSR",
   "bugs": "https://github.com/Liquid-JS/nxt-components/issues",
-  "version": "20.0.0",
+  "version": "21.0.0",
   "license": "MIT",
   "type": "module",
-  "repository": "https://github.com/Liquid-JS/nxt-components.git",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Liquid-JS/nxt-components.git"
+  },
   "homepage": "https://github.com/Liquid-JS/nxt-components/tree/master/packages/highlightjs",
   "keywords": [
     "nxt-highlightjs",
@@ -19,34 +22,34 @@
     "gist"
   ],
   "peerDependencies": {
-    "@angular/cdk": "^20.0.0",
-    "@angular/common": "^20.0.0",
-    "@angular/core": "^20.0.0",
-    "@angular/platform-browser": "^20.0.0",
+    "@angular/cdk": "^21.0.0",
+    "@angular/common": "^21.0.0",
+    "@angular/core": "^21.0.0",
+    "@angular/platform-browser": "^21.0.0",
     "highlight.js": ">=11.11.1",
     "rxjs": "^7.8.2"
   },
-  "dependencies": {
-    "tslib": "^2.8.1"
-  },
   "module": "fesm2022/nxt-highlightjs.mjs",
-  "typings": "index.d.ts",
+  "typings": "types/nxt-highlightjs.d.ts",
   "exports": {
     "./package.json": {
       "default": "./package.json"
     },
     ".": {
-      "types": "./index.d.ts",
+      "types": "./types/nxt-highlightjs.d.ts",
       "default": "./fesm2022/nxt-highlightjs.mjs"
     },
     "./extras": {
-      "types": "./extras/index.d.ts",
+      "types": "./types/nxt-highlightjs-extras.d.ts",
       "default": "./fesm2022/nxt-highlightjs-extras.mjs"
     },
     "./line-numbers": {
-      "types": "./line-numbers/index.d.ts",
+      "types": "./types/nxt-highlightjs-line-numbers.d.ts",
       "default": "./fesm2022/nxt-highlightjs-line-numbers.mjs"
     }
   },
-  "sideEffects": false
+  "sideEffects": false,
+  "dependencies": {
+    "tslib": "^2.3.0"
+  }
 }

package/{extras/index.d.ts → types/nxt-highlightjs-extras.d.ts}

@@ -1,7 +1,29 @@
 import * as i0 from '@angular/core';
-import { PipeTransform, InjectionToken, Provider, OnDestroy, EventEmitter } from '@angular/core';
+import { InjectionToken, PipeTransform, Provider, Signal } from '@angular/core';
 import { Observable } from 'rxjs';
+import * as nxt_highlightjs_extras from 'nxt-highlightjs/extras';
+import { HttpClient } from '@angular/common/http';
+import { RxResourceOptions } from '@angular/core/rxjs-interop';
 
+/**
+ * Injection token used to provide the current location to `codeFromUrl` pipe.
+ * Used to handle server-side rendering and to stub out during unit tests.
+ */
+declare const NXT_HIGHLIGHT_FILE_LOCATION: InjectionToken<CodeFileLocation>;
+/**
+ * @internal
+ */
+interface CodeFileLocation {
+    formatPathname: (path: string) => string;
+}
+/** @internal */
+declare function CODE_FILE_LOCATION_FACTORY(): {
+    formatPathname: (path: string) => string;
+};
+
+/**
+ * @deprecated use fileResource with `{ formatUrl: true }`
+ */
 declare class CodeFromUrlPipe implements PipeTransform {
     private readonly location;
     private readonly loader;
@@ -10,11 +32,15 @@ declare class CodeFromUrlPipe implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<CodeFromUrlPipe, "codeFromUrl", true>;
 }
 
+/** @internal */
 declare function isUrl(url: string): boolean;
 interface GistOptions {
     clientId: string;
     clientSecret: string;
 }
+/**
+ * @internal
+ */
 declare const NXT_GIST_OPTIONS: InjectionToken<GistOptions>;
 declare function provideGistOptions(options: GistOptions): Provider[];
 interface Owner {
@@ -104,37 +130,56 @@ interface Gist {
     truncated: boolean;
 }
 
+/** @internal */
 declare class CodeLoader {
-    private readonly http;
-    private readonly options;
+    readonly http: HttpClient;
+    readonly options: nxt_highlightjs_extras.GistOptions | null;
+    private readonly pendingTasks;
     /**
      * Get plus code
      *
      * @param id Gist ID
+     * @deprecated Use gistResource
      */
     getCodeFromGist(id: string): Observable<Gist>;
     /**
      * Get code by URL
      *
      * @param url File raw link
+     * @deprecated Use fileResource
      */
     getCodeFromUrl(url: string): Observable<string>;
-    private fetchFile;
+    fetchFile(url: string, options: any): Observable<any>;
     static ɵfac: i0.ɵɵFactoryDeclaration<CodeLoader, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<CodeLoader>;
 }
+/**
+ * Code resource by URL
+ *
+ * @param url File raw link
+ */
+declare function fileResource(url: string | Signal<string>, _options?: Omit<RxResourceOptions<string, string>, 'params' | 'stream'> & {
+    formatUrl?: boolean;
+}): i0.ResourceRef<string | undefined>;
+/**
+ * Gist resource by id
+ *
+ * @param id Gist ID
+ */
+declare function gistResource(id: string | Signal<string>, options?: Omit<RxResourceOptions<Gist, string>, 'params' | 'stream'>): i0.ResourceRef<Gist | undefined>;
 
-declare class GistDirective implements OnDestroy {
+/**
+ * @deprecated use gistResource
+ */
+declare class GistDirective {
     private readonly loader;
     private readonly pendingTasks;
-    private readonly cdRef;
-    private subscription?;
-    set gist(value: string);
-    gistLoad: EventEmitter<Gist>;
-    gistError: EventEmitter<any>;
-    ngOnDestroy(): void;
+    readonly gist: i0.InputSignal<string | undefined>;
+    readonly gistLoad: i0.OutputEmitterRef<Gist>;
+    readonly gistError: i0.OutputEmitterRef<any>;
+    constructor();
     static ɵfac: i0.ɵɵFactoryDeclaration<GistDirective, never>;
-    static ɵdir: i0.ɵɵDirectiveDeclaration<GistDirective, "[nxtGist]", never, { "gist": { "alias": "nxtGist"; "required": false; }; }, { "gistLoad": "gistLoad"; "gistError": "gistError"; }, never, never, true, never>;
+    static ɵdir: i0.ɵɵDirectiveDeclaration<GistDirective, "[nxtGist]", never, { "gist": { "alias": "nxtGist"; "required": false; "isSignal": true; }; }, { "gistLoad": "gistLoad"; "gistError": "gistError"; }, never, never, true, never>;
 }
 declare class GistFilePipe implements PipeTransform {
     transform(gist?: Gist | null, fileName?: string | null): GistFile | undefined;
@@ -142,11 +187,12 @@ declare class GistFilePipe implements PipeTransform {
     static ɵpipe: i0.ɵɵPipeDeclaration<GistFilePipe, "gistFile", true>;
 }
 
+/** @deprecated use standalone imports */
 declare class HighlightExstrasModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<HighlightExstrasModule, never>;
     static ɵmod: i0.ɵɵNgModuleDeclaration<HighlightExstrasModule, never, [typeof GistDirective, typeof GistFilePipe, typeof CodeFromUrlPipe], [typeof GistDirective, typeof GistFilePipe, typeof CodeFromUrlPipe]>;
     static ɵinj: i0.ɵɵInjectorDeclaration<HighlightExstrasModule>;
 }
 
-export { CodeFromUrlPipe, CodeLoader, GistDirective, GistFilePipe, HighlightExstrasModule, NXT_GIST_OPTIONS, isUrl, provideGistOptions };
-export type { Gist, GistFile, GistOptions };
+export { CODE_FILE_LOCATION_FACTORY, CodeFromUrlPipe, CodeLoader, GistDirective, GistFilePipe, HighlightExstrasModule, NXT_GIST_OPTIONS, NXT_HIGHLIGHT_FILE_LOCATION, fileResource, gistResource, isUrl, provideGistOptions };
+export type { CodeFileLocation, Gist, GistFile, GistOptions };

package/{line-numbers/index.d.ts → types/nxt-highlightjs-line-numbers.d.ts}

@@ -1,9 +1,6 @@
+import { LineNumbersOptions } from 'nxt-highlightjs';
 import * as _angular_core from '@angular/core';
 
-interface LineNumbersOptions {
-    startFrom?: number;
-    singleLine?: boolean;
-}
 declare function activateLineNumbers(document: Document): (code: string, options?: LineNumbersOptions) => string;
 
 declare class HighlightLineNumbersDirective {

package/{index.d.ts → types/nxt-highlightjs.d.ts}

@@ -20,67 +20,92 @@ interface HighlightJSOptions {
     }>;
     themePath?: string;
 }
+/**
+ * @internal
+ */
 declare const NXT_HIGHLIGHT_OPTIONS: InjectionToken<HighlightJSOptions>;
 declare function provideHighlightOptions(options: HighlightJSOptions): i0.EnvironmentProviders;
 
 declare class HighlightJS {
     private readonly loader;
     readonly hljs: i0.Signal<HLJSApi | undefined>;
-    constructor();
     /**
      * Core highlighting function. Accepts the code to highlight (string) and a list of options (object)
+     *
+     * @deprecated use hljs().highlight
      */
     highlight(code: string, options: HighlightOptions): Promise<HighlightResult>;
     /**
      * Highlighting with language detection.
+     *
+     * @deprecated use hljs().highlightAuto
      */
     highlightAuto(value: string, languageSubset?: string[]): Promise<AutoHighlightResult>;
     /**
      * Applies highlighting to a DOM node containing code.
      * This function is the one to use to apply highlighting dynamically after page load or within initialization code of third-party JavaScript frameworks.
      * The function uses language detection by default but you can specify the language in the class attribute of the DOM node. See the scopes reference for all available language names and scopes.
+     *
+     * @deprecated use hljs().highlightElement
      */
     highlightElement(element: HTMLElement): Promise<void>;
     /**
      * Applies highlighting to all elements on a page matching the configured cssSelector. The default cssSelector value is 'pre code',
      * which highlights all code blocks. This can be called before or after the page’s onload event has fired.
+     *
+     * @deprecated use hljs().highlightAll
      */
     highlightAll(): Promise<void>;
     /**
      * Adds new language to the library under the specified name. Used mostly internally.
      * The function is passed the hljs object to be able to use common regular expressions defined within it.
+     *
+     * @deprecated use hljs().registerLanguage
      */
     registerLanguage(languageName: string, languageDefinition: LanguageFn): Promise<void>;
     /**
      * Removes a language and its aliases from the library. Used mostly internally
+     *
+     * @deprecated use hljs().unregisterLanguage
      */
     unregisterLanguage(languageName: string): Promise<void>;
     /**
      * Adds new language alias or aliases to the library for the specified language name defined under languageName key.
+     *
+     * @deprecated use hljs().registerAliases
      */
     registerAliases(alias: string | string[], { languageName }: {
         languageName: string;
     }): Promise<void>;
     /**
      * @return The languages names list.
+     * @deprecated use hljs().listLanguages
      */
     listLanguages(): Promise<string[]>;
     /**
      * Looks up a language by name or alias.
+     *
+     * @deprecated use hljs().getLanguage
      */
     getLanguage(name: string): Promise<any>;
     /**
      * Enables safe mode. This is the default mode, providing the most reliable experience for production usage.
+     *
+     * @deprecated use hljs().safeMode
      */
     safeMode(): Promise<void>;
     /**
      * Enables debug/development mode.
+     *
+     * @deprecated use hljs().debugMode
      */
     debugMode(): Promise<void>;
     /**
      * Display line numbers
+     *
+     * @deprecated use hljs().lineNumbersBlock
      */
-    lineNumbersBlock(el: HTMLElement, options: LineNumbersOptions): Promise<void>;
+    lineNumbersBlock(code: string, options: LineNumbersOptions): Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<HighlightJS, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<HighlightJS>;
 }
@@ -92,15 +117,15 @@ declare abstract class HighlightBase {
     /**
      * Code to highlight
      */
-    abstract code: InputSignal<string | null | undefined>;
+    abstract readonly code: InputSignal<string | undefined>;
     /**
      * Highlighted result
      */
-    abstract highlightResult: WritableSignal<HighlightResult | AutoHighlightResult | undefined>;
+    abstract readonly highlightResult: WritableSignal<HighlightResult | AutoHighlightResult | undefined>;
     /**
      * Stream that emits when code string is highlighted
      */
-    abstract highlighted: OutputEmitterRef<HighlightResult | AutoHighlightResult | undefined>;
+    abstract readonly highlighted: OutputEmitterRef<HighlightResult | AutoHighlightResult | undefined>;
     constructor();
     protected abstract highlightElement(code: string): HighlightResult | AutoHighlightResult | undefined;
     private setTextContent;
@@ -113,11 +138,11 @@ declare class HighlightAutoDirective extends HighlightBase {
     /**
      * Code to highlight
      */
-    code: i0.InputSignal<string | null | undefined>;
+    readonly code: i0.InputSignal<string | undefined>;
     /**
      * Highlighted result
      */
-    highlightResult: i0.WritableSignal<AutoHighlightResult | undefined>;
+    readonly highlightResult: i0.WritableSignal<AutoHighlightResult | undefined>;
     /**
      * An optional array of language names and aliases restricting detection to only those languages
      *
@@ -127,7 +152,7 @@ declare class HighlightAutoDirective extends HighlightBase {
     /**
      * Stream that emits when code string is highlighted
      */
-    highlighted: OutputEmitterRef<AutoHighlightResult>;
+    readonly highlighted: i0.OutputEmitterRef<AutoHighlightResult>;
     protected highlightElement(code: string): AutoHighlightResult | undefined;
     static ɵfac: i0.ɵɵFactoryDeclaration<HighlightAutoDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<HighlightAutoDirective, "[nxtHighlightAuto]", never, { "code": { "alias": "nxtHighlightAuto"; "required": false; "isSignal": true; }; "languages": { "alias": "languages"; "required": false; "isSignal": true; }; }, { "highlighted": "highlighted"; }, never, never, true, never>;
@@ -137,15 +162,15 @@ declare class HighlightDirective extends HighlightBase {
     /**
      * Code to highlight
      */
-    code: InputSignal<string | null | undefined>;
+    readonly code: i0.InputSignal<string | undefined>;
     /**
      * Highlighted result
      */
-    highlightResult: i0.WritableSignal<HighlightResult | undefined>;
+    readonly highlightResult: i0.WritableSignal<HighlightResult | undefined>;
     /**
      * The language name highlight only one language
      */
-    readonly language: InputSignal<string>;
+    readonly language: i0.InputSignal<string>;
     /**
      * An optional flag, when set to true it forces highlighting to finish even in case of detecting
      * illegal syntax for the language instead of throwing an exception
@@ -154,7 +179,7 @@ declare class HighlightDirective extends HighlightBase {
     /**
      * Stream that emits when code string is highlighted
      */
-    highlighted: i0.OutputEmitterRef<HighlightResult>;
+    readonly highlighted: i0.OutputEmitterRef<HighlightResult>;
     highlightElement(code: string): HighlightResult | undefined;
     static ɵfac: i0.ɵɵFactoryDeclaration<HighlightDirective, never>;
     static ɵdir: i0.ɵɵDirectiveDeclaration<HighlightDirective, "[nxtHighlight]", never, { "code": { "alias": "nxtHighlight"; "required": false; "isSignal": true; }; "language": { "alias": "language"; "required": true; "isSignal": true; }; "ignoreIllegals": { "alias": "ignoreIllegals"; "required": false; "isSignal": true; }; }, { "highlighted": "highlighted"; }, never, never, true, never>;
@@ -165,7 +190,12 @@ declare class HighlightLoader {
     private readonly options;
     private readonly pendingTasks;
     private _t;
-    readonly ready: Promise<HLJSApi>;
+    readonly hljs: i0.Resource<HLJSApi | undefined>;
+    private readonly _ready$;
+    /**
+     * @deprecated use hljs.value()
+     */
+    get ready(): Promise<HLJSApi>;
     private themeLinkElement?;
     constructor();
     /**
@@ -188,6 +218,7 @@ declare class HighlightLoader {
     static ɵprov: i0.ɵɵInjectableDeclaration<HighlightLoader>;
 }
 
+/** @deprecated use standalone imports */
 declare class HighlightModule {
     static ɵfac: i0.ɵɵFactoryDeclaration<HighlightModule, never>;
     static ɵmod: i0.ɵɵNgModuleDeclaration<HighlightModule, never, [typeof HighlightDirective, typeof HighlightAutoDirective], [typeof HighlightDirective, typeof HighlightAutoDirective]>;