Use automatically generated types

Fixes #1767
handlebars-lang · Jan 4, 2022 · 1804b8d · 1804b8d
1 parent 30bd78d
commit 1804b8d
Show file tree

Hide file tree

Showing 5 changed files with 208 additions and 272 deletions.
diff --git a/lib/handlebars.runtime.js b/lib/handlebars.runtime.js
@@ -2,7 +2,7 @@ import { Exception } from '@handlebars/parser';
 import * as base from './handlebars/base';
 
 // Each of these augment the Handlebars object. No need to setup here.
-// (This is done to easily share code between commonjs and browse envs)
+// (This is done to easily share code between commonjs and browser envs)
 import SafeString from './handlebars/safe-string';
 import * as Utils from './handlebars/utils';
 import * as runtime from './handlebars/runtime';

diff --git a/package.json b/package.json
@@ -66,7 +66,7 @@
     "prettier": "^1.19.1",
     "semver": "^5.0.1",
     "sinon": "^7.5.0",
-    "typescript": "^3.4.3",
+    "typescript": "^3.9.10",
     "uglify-js": "^3.1.4",
     "underscore": "^1.5.1",
     "webpack": "^1.12.6",
@@ -83,6 +83,7 @@
   },
   "scripts": {
     "build": "grunt build",
+    "build:types": "tsc types/index.ts --declaration --emitDeclarationOnly --outDir types",
     "format": "prettier --write '**/*.js' && eslint --fix .",
     "lint": "npm run lint:eslint && npm run lint:prettier && npm run lint:types",
     "lint:eslint": "eslint --max-warnings 0 .",

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -1,275 +1,86 @@
-/* These definitions were imported from https://github.com/DefinitelyTyped/DefinitelyTyped
- * and includes previous contributions from the DefinitelyTyped community by:
- *   - Albert Willemsen <https://github.com/AlbertWillemsen-Centric>
- *   - Boris Yankov <https://github.com/borisyankov>
- *   - Jessica Franco <https://github.com/Kovensky>
- *   - Masahiro Wakame <https://github.com/vvakame>
- *   - Raanan Weber <https://github.com/RaananW>
- *   - Sergei Dorogin <https://github.com/evil-shrike>
- *   - webbiesdk <https://github.com/webbiesdk>
- *   - Andrew Leedham <https://github.com/AndrewLeedham>
- *   - Nils Knappmeier <https://github.com/nknapp>
- * For full history prior to their migration to handlebars.js, please see:
- * https://github.com/DefinitelyTyped/DefinitelyTyped/commits/1ce60bdc07f10e0b076778c6c953271c072bc894/types/handlebars/index.d.ts
- */
-// TypeScript Version: 2.3
-import {
-    parse,
-    parseWithoutProcessing,
-    ParseOptions,
-    AST
-} from '@handlebars/parser';
-
-declare namespace Handlebars {
-  export interface TemplateDelegate<T = any> {
-      (context: T, options?: RuntimeOptions): string;
-  }
-
-  export type Template<T = any> = TemplateDelegate<T>|string;
-
-  export interface RuntimeOptions {
-      partial?: boolean;
-      depths?: any[];
-      helpers?: { [name: string]: Function };
-      partials?: { [name: string]: HandlebarsTemplateDelegate };
-      decorators?: { [name: string]: Function };
-      data?: any;
-      blockParams?: any[];
-      allowCallsToHelperMissing?: boolean;
-      allowedProtoProperties?: { [name: string]: boolean };
-      allowedProtoMethods?: { [name: string]: boolean };
-      allowProtoPropertiesByDefault?: boolean;
-      allowProtoMethodsByDefault?: boolean;
-  }
-
-  export interface HelperOptions {
-      fn: TemplateDelegate;
-      inverse: TemplateDelegate;
-      hash: any;
-      data?: any;
-  }
-
-  export interface HelperDelegate {
-      (context?: any, arg1?: any, arg2?: any, arg3?: any, arg4?: any, arg5?: any, options?: HelperOptions): any;
-  }
-  export interface HelperDeclareSpec {
-      [key: string]: HelperDelegate;
-  }
-
-  export { parse, parseWithoutProcessing, ParseOptions };
-
-  export function registerHelper(name: string, fn: HelperDelegate): void;
-  export function registerHelper(name: HelperDeclareSpec): void;
-  export function unregisterHelper(name: string): void;
-
-  export function registerPartial(name: string, fn: Template): void;
-  export function registerPartial(spec: { [name: string]: HandlebarsTemplateDelegate }): void;
-  export function unregisterPartial(name: string): void;
-
-  // TODO: replace Function with actual signature
-  export function registerDecorator(name: string, fn: Function): void;
-  export function unregisterDecorator(name: string): void;
-
-  export function K(): void;
-  export function createFrame(object: any): any;
-  export function blockParams(obj: any[], ids: any[]): any[];
-  export function log(level: number, obj: any): void;
-
-  export function compile<T = any>(input: any, options?: CompileOptions): HandlebarsTemplateDelegate<T>;
-  export function precompile(input: any, options?: PrecompileOptions): TemplateSpecification;
-  export function template<T = any>(precompilation: TemplateSpecification): HandlebarsTemplateDelegate<T>;
-
-  export function create(): typeof Handlebars;
-
-  export const escapeExpression: typeof Utils.escapeExpression;
-  //export const Utils: typeof hbs.Utils;
-  export const logger: Logger;
-  export const templates: HandlebarsTemplates;
-  export const helpers: { [name: string]: HelperDelegate };
-  export const partials: { [name: string]: any };
-  // TODO: replace Function with actual signature
-  export const decorators: { [name: string]: Function };
-
-  export const VERSION: string;
-
-  export function noConflict(): typeof Handlebars;
-
-  export class Exception {
-      constructor(message: string, node?: hbs.AST.Node);
-      description: string;
-      fileName: string;
-      lineNumber?: any;
-      endLineNumber?: any;
-      message: string;
-      name: string;
-      number: number;
-      stack?: string;
-      column?: any;
-      endColumn?: any;
-  }
-
-  export class SafeString {
-      constructor(str: string);
-      toString(): string;
-      toHTML(): string;
-  }
-
-  export namespace Utils {
-      export function escapeExpression(str: string): string;
-      export function createFrame(object: any): any;
-      export function blockParams(obj: any[], ids: any[]): any[];
-      export function isEmpty(obj: any) : boolean;
-      export function extend(obj: any, ...source: any[]): any;
-      export function toString(obj: any): string;
-      export function isArray(obj: any): boolean;
-      export function isFunction(obj: any): boolean;
-  }
-
-  export namespace AST {
-      export const helpers: hbs.AST.helpers;
-  }
-
-  export interface ICompiler {
-      accept(node: hbs.AST.Node): void;
-      Program(program: hbs.AST.Program): void;
-      BlockStatement(block: hbs.AST.BlockStatement): void;
-      PartialStatement(partial: hbs.AST.PartialStatement): void;
-      PartialBlockStatement(partial: hbs.AST.PartialBlockStatement): void;
-      DecoratorBlock(decorator: hbs.AST.DecoratorBlock): void;
-      Decorator(decorator: hbs.AST.Decorator): void;
-      MustacheStatement(mustache: hbs.AST.MustacheStatement): void;
-      ContentStatement(content: hbs.AST.ContentStatement): void;
-      CommentStatement(comment?: hbs.AST.CommentStatement): void;
-      SubExpression(sexpr: hbs.AST.SubExpression): void;
-      PathExpression(path: hbs.AST.PathExpression): void;
-      StringLiteral(str: hbs.AST.StringLiteral): void;
-      NumberLiteral(num: hbs.AST.NumberLiteral): void;
-      BooleanLiteral(bool: hbs.AST.BooleanLiteral): void;
-      UndefinedLiteral(): void;
-      NullLiteral(): void;
-      Hash(hash: hbs.AST.Hash): void;
-  }
-
-  export class Visitor implements ICompiler {
-      accept(node: hbs.AST.Node): void;
-      acceptKey(node: hbs.AST.Node, name: string): void;
-      acceptArray(arr: hbs.AST.Expression[]): void;
-      Program(program: hbs.AST.Program): void;
-      BlockStatement(block: hbs.AST.BlockStatement): void;
-      PartialStatement(partial: hbs.AST.PartialStatement): void;
-      PartialBlockStatement(partial: hbs.AST.PartialBlockStatement): void;
-      DecoratorBlock(decorator: hbs.AST.DecoratorBlock): void;
-      Decorator(decorator: hbs.AST.Decorator): void;
-      MustacheStatement(mustache: hbs.AST.MustacheStatement): void;
-      ContentStatement(content: hbs.AST.ContentStatement): void;
-      CommentStatement(comment?: hbs.AST.CommentStatement): void;
-      SubExpression(sexpr: hbs.AST.SubExpression): void;
-      PathExpression(path: hbs.AST.PathExpression): void;
-      StringLiteral(str: hbs.AST.StringLiteral): void;
-      NumberLiteral(num: hbs.AST.NumberLiteral): void;
-      BooleanLiteral(bool: hbs.AST.BooleanLiteral): void;
-      UndefinedLiteral(): void;
-      NullLiteral(): void;
-      Hash(hash: hbs.AST.Hash): void;
-  }
-
-
-  export interface ResolvePartialOptions {
-    name: string;
-    helpers?: { [name: string]: Function };
-    partials?: { [name: string]: HandlebarsTemplateDelegate };
-    decorators?: { [name: string]: Function };
-    data?: any;
-  }
-
-  export namespace VM {
-    /**
-     * @deprecated
-     */
-    export function resolvePartial<T = any>(partial: HandlebarsTemplateDelegate<T> | undefined, context: any, options: ResolvePartialOptions): HandlebarsTemplateDelegate<T>;
-  }
+import { ParseOptions, AST } from '@handlebars/parser';
+declare type BuiltinHelperName = "helperMissing" | "blockHelperMissing" | "each" | "if" | "unless" | "with" | "log" | "lookup";
+declare type KnownHelpers = {
+    [name in BuiltinHelperName | string]: boolean;
+};
+declare type Template<T = any> = TemplateDelegate<T> | string;
+interface CompileOptions {
+    data?: boolean;
+    compat?: boolean;
+    knownHelpers?: KnownHelpers;
+    knownHelpersOnly?: boolean;
+    noEscape?: boolean;
+    strict?: boolean;
+    assumeObjects?: boolean;
+    preventIndent?: boolean;
+    ignoreStandalone?: boolean;
+    explicitPartialContext?: boolean;
+}
+interface PrecompileOptions extends CompileOptions {
+    srcName?: string;
+    destName?: string;
 }
-
-/**
-* Implement this interface on your MVW/MVVM/MVC views such as Backbone.View
-**/
-export interface HandlebarsTemplatable {
-  template: HandlebarsTemplateDelegate;
+interface RuntimeOptions {
+    partial?: boolean;
+    depths?: any[];
+    helpers?: {
+        [name: string]: Function;
+    };
+    partials?: {
+        [name: string]: TemplateDelegate;
+    };
+    decorators?: {
+        [name: string]: Function;
+    };
+    data?: any;
+    blockParams?: any[];
+    allowCallsToHelperMissing?: boolean;
+    allowedProtoProperties?: {
+        [name: string]: boolean;
+    };
+    allowedProtoMethods?: {
+        [name: string]: boolean;
+    };
+    allowProtoPropertiesByDefault?: boolean;
+    allowProtoMethodsByDefault?: boolean;
 }
-
-// NOTE: for backward compatibility of this typing
-export type HandlebarsTemplateDelegate<T = any> = Handlebars.TemplateDelegate<T>;
-
-export interface HandlebarsTemplates {
-  [index: string]: HandlebarsTemplateDelegate;
+interface TemplateSpecification {
 }
-
-export interface TemplateSpecification {
-
+export interface TemplateDelegate<T = any> {
+    (context: T, options?: RuntimeOptions): string;
 }
-
-// for backward compatibility of this typing
-export type RuntimeOptions = Handlebars.RuntimeOptions;
-
-export interface CompileOptions {
-  data?: boolean;
-  compat?: boolean;
-  knownHelpers?: KnownHelpers;
-  knownHelpersOnly?: boolean;
-  noEscape?: boolean;
-  strict?: boolean;
-  assumeObjects?: boolean;
-  preventIndent?: boolean;
-  ignoreStandalone?: boolean;
-  explicitPartialContext?: boolean;
+interface HelperOptions {
+    fn: TemplateDelegate;
+    inverse: TemplateDelegate;
+    hash: any;
+    data?: any;
 }
-
-export type KnownHelpers = {
-  [name in BuiltinHelperName | CustomHelperName]: boolean;
-};
-
-export type BuiltinHelperName =
-  "helperMissing"|
-  "blockHelperMissing"|
-  "each"|
-  "if"|
-  "unless"|
-  "with"|
-  "log"|
-  "lookup";
-
-export type CustomHelperName = string;
-
-export interface PrecompileOptions extends CompileOptions {
-  srcName?: string;
-  destName?: string;
+interface HelperDelegate {
+    (context?: any, arg1?: any, arg2?: any, arg3?: any, arg4?: any, arg5?: any, options?: HelperOptions): any;
 }
-
-export namespace hbs {
-  // for backward compatibility of this typing
-  export type SafeString = Handlebars.SafeString;
-
-  export type Utils = typeof Handlebars.Utils;
-
-  export { AST }
+interface HelperDeclareSpec {
+    [key: string]: HelperDelegate;
 }
-
-export interface Logger {
-  DEBUG: number;
-  INFO: number;
-  WARN: number;
-  ERROR: number;
-  level: number;
-
-  methodMap: { [level: number]: string };
-
-  log(level: number, obj: string): void;
+interface SafeString {
+    new (str: string): void;
+    toString(): string;
+    toHTML(): string;
 }
-
-export type CompilerInfo = [number/* revision */, string /* versions */];
-
-declare module "handlebars/runtime" {
-  export = Handlebars;
+declare class Handlebars {
+    readonly VERSION: string;
+    SafeString: SafeString;
+    constructor();
+    compile<T = any>(input: any, options?: CompileOptions): TemplateDelegate;
+    precompile(input: any, options?: PrecompileOptions): TemplateSpecification;
+    parse(input: string, options?: ParseOptions): AST.Program;
+    parseWithoutProcessing(input: string, options?: ParseOptions): AST.Program;
+    registerHelper(name: HelperDeclareSpec | string, fn?: HelperDelegate): void;
+    unregisterHelper(name: string): void;
+    registerPartial(name: string, fn: Template): void;
+    registerPartial(spec: {
+        [name: string]: TemplateDelegate;
+    }): void;
+    unregisterPartial(name: string): void;
 }
-
-export default Handlebars;
+declare const _default: Handlebars;
+export default _default;