Skip to content

Added ExtendBaseWith type for Rest API example #69

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

Merged
merged 5 commits into from
Aug 5, 2021
Merged
Show file tree
Hide file tree
Changes from 3 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
16 changes: 10 additions & 6 deletions examples/rest-api-client-dts/index.d.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
import { Base } from "../../index.js";
import { Base, ExtendBaseWith } from "../../index.js";

import { requestPlugin } from "./request-plugin.js";

declare type Constructor<T> = new (...args: any[]) => T;

export class RestApiClient extends Base {
request: ReturnType<typeof requestPlugin>["request"];
}
export const RestApiClient: ExtendBaseWith<
Base,
{
defaults: {
userAgent: string;
};
plugins: [typeof requestPlugin];
}
>;
11 changes: 10 additions & 1 deletion examples/rest-api-client-dts/index.test-d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ import { expectType } from "tsd";
import { RestApiClient } from "./index.js";

// @ts-expect-error - An argument for 'options' was not provided
new RestApiClient();
let value: typeof RestApiClient = new RestApiClient();

expectType<{ userAgent: string }>(value.defaults);

expectType<{ userAgent: string }>(RestApiClient.defaults);

Expand Down Expand Up @@ -43,3 +45,10 @@ export async function test() {
repo: "javascript-plugin-architecture-with-typescript-definitions",
});
}

export async function testInstanceType(client: RestApiClient) {
client.request("GET /repos/{owner}/{repo}", {
owner: "gr2m",
repo: "javascript-plugin-architecture-with-typescript-definitions",
});
}
30 changes: 26 additions & 4 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,7 @@ type RequiredIfRemaining<PredefinedOptions, NowProvided> = NonOptionalKeys<
NowProvided
];

type ConstructorRequiringOptionsIfNeeded<
Class extends ClassWithPlugins,
PredefinedOptions
> = {
type ConstructorRequiringOptionsIfNeeded<Class, PredefinedOptions> = {
defaults: PredefinedOptions;
} & {
new <NowProvided>(
Expand Down Expand Up @@ -156,4 +153,29 @@ export declare class Base<TOptions extends Base.Options = Base.Options> {

constructor(options: TOptions);
}

type Extensions = {
defaults?: {};
plugins?: Plugin[];
};

type OrObject<T, Extender> = T extends Extender ? {} : T;

type ApplyPlugins<Plugins extends Plugin[] | undefined> =
Plugins extends Plugin[]
? UnionToIntersection<ReturnType<Plugins[number]>>
: {};

export type ExtendBaseWith<
BaseClass extends Base,
BaseExtensions extends Extensions
> = BaseClass &
ConstructorRequiringOptionsIfNeeded<
BaseClass & ApplyPlugins<BaseExtensions["plugins"]>,
OrObject<BaseClass["options"], unknown>
> &
ApplyPlugins<BaseExtensions["plugins"]> & {
defaults: OrObject<BaseExtensions["defaults"], undefined>;
};

export {};
47 changes: 46 additions & 1 deletion index.test-d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { expectType } from "tsd";
import { Base, Plugin } from "./index.js";
import { Base, ExtendBaseWith, Plugin } from "./index.js";

import { fooPlugin } from "./plugins/foo/index.js";
import { barPlugin } from "./plugins/bar/index.js";
Expand Down Expand Up @@ -238,3 +238,48 @@ const baseWithManyChainedDefaultsAndPlugins =
expectType<string>(baseWithManyChainedDefaultsAndPlugins.foo);
expectType<string>(baseWithManyChainedDefaultsAndPlugins.bar);
expectType<string>(baseWithManyChainedDefaultsAndPlugins.getFooOption());

declare const RestApiClient: ExtendBaseWith<
Base,
{
defaults: {
defaultValue: string;
};
plugins: [
() => { pluginValueOne: number },
() => { pluginValueTwo: boolean }
];
}
>;

expectType<string>(RestApiClient.defaults.defaultValue);

// @ts-expect-error
RestApiClient.defaults.unexpected;

expectType<number>(RestApiClient.pluginValueOne);
expectType<boolean>(RestApiClient.pluginValueTwo);

// @ts-expect-error
RestApiClient.unexpected;

declare const MoreDefaultRestApiClient: ExtendBaseWith<
typeof RestApiClient,
{
defaults: {
anotherDefaultValue: number;
};
}
>;

expectType<string>(MoreDefaultRestApiClient.defaults.defaultValue);
expectType<number>(MoreDefaultRestApiClient.defaults.anotherDefaultValue);

declare const MorePluginRestApiClient: ExtendBaseWith<
typeof MoreDefaultRestApiClient,
{
plugins: [() => { morePluginValue: string[] }];
}
>;

expectType<string[]>(MorePluginRestApiClient.morePluginValue);