Skip to content

[WIP] TS Decalrations #612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,13 @@
],
"type": "module",
"exports": {
".": "./lib/server.js",
".": {
"default": "./lib/server.js",
"types": "./types/ui5_serve.d.ts"
},
"./middleware/*": {
"types": "./types/index.d.ts"
},
"./internal/sslUtil": "./lib/sslUtil.js",
"./internal/middlewareRepository": "./lib/middleware/middlewareRepository.js",
"./internal/MiddlewareManager": "./lib/middleware/MiddlewareManager.js",
Expand Down Expand Up @@ -141,18 +147,18 @@
"ava": "^5.3.1",
"chokidar-cli": "^3.0.0",
"cross-env": "^7.0.3",
"depcheck": "^1.4.6",
"depcheck": "^1.4.7",
"docdash": "^2.0.2",
"eslint": "^8.51.0",
"eslint-config-google": "^0.14.0",
"eslint-plugin-ava": "^14.0.0",
"eslint-plugin-jsdoc": "^46.8.2",
"esmock": "^2.5.5",
"esmock": "^2.5.6",
"jsdoc": "^4.0.2",
"nyc": "^15.1.0",
"open-cli": "^7.2.0",
"rimraf": "^5.0.5",
"sinon": "^16.1.0",
"sinon": "^16.1.3",
"supertest": "^6.3.3",
"tap-xunit": "^2.4.1"
}
Expand Down
11 changes: 11 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"compilerOptions": {
"target": "esnext",
"noEmit": true,
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"allowSyntheticDefaultImports": true,
"module": "NodeNext",
"moduleResolution": "NodeNext",
},
}
35 changes: 35 additions & 0 deletions types/MiddlewareParameters.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import type { MiddlewareUtil } from "./MiddlewareUtil.d.ts";
import type { TaskUtil } from "@ui5/project/build/helpers/TaskUtil";

// Mock some of the types, so it would be easier to follow
declare type ui5_logger_Logger = object
declare type ui5_fs_AbstractReader = object

// This one should be (eventually) provided globally or as a part of @ui5/project/Specification
declare type availableSpecVersions = "2.0" | "2.2" | "3.0" | "3.2";

declare interface MiddlewareParametersBase {
log: ui5_logger_Logger
options: {
configuration?: Record<string, any>
}
resources: {
all: ui5_fs_AbstractReader
rootProject: ui5_fs_AbstractReader
dependencies: ui5_fs_AbstractReader
},
}

declare interface MiddlewareParameters_2_0<specVersion extends availableSpecVersions> extends MiddlewareParametersBase {
middlewareUtil: MiddlewareUtil<specVersion>;
}

declare interface MiddlewareParameters_2_2<specVersion extends availableSpecVersions> extends MiddlewareParameters_2_0<specVersion> {
taskUtil: TaskUtil<specVersion>
}

export declare type MiddlewareParameters<specVersion extends availableSpecVersions> = specVersion extends "2.0"
? MiddlewareParameters_2_0<specVersion>
: specVersion extends availableSpecVersions
? MiddlewareParameters_2_2<specVersion>
: MiddlewareParametersBase
35 changes: 35 additions & 0 deletions types/MiddlewareUtil.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// This one should be (eventually) provided globally or as a part of @ui5/project/Specification
declare type availableSpecVersions = "2.0" | "2.2" | "3.0" | "3.2";

// Mock some of the types, so it would be easier to follow
declare type ui5_fs_resourceFactory = object
declare type ui5_fs_Resource = object

declare type MimeInfo = {
type: string
charset: string
contentType: string
};

declare class MiddlewareUtil_v2_0 {
resourceFactory: ui5_fs_resourceFactory
getPathname(req: object): string
getMimeInfo(resourcePath: object): MimeInfo
}

declare class MiddlewareUtil_v3_0 extends MiddlewareUtil_v2_0 {
getDependencies(projectName?: string): string[]
getProject(projectNameOrResource?: string | ui5_fs_Resource)
}

declare class MiddlewareUtil_v3_2 extends MiddlewareUtil_v3_0 {
someFutureMethod();
}

export declare type MiddlewareUtil<specVersion extends availableSpecVersions> = specVersion extends "2.0"
? MiddlewareUtil_v2_0
: specVersion extends "3.0" | "2.2"
? MiddlewareUtil_v3_0
: specVersion extends "3.2"
? MiddlewareUtil_v3_2
: never;
3 changes: 3 additions & 0 deletions types/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
// Re exporting types from other modules
export type { MiddlewareParameters } from "./MiddlewareParameters.d.ts";
export type { MiddlewareUtil } from "./MiddlewareUtil.d.ts";
3 changes: 3 additions & 0 deletions types/ui5_serve.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import type { ProjectGraph } from "@ui5/project/graph";

export declare function serve(graph: ProjectGraph, configuration: Record<string, string | number | boolean>): Function;