noImplicitAny

src/main/resources/admin/widgets/seo/seo.ts

@@ -1,3 +1,6 @@
+import type {Request} from '/lib/types';
+
+
 import {
 	get as getContentByKey,
 } from '/lib/xp/content';
@@ -28,7 +31,7 @@ TODO: Perhaps add (?) icons with info for each data.
 TODO: Possibility to click title, desc, image and see the water fall logic and where data is found?
 TODO: Grade each data based on amount of text etc. Red, yellow, green. And info about it (best-practise).
 */
-export const get = (req) => {
+export const get = (req: Request) => {
 /*
 	TODO: Display content settings? If any, then fallbacks.
 	x": {

src/main/resources/lib/common/commaStringToArray.ts

@@ -5,10 +5,10 @@ import {forceArray} from '@enonic/js-utils/array/forceArray';
 
 
 export function commaStringToArray(str: CommaSeparatedString): string[] {
-	const commas = str || '';
+	const commas: string = str || '';
 	let arr = commas.split(',');
 	if (arr) {
-		arr = arr.map(function (s) { return s.trim() });
+		arr = arr.map((s) => { return s.trim() });
 	} else {
 		arr = forceArray(str); // Make sure we always work with an array
 	}

src/main/resources/lib/common/getBlockRobots.ts

@@ -1,8 +1,6 @@
-// import type {Content} from '@enonic-types/lib-content';
+import type {Content} from '@enonic-types/lib-content';
 
 import {APP_NAME_PATH, MIXIN_PATH} from '/lib/common/constants';
 
 
-export const getBlockRobots = (content): boolean => content.x[APP_NAME_PATH]
-	&& content.x[APP_NAME_PATH][MIXIN_PATH]
-	&& content.x[APP_NAME_PATH][MIXIN_PATH].blockRobots;
+export const getBlockRobots = (content: Content): boolean => !!content.x?.[APP_NAME_PATH]?.[MIXIN_PATH]?.blockRobots;

src/main/resources/lib/common/getContentForCanonicalUrl.ts

@@ -1,10 +1,12 @@
+import type {Content} from '@enonic-types/lib-content';
+
+
 import {get as getContentByKey} from '/lib/xp/content';
 import {APP_NAME_PATH, MIXIN_PATH} from '/lib/common/constants';
 
 
-export const getContentForCanonicalUrl = (content) => content.x[APP_NAME_PATH]
-	&& content.x[APP_NAME_PATH][MIXIN_PATH]
-	&& content.x[APP_NAME_PATH][MIXIN_PATH].seoContentForCanonicalUrl
+export const getContentForCanonicalUrl = (content: Content): Content =>
+	content.x?.[APP_NAME_PATH]?.[MIXIN_PATH]?.seoContentForCanonicalUrl
 	&& getContentByKey({
-		key: content.x[APP_NAME_PATH][MIXIN_PATH].seoContentForCanonicalUrl
+		key: content.x[APP_NAME_PATH][MIXIN_PATH].seoContentForCanonicalUrl as string
 	});

src/main/resources/lib/common/getLang.ts

@@ -1,4 +1,8 @@
-export const getLang = (content, site) => {
+import type {Content, Site} from '@enonic-types/lib-content';
+import type {MetafieldsSiteConfig} from '/lib/types';
+
+
+export const getLang = (content: Content, site: Site<MetafieldsSiteConfig>) => {
 	// Format locale into the ISO format that Open Graph wants.
 	let locale = 'en_US';
 	if (content.language || site.language) {

src/main/resources/lib/common/getTheConfig.ts

@@ -1,5 +1,5 @@
 import type {Site} from '/lib/xp/portal';
-import type { MetafieldsSiteConfig } from '../types/MetafieldsSiteConfig';
+import type {MetafieldsSiteConfig} from '../types/MetafieldsSiteConfig';
 
 
 import {getSiteConfig as libPortalGetSiteConfig} from '/lib/xp/portal';
@@ -30,7 +30,7 @@ export const getTheConfig = ({
 				if (value === 'true' || value === 'false') {
 					value = value === 'true';
 				}
-				config[prop] = value;
+				(config as Record<typeof prop, typeof value>)[prop] = value;
 			}
 		}
 	}

src/main/resources/lib/common/stringOrNull.ts

@@ -6,6 +6,6 @@ import { isString } from '/lib/common/isString';
  * @param o - the value to check
  * @returns the string value or null
  */
-export function stringOrNull(o) {
+export function stringOrNull(o: unknown): string|null {
 	return isString(o) ? o : null;
 }

src/main/resources/lib/metadata/getMetaData.ts

@@ -15,7 +15,7 @@ import {getPageTitle} from '/lib/common/getPageTitle';
 import {getTheConfig} from '/lib/common/getTheConfig';
 
 
-function _resolveMetadata(params, selfClosingTags=false) {
+function _resolveMetadata(params: MetaDataModel, selfClosingTags=false) {
 	return render(resolve(`metadata${
 		selfClosingTags ? '-self-closing' : ''
 	}.html`), params)

src/main/resources/lib/types/MetafieldsSiteConfig.d.ts

@@ -6,7 +6,7 @@ export type {
 } from '/lib/types/Content';
 
 
-export interface MetafieldsSiteConfig {
+export declare interface MetafieldsSiteConfig {
 	blockRobots?: boolean
 	canonical?: boolean
 	disableAppConfig?: boolean

src/main/resources/lib/types/Request.d.ts

@@ -0,0 +1,22 @@
+export declare type Request<
+	T extends Record<string, string> = {
+		body?: string
+		contextPath?: string
+		cookies?: Record<string, string>
+		headers?: Record<string, string>
+		params?: Record<string, string>
+		pathParams?: Record<string, string>
+		rawPath?: string
+		remoteAddress?: string
+		// webSocket?: unknown
+	}
+> = {
+	branch: 'draft'|'master'
+	host: string
+	method: 'GET'|'POST'|'HEAD'|'PUT'|'DELETE'|'PATCH'
+	mode: 'edit'|'inline'|'live'|'preview'
+	path: string
+	port: string|number
+	scheme: string
+	url: string
+} & T;

src/main/resources/lib/types/Response.ts

@@ -0,0 +1,36 @@
+// https://developer.enonic.com/docs/xp/stable/framework/http#http-response
+export declare interface ComplexCookie {
+	value: string // Value (required) The value to store in the cookie. This example will create a cookie looking like this complex: value.
+	path?: string // The paths on the site where this cookie should be available from (and all containing paths). Defaults to empty
+	domain?: string // Add additional sites that should be able to read the cookie. Defaults to empty (Only the server that creates the cookie can read it.)
+	comment?: string // A comment describing the cookie. Default to `null. Deprecated and will be removed in future versions of XP.
+	maxAge?: number // Number of seconds before the browser is allowed to delete the cookie. Defaults to -1 (The cookie will live until the browser is shut down.)
+	secure?: boolean // Control if the cookie should only be accepted to be created and read over https and similar secure protocols. Defaults to false
+	httpOnly?: boolean // Control if the cookie is available for scripts or not. If true, only the serverside code can read the cookie. Defaults to false (Also client-side scripts can read the cookie.)
+	sameSite?: string // XP 7.3.0 SameSite flag for the cookie. Can be lax, strict, none or   for "not set". Default is "not set", meaning "browser’s default".
+}
+
+export declare interface PageContributions {
+	headBegin?: string[]
+	headEnd?: string[]
+	bodyBegin?: string[]
+	bodyEnd?: string[]
+}
+
+export declare interface Response {
+	applyFilters?: boolean
+	body: string|null // Body of the response as string. Null if the response content-type is not of type text.
+	bodyStream?: unknown
+	contentType?: string
+	cookies?: Record<string,string|ComplexCookie>
+	headers?: Record<string,string>
+	message?: string
+	pageContributions?: PageContributions
+	postProcess?: boolean
+	redirect?: string
+	status?: number
+	webSocket?: {
+        data: Record<string, unknown>
+        subProtocols?: string[]
+    }
+}

src/main/resources/lib/types/index.ts

@@ -40,6 +40,8 @@ export type {
 	MediaImage,
 } from '/lib/types/Content';
 export type {MetafieldsSiteConfig} from '/lib/types/MetafieldsSiteConfig';
+export type {Request} from '/lib/types/Request';
+export type {Response} from '/lib/types/Response';
 
 
 //──────────────────────────────────────────────────────────────────────────────
@@ -133,7 +135,7 @@ const contentValidator = (value: unknown): value is Content => isObject(value)
 	// && value.hasOwnProperty('data')
 	// && value.hasOwnProperty('displayName')
 	// && value.hasOwnProperty('owner')
-	&& value.hasOwnProperty('type') && isString(value['type'])
+	&& value.hasOwnProperty('type') && isString((value as Content).type)
 	// && value.hasOwnProperty('hasChildren') && isBoolean(value['hasChildren'])
 	// && value.hasOwnProperty('valid') && isBoolean(value['valid'])
 	// && value.hasOwnProperty('x')
@@ -156,12 +158,12 @@ export const GraphQLMediaImageBuilder = brand<GraphQLMediaImage>({
 const metaFieldsValidator = (value: unknown)/*: value is GraphQLMetaFields*/ => isObject(value)
 	&& !value.hasOwnProperty('siteName')
 		? `expected object to have property 'siteName' object:${JSON.stringify(value, null, 4)}`
-		: !isString(value['siteName'])
-			? `expected object.siteName to be a string got ${value['siteName']} object:${JSON.stringify(value, null, 4)}`
+		: !isString((value as GraphQLMetaFields)['siteName'])
+			? `expected object.siteName to be a string got ${(value as GraphQLMetaFields)['siteName']} object:${JSON.stringify(value, null, 4)}`
 			: !value.hasOwnProperty('title')
 				? `expected object to have property 'title' object:${JSON.stringify(value, null, 4)}`
-				: !isString(value['siteName'])
-					? `expected object.siteName to be a string got ${value['siteName']} object:${JSON.stringify(value, null, 4)}`
+				: !isString((value as GraphQLMetaFields)['siteName'])
+					? `expected object.siteName to be a string got ${(value as GraphQLMetaFields)['siteName']} object:${JSON.stringify(value, null, 4)}`
 					: true
 
 

src/main/resources/site/processors/add-metadata.ts

@@ -1,3 +1,6 @@
+import type {Request, Response} from '/lib/types';
+
+
 import {forceArray} from '@enonic/js-utils/array/forceArray';
 import {getFixedHtmlAttrsAsString} from '/lib/metadata/getFixedHtmlAttrsAsString';
 import {getMetaData} from '/lib/metadata/getMetaData'
@@ -9,7 +12,7 @@ const HTML_MEDIA_TYPE = 'text/html';
 const XML_MEDIA_TYPES = ['application/xhtml+xml', 'application/xml', 'text/xml'];
 
 
-export const responseProcessor = (req, res) => {
+export const responseProcessor = (req: Request, res: Response) => {
 	const reusableData = getReusableData({
 		applicationKey: app.name, // NOTE: Using app.name is fine, since it's outside Guillotine Execution Context
 	});
@@ -62,15 +65,15 @@ export const responseProcessor = (req, res) => {
 	// Push metadata if response content type is html or xml
 	if ( isResponseContentTypeHtml || isResponseContentTypeXml ) {
 		const selfClosingTags = isResponseContentTypeXml;
-		const metadata = getMetaData({
+		const metadata: string = getMetaData({
 			applicationConfig: app.config, // NOTE: Using app.config is fine, since it's outside Guillotine Execution Context
 			applicationKey: app.name, // NOTE: Using app.name is fine, since it's outside Guillotine Execution Context
 			site,
 			siteConfig,
 			content,
 			returnType: 'html',
 			selfClosingTags
-		}) || "";
+		}) as string || "";
 		res.pageContributions.headEnd.push(metadata);
 	}
 

test/lib/metadata/getMetaData.test.ts

@@ -107,7 +107,7 @@ describe('getMetaData', () => {
 				}),
 				siteConfig: metaFieldsSiteConfig,
 			})).toEqual({
-				blockRobots: undefined,
+				blockRobots: false,
 				canonical: undefined,
 				canonicalUrl: 'oneContentPathabsolutePageUrl',
 				description: 'Site description',
@@ -150,7 +150,7 @@ describe('getMetaData', () => {
 				site,
 				siteConfig: metaFieldsSiteConfig,
 			})).toEqual({
-				blockRobots: undefined,
+				blockRobots: false,
 				canonical: undefined,
 				canonicalUrl: 'siteContentPathabsolutePageUrl',
 				description: 'Site description',
@@ -197,7 +197,7 @@ describe('getMetaData', () => {
 				site,
 				siteConfig,
 			})).toEqual({
-				blockRobots: undefined,
+				blockRobots: false,
 				canonical: undefined,
 				canonicalUrl: 'oneContentPathabsolutePageUrl',
 				description: 'Site description',
@@ -251,7 +251,7 @@ describe('getMetaData', () => {
 				site,
 				siteConfig,
 			})).toEqual({
-				blockRobots: undefined,
+				blockRobots: false,
 				canonical: undefined,
 				canonicalUrl: 'oneContentPathabsolutePageUrl',
 				description: 'Site description',
@@ -305,7 +305,7 @@ describe('getMetaData', () => {
 				site,
 				siteConfig,
 			})).toEqual({
-				blockRobots: undefined,
+				blockRobots: false,
 				canonical: undefined,
 				canonicalUrl: 'oneContentPathabsolutePageUrl',
 				description: 'Site description',

tsconfig.json

@@ -3,11 +3,13 @@
 		"allowSyntheticDefaultImports": true,
 		"baseUrl": ".",
 		"esModuleInterop": true,
+		"noImplicitAny": true,
 		"paths": {
 			"/lib/xp/*": ["./node_modules/@enonic-types/lib-*"],
 			"/*": ["./src/main/resources/*"],
 		},
 		"skipLibCheck": true,
+		// "strict": true,
 		"types": [
 			"@enonic-types/global"
 		]