Export all Autolinker interfaces from index.ts

Author: gregjacobs

gulpfile.js

@@ -59,7 +59,7 @@ gulp.task( 'do-build-src', gulp.series(
 	'build-src-add-header-to-umd', 
 	'build-src-minify-umd',
 	'build-src-check-minfied-size'
-), )
+) );
 
 // Build example private tasks
 gulp.task( 'clean-example-output', cleanExampleOutputTask );
@@ -99,6 +99,7 @@ gulp.task( 'do-test', gulp.series(
 	'run-integration-tests'
 ) );
 gulp.task( 'do-unit-tests', gulp.series( 'build-unit-tests', 'run-unit-tests' ) );  // just runs the unit tests without the integration tests
+gulp.task( 'do-integration-tests', gulp.series( 'build-integration-tests', 'run-integration-tests' ) );  // just runs the integration tests without the unit tests
 
 
 // Main Tasks
@@ -123,6 +124,7 @@ gulp.task( 'doc', gulp.series( 'build-src', 'do-doc' ) );
 gulp.task( 'serve', gulp.series( 'build-src', 'build-example', serveTask ) );
 gulp.task( 'test', gulp.series( 'build-src', 'build-example', 'clean-tests', 'do-test' ) );
 gulp.task( 'test-unit', gulp.series( 'clean-unit-tests', 'do-unit-tests' ) );  // just runs the unit tests without the integration tests
+gulp.task( 'test-integration', gulp.series( 'build-src', 'clean-integration-tests', 'do-integration-tests' ) );  // just runs the integration tests without the unit tests
 gulp.task( 'update-tld-regex', updateTldRegex );
 
 gulp.task( 'default', gulp.series( 'build-all', 'do-doc', 'do-test' ) );

package.json

@@ -21,6 +21,7 @@
     "serve": "gulp serve",
     "test": "gulp test",
     "test-unit": "gulp test-unit",
