From 393813902921572fbb99fd1a3f628a64edaf716b Mon Sep 17 00:00:00 2001 From: Nick Whyte Date: Fri, 9 Mar 2018 12:26:09 +1100 Subject: [PATCH 1/5] prismic-dom: Add initial typings --- types/prismic-dom/index.d.ts | 8 ++++++++ types/prismic-dom/prismic-dom-tests.ts | 3 +++ types/prismic-dom/tsconfig.json | 22 ++++++++++++++++++++++ types/prismic-dom/tslint.json | 1 + 4 files changed, 34 insertions(+) create mode 100644 types/prismic-dom/index.d.ts create mode 100644 types/prismic-dom/prismic-dom-tests.ts create mode 100644 types/prismic-dom/tsconfig.json create mode 100644 types/prismic-dom/tslint.json diff --git a/types/prismic-dom/index.d.ts b/types/prismic-dom/index.d.ts new file mode 100644 index 0000000000..9588f1e25c --- /dev/null +++ b/types/prismic-dom/index.d.ts @@ -0,0 +1,8 @@ +// Type definitions for prismic-dom 2.0 +// Project: https://github.com/prismicio/prismic-dom#readme +// Definitions by: Nick Whyte +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export class RichText { + static asHtml(richText: any, linkResolver?: (doc: any) => string): string; +} diff --git a/types/prismic-dom/prismic-dom-tests.ts b/types/prismic-dom/prismic-dom-tests.ts new file mode 100644 index 0000000000..9e123002f1 --- /dev/null +++ b/types/prismic-dom/prismic-dom-tests.ts @@ -0,0 +1,3 @@ +import prismicDom = require("prismic-dom"); + +let rendered: string = prismicDom.RichText.asHtml({}); diff --git a/types/prismic-dom/tsconfig.json b/types/prismic-dom/tsconfig.json new file mode 100644 index 0000000000..ef0b24f3a7 --- /dev/null +++ b/types/prismic-dom/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "prismic-dom-tests.ts" + ] +} diff --git a/types/prismic-dom/tslint.json b/types/prismic-dom/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/prismic-dom/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } From 4377692a9b1e3dd06c9e7a9c1ce4d5e7a237d02c Mon Sep 17 00:00:00 2001 From: Nick Whyte Date: Fri, 9 Mar 2018 12:28:40 +1100 Subject: [PATCH 2/5] . --- types/prismic-dom/tsconfig.json | 1 + 1 file changed, 1 insertion(+) diff --git a/types/prismic-dom/tsconfig.json b/types/prismic-dom/tsconfig.json index ef0b24f3a7..0687e7ae0e 100644 --- a/types/prismic-dom/tsconfig.json +++ b/types/prismic-dom/tsconfig.json @@ -7,6 +7,7 @@ "noImplicitAny": true, "noImplicitThis": true, "strictNullChecks": true, + "strictFunctionTypes": true, "baseUrl": "../", "typeRoots": [ "../" From 2f3607131c9716b01fcd7e7f76cb82764fb9b4ac Mon Sep 17 00:00:00 2001 From: Nick Whyte Date: Fri, 9 Mar 2018 12:32:31 +1100 Subject: [PATCH 3/5] . --- types/prismic-dom/index.d.ts | 6 +++--- types/prismic-dom/prismic-dom-tests.ts | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/types/prismic-dom/index.d.ts b/types/prismic-dom/index.d.ts index 9588f1e25c..82c766fda6 100644 --- a/types/prismic-dom/index.d.ts +++ b/types/prismic-dom/index.d.ts @@ -1,8 +1,8 @@ // Type definitions for prismic-dom 2.0 // Project: https://github.com/prismicio/prismic-dom#readme -// Definitions by: Nick Whyte +// Definitions by: Nick Whyte // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -export class RichText { - static asHtml(richText: any, linkResolver?: (doc: any) => string): string; +export namespace RichText { + function asHtml(richText: any, linkResolver?: (doc: any) => string): string; } diff --git a/types/prismic-dom/prismic-dom-tests.ts b/types/prismic-dom/prismic-dom-tests.ts index 9e123002f1..598573cced 100644 --- a/types/prismic-dom/prismic-dom-tests.ts +++ b/types/prismic-dom/prismic-dom-tests.ts @@ -1,3 +1,3 @@ import prismicDom = require("prismic-dom"); -let rendered: string = prismicDom.RichText.asHtml({}); +const rendered: string = prismicDom.RichText.asHtml({}); From 75178d3bdf290a817e997194aff407546a9901a3 Mon Sep 17 00:00:00 2001 From: Nick Whyte Date: Mon, 12 Mar 2018 11:07:34 +1100 Subject: [PATCH 4/5] PR Changes --- types/prismic-dom/index.d.ts | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/types/prismic-dom/index.d.ts b/types/prismic-dom/index.d.ts index 82c766fda6..db3b85d4b8 100644 --- a/types/prismic-dom/index.d.ts +++ b/types/prismic-dom/index.d.ts @@ -3,6 +3,13 @@ // Definitions by: Nick Whyte // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -export namespace RichText { - function asHtml(richText: any, linkResolver?: (doc: any) => string): string; +interface RichText { + asHtml(richText: any, linkResolver?: (doc: any) => string): string; } + +export const RichText: RichText; + +declare const PrismicDOM: { + RichText: RichText; +}; +export default PrismicDOM; From 6f0b81e2c509805d1a1348b7513340d1929200b9 Mon Sep 17 00:00:00 2001 From: Nick Whyte Date: Mon, 12 Mar 2018 11:25:31 +1100 Subject: [PATCH 5/5] PR Changes --- types/prismic-dom/index.d.ts | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/types/prismic-dom/index.d.ts b/types/prismic-dom/index.d.ts index db3b85d4b8..2849cc7791 100644 --- a/types/prismic-dom/index.d.ts +++ b/types/prismic-dom/index.d.ts @@ -9,7 +9,5 @@ interface RichText { export const RichText: RichText; -declare const PrismicDOM: { - RichText: RichText; -}; -export default PrismicDOM; +declare const _default: { RichText: RichText }; +export default _default;