+    "test-integration": "gulp test-integration",
     "update-tld-regex": "gulp update-tld-regex"
   },
   "repository": {

src/anchor-tag-builder.ts

@@ -1,6 +1,6 @@
 import { Match } from "./match/match";
 import { HtmlTag } from "./html-tag";
-import { TruncateConfig } from "./autolinker";
+import { TruncateConfigObj } from "./autolinker";
 import { truncateSmart } from "./truncate/truncate-smart";
 import { truncateMiddle } from "./truncate/truncate-middle";
 import { truncateEnd } from "./truncate/truncate-end";
@@ -43,7 +43,7 @@ export class AnchorTagBuilder {
 	 * @cfg {Object} truncate
 	 * @inheritdoc Autolinker#truncate
 	 */
-	private readonly truncate: TruncateConfig = {};  // default value just to get the above doc comment in the ES5 output and documentation generator
+	private readonly truncate: TruncateConfigObj = {};  // default value just to get the above doc comment in the ES5 output and documentation generator
 
 	/**
 	 * @cfg {String} className
@@ -200,6 +200,6 @@ export class AnchorTagBuilder {
 
 export interface AnchorTagBuilderCfg {
 	newWindow?: boolean;
-	truncate?: TruncateConfig;
+	truncate?: TruncateConfigObj;
 	className?: string
 }

src/autolinker.ts

@@ -280,7 +280,7 @@ export default class Autolinker {
 	 *   in the given text. Ex: `google.com`, `asdf.org/?page=1`, etc. `false`
 	 *   to prevent these types of matches.
 	 */
-	private readonly urls: UrlsConfig = {};  // default value just to get the above doc comment in the ES5 output and documentation generator
+	private readonly urls: UrlsConfigObj = {};  // default value just to get the above doc comment in the ES5 output and documentation generator
 
 	/**
 	 * @cfg {Boolean} [email=true]
@@ -310,7 +310,7 @@ export default class Autolinker {
 	 *
 	 * Pass `false` to skip auto-linking of hashtags.
 	 */
-	private readonly hashtag: false | HashtagServices = false;  // default value just to get the above doc comment in the ES5 output and documentation generator
+	private readonly hashtag: HashtagConfig = false;  // default value just to get the above doc comment in the ES5 output and documentation generator
 
 	/**
 	 * @cfg {String/Boolean} [mention=false]
@@ -324,7 +324,7 @@ export default class Autolinker {
 	 *
 	 * Defaults to `false` to skip auto-linking of mentions.
 	 */
-	private readonly mention: false | MentionServices = false;  // default value just to get the above doc comment in the ES5 output and documentation generator
+	private readonly mention: MentionConfig = false;  // default value just to get the above doc comment in the ES5 output and documentation generator
 
 	/**
 	 * @cfg {Boolean} [newWindow=true]
@@ -366,7 +366,7 @@ export default class Autolinker {
 	 *   `'www.google.com'` will be displayed as `'google.com'`. `false` to not
 	 *   strip the `'www'`.
 	 */
-	private readonly stripPrefix: StripPrefixConfig = { scheme: true, www: true };  // default value just to get the above doc comment in the ES5 output and documentation generator
+	private readonly stripPrefix: Required<StripPrefixConfigObj> = { scheme: true, www: true };  // default value just to get the above doc comment in the ES5 output and documentation generator
 
 	/**
 	 * @cfg {Boolean} [stripTrailingSlash=true]
@@ -437,7 +437,7 @@ export default class Autolinker {
 	 *   'yahoo.com/some..to/a/file'. For more details, see
 	 *   {@link Autolinker.truncate.TruncateSmart}.
 	 */
-	private readonly truncate: TruncateConfig = { length: 0, location : 'end' };  // default value just to get the above doc comment in the ES5 output and documentation generator
+	private readonly truncate: Required<TruncateConfigObj> = { length: 0, location : 'end' };  // default value just to get the above doc comment in the ES5 output and documentation generator
 
 	/**
 	 * @cfg {String} className
@@ -474,7 +474,7 @@ export default class Autolinker {
 	 *   is currently processing. See {@link Autolinker.match.Match} subclasses
 	 *   for details.
 	 */
-	private readonly replaceFn: null | ( ( match: Match ) => ReplaceFnReturn ) = null;  // default value just to get the above doc comment in the ES5 output and documentation generator
+	private readonly replaceFn: ReplaceFn | null = null;  // default value just to get the above doc comment in the ES5 output and documentation generator
 
 	/**
 	 * @cfg {Object} context
@@ -554,7 +554,9 @@ export default class Autolinker {
 	 * @param {Boolean/Object} urls
 	 * @return {Object}
 	 */
-	private normalizeUrlsCfg( urls: boolean | UrlsConfig | undefined ): UrlsConfig {
+	private normalizeUrlsCfg( 
+		urls: UrlsConfig | undefined 
+	): Required<UrlsConfigObj> {
 		if( urls == null ) urls = true;  // default to `true`
 
 		if( typeof urls === 'boolean' ) {
@@ -580,7 +582,9 @@ export default class Autolinker {
 	 * @param {Boolean/Object} stripPrefix
 	 * @return {Object}
 	 */
-	private normalizeStripPrefixCfg( stripPrefix: boolean | StripPrefixConfig | undefined ) {
+	private normalizeStripPrefixCfg( 
+		stripPrefix: StripPrefixConfig | undefined 
+	): Required<StripPrefixConfigObj> {
 		if( stripPrefix == null ) stripPrefix = true;  // default to `true`
 
 		if( typeof stripPrefix === 'boolean' ) {
@@ -605,7 +609,9 @@ export default class Autolinker {
 	 * @param {Number/Object} truncate
 	 * @return {Object}
 	 */
-	private normalizeTruncateCfg( truncate: number | TruncateConfig | undefined ): TruncateConfig {
+	private normalizeTruncateCfg( 
+		truncate: TruncateConfig | undefined 
+	): Required<TruncateConfigObj> {
 		if( typeof truncate === 'number' ) {
 			return { length: truncate, location: 'end' };
 
@@ -957,40 +963,47 @@ export default class Autolinker {
 
 
 export interface AutolinkerConfig {
-	urls?: boolean | UrlsConfig;
+	urls?: UrlsConfig;
 	email?: boolean;
 	phone?: boolean;
-	hashtag?: false | HashtagServices;
-	mention?: false | MentionServices;
+	hashtag?: HashtagConfig;
+	mention?: MentionConfig;
 	newWindow?: boolean;
-	stripPrefix?: boolean | StripPrefixConfig;
+	stripPrefix?: StripPrefixConfig;
 	stripTrailingSlash?: boolean;
-	truncate?: number | TruncateConfig;
+	truncate?: TruncateConfig;
 	className?: string;
-	replaceFn?: ( match: Match ) => ReplaceFnReturn | null;
+	replaceFn?: ReplaceFn | null;
 	context?: any;
 	decodePercentEncoding?: boolean;
 }
 
-export interface UrlsConfig {
+export type UrlsConfig = boolean | UrlsConfigObj;
+export interface UrlsConfigObj {
 	schemeMatches?: boolean;
 	wwwMatches?: boolean;
 	tldMatches?: boolean;
 }
 
 export type UrlMatchTypeOptions = 'scheme' | 'www' | 'tld';
 
-export interface StripPrefixConfig {
-	scheme : boolean;
-	www    : boolean;
+export type StripPrefixConfig = boolean | StripPrefixConfigObj;
+export interface StripPrefixConfigObj {
+	scheme? : boolean;
+	www?    : boolean;
 }
 
-export interface TruncateConfig {
+export type TruncateConfig = number | TruncateConfigObj;
+export interface TruncateConfigObj {
 	length?: number;
 	location?: "end" | "middle" | "smart";
 }
 
+export type HashtagConfig = false | HashtagServices;
 export type HashtagServices = 'twitter' | 'facebook' | 'instagram';
+
+export type MentionConfig = false | MentionServices;
 export type MentionServices = 'twitter' | 'instagram' | 'soundcloud';
 
+export type ReplaceFn = ( match: Match ) => ReplaceFnReturn;
 export type ReplaceFnReturn = boolean | string | HtmlTag | null | undefined | void;

src/index.ts

@@ -6,6 +6,7 @@
 export { default } from './autolinker';
 export { default as Autolinker } from './autolinker';
 
+export * from './autolinker';
 export * from './anchor-tag-builder';
 export * from './html-tag';
 export * from './match/index';

src/match/url-match.ts

@@ -1,5 +1,5 @@
 import { Match, MatchConfig } from "./match";
-import { StripPrefixConfig, UrlMatchTypeOptions } from "../autolinker";
+import { StripPrefixConfigObj, UrlMatchTypeOptions } from "../autolinker";
 
 /**
  * @class Autolinker.match.Url
@@ -50,7 +50,7 @@ export class UrlMatch extends Match {
 	 *
 	 * The Object form of {@link Autolinker#cfg-stripPrefix}.
 	 */
-	private readonly stripPrefix: StripPrefixConfig = { scheme: true, www: true };  // default value just to get the above doc comment in the ES5 output and documentation generator
+	private readonly stripPrefix: Required<StripPrefixConfigObj> = { scheme: true, www: true };  // default value just to get the above doc comment in the ES5 output and documentation generator
 
 	/**
 	 * @cfg {Boolean} stripTrailingSlash (required)
@@ -302,7 +302,7 @@ export interface UrlMatchConfig extends MatchConfig {
 	urlMatchType: UrlMatchTypeOptions;
 	protocolUrlMatch: boolean;
 	protocolRelativeMatch: boolean;
-	stripPrefix: StripPrefixConfig;
+	stripPrefix: Required<StripPrefixConfigObj>;
 	stripTrailingSlash: boolean;
 	decodePercentEncoding: boolean;
 }

src/matcher/url-matcher.ts

@@ -1,6 +1,6 @@
 import { Matcher, MatcherConfig } from "./matcher";
 import { alphaNumericCharsStr, alphaNumericAndMarksCharsStr, getDomainNameStr } from "../regex-lib";
-import { StripPrefixConfig, UrlMatchTypeOptions } from "../autolinker";
+import { StripPrefixConfigObj, UrlMatchTypeOptions } from "../autolinker";
 import { tldRegex } from "./tld-regex";
 import { UrlMatch } from "../match/url-match";
 import { UrlMatchValidator } from "./url-match-validator";
@@ -21,7 +21,7 @@ export class UrlMatcher extends Matcher {
 	 *
 	 * The Object form of {@link Autolinker#cfg-stripPrefix}.
 	 */
-	protected stripPrefix: StripPrefixConfig = { scheme: true, www: true };  // default value just to get the above doc comment in the ES5 output and documentation generator
+	protected stripPrefix: Required<StripPrefixConfigObj> = { scheme: true, www: true };  // default value just to get the above doc comment in the ES5 output and documentation generator
 
 	/**
 	 * @cfg {Boolean} stripTrailingSlash (required)
@@ -331,7 +331,7 @@ export class UrlMatcher extends Matcher {
 }
 
 export interface UrlMatcherConfig extends MatcherConfig {
-	stripPrefix: StripPrefixConfig;
+	stripPrefix: Required<StripPrefixConfigObj>;
 	stripTrailingSlash: boolean;
 	decodePercentEncoding: boolean;
 }

tests-integration/test-node-typescript/test-node-typescript.spec.ts

@@ -0,0 +1,12 @@
+import Autolinker, { AutolinkerConfig } from 'autolinker';
+
+describe( 'test Autolinker with TypeScript in Node', () => {
+
+	it( 'should run using the AutolinkerConfig interface import', () => {
+		var options: AutolinkerConfig = { newWindow: false };  // Note: Testing that the AutolinkerConfig interface can be imported
+		var linkedStr = Autolinker.link( 'Go to google.com', options );
+
+		expect( linkedStr ).toBe( `Go to <a href="http://google.com">google.com</a>` );
+	} );
+
+} );

tests-integration/test-webpack-typescript/page.ts

@@ -1,8 +1,9 @@
-import Autolinker from 'autolinker';
+import Autolinker, { AutolinkerConfig } from 'autolinker';
 
 document.addEventListener( 'DOMContentLoaded', () => {
 	var resultEl = document.getElementById( 'result' )!;
 
-	var linkedStr = Autolinker.link( 'Go to google.com', { newWindow: false } );
+	var options: AutolinkerConfig = { newWindow: false };  // Note: Testing that the AutolinkerConfig interface can be imported
+	var linkedStr = Autolinker.link( 'Go to google.com', options );
 	resultEl.innerHTML = linkedStr;
 } );