Skip to content
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.

Sign up for GitHub

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

Jump to bottom

feat: support ClientOptions containing endpoint and credentials #15

Merged
merged 1 commit into from
Jan 19, 2023
+159 −127
Merged

feat: support ClientOptions containing endpoint and credentials #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 0 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,13 @@
"peerDependencies": {
"@aws-crypto/sha256-js": "^3",
"@aws-sdk/credential-providers": "^3",
"@aws-sdk/middleware-signing": "3",
"@aws-sdk/protocol-http": "^3",
"@aws-sdk/signature-v4": "^3",
"@aws-sdk/types": "^3"
},
"devDependencies": {
"@aws-crypto/sha256-js": "3.0.0",
"@aws-sdk/credential-provider-env": "3.226.0",
"@aws-sdk/middleware-signing": "3.226.0",
"@aws-sdk/protocol-http": "3.226.0",
"@aws-sdk/signature-v4": "3.226.0",
"@aws-sdk/types": "3.226.0",
Expand Down
3 changes: 1 addition & 2 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

265 changes: 149 additions & 116 deletions scripts/gen-sdk-types.mts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,141 +72,158 @@ const interfaces = awsType
serviceName,
undefined,
undefined,
serviceInstance.getProperties().flatMap((method) => {
const methodName = method.name;
const methodType = checker.getTypeOfSymbolAtLocation(
method,
awsStmt
);
const methodSignatures = methodType.getCallSignatures();
if (methodSignatures.length > 0) {
const methodSignature = methodSignatures.find(
(method) =>
method.parameters.length > 1 &&
method.parameters[0]?.escapedName === "params"
[
ts.factory.createConstructorDeclaration(
undefined,
[
ts.factory.createParameterDeclaration(
undefined,
undefined,
"options",
ts.factory.createToken(ts.SyntaxKind.QuestionToken),
ts.factory.createTypeReferenceNode("ClientOptions")
),
],
undefined
),
...serviceInstance.getProperties().flatMap((method) => {
const methodName = method.name;
const methodType = checker.getTypeOfSymbolAtLocation(
method,
awsStmt
);
if (methodSignature) {
const paramsType = checker.getTypeOfSymbolAtLocation(
methodSignature.parameters[0]!,
awsStmt
);
const paramsFqn = checker.getFullyQualifiedName(
paramsType.symbol
const methodSignatures = methodType.getCallSignatures();
if (methodSignatures.length > 0) {
const methodSignature = methodSignatures.find(
(method) =>
method.parameters.length > 1 &&
method.parameters[0]?.escapedName === "params"
);
const [paramsServiceName, paramsTypeName] = paramsFqn.split(
".",
2
);
const returnType = methodSignature.getReturnType();
const promiseSym = returnType.getProperty("promise");
if (promiseSym) {
// promise(): PromiseResult<Response<Payload, AWSErr>>
const promiseType = checker
.getTypeOfSymbolAtLocation(promiseSym, awsStmt)
.getCallSignatures()[0]
?.getReturnType();

if (promiseType) {
// PromiseResult<Response<Payload, AWSErr>>
const promiseResult = checker.getTypeArguments(
promiseType as ts.TypeReference
)[0];
const $response = promiseResult?.getProperty("$response");
if ($response) {
// Response<Payload, AWSErr>
const responseType = checker.getTypeOfSymbolAtLocation(
$response,
awsStmt
);
if (methodSignature) {
const paramsType = checker.getTypeOfSymbolAtLocation(
methodSignature.parameters[0]!,
awsStmt
);
const paramsFqn = checker.getFullyQualifiedName(
paramsType.symbol
);
const [paramsServiceName, paramsTypeName] = paramsFqn.split(
".",
2
);
const returnType = methodSignature.getReturnType();
const promiseSym = returnType.getProperty("promise");
if (promiseSym) {
// promise(): PromiseResult<Response<Payload, AWSErr>>
const promiseType = checker
.getTypeOfSymbolAtLocation(promiseSym, awsStmt)
.getCallSignatures()[0]
?.getReturnType();

const responsePayloadType = checker.getTypeArguments(
responseType as ts.TypeReference
if (promiseType) {
// PromiseResult<Response<Payload, AWSErr>>
const promiseResult = checker.getTypeArguments(
promiseType as ts.TypeReference
)[0];
if (responsePayloadType) {
responsePayloadType;
const responseFqn = checker.getFullyQualifiedName(
responsePayloadType.symbol
const $response = promiseResult?.getProperty("$response");
if ($response) {
// Response<Payload, AWSErr>
const responseType = checker.getTypeOfSymbolAtLocation(
$response,
awsStmt
);
let type: ts.TypeNode;
if (responseFqn === "__type") {
// empty object {}
type = ts.factory.createTypeLiteralNode([]);
} else if (
checker.typeToString(responsePayloadType) === "any"
) {
type = ts.factory.createKeywordTypeNode(
ts.SyntaxKind.AnyKeyword
);
} else if (responseFqn.indexOf(".") !== -1) {
// <service-name>.<type-name>
const [serviceName, typeName] = responseFqn.split(
".",
2

const responsePayloadType = checker.getTypeArguments(
responseType as ts.TypeReference
)[0];
if (responsePayloadType) {
responsePayloadType;
const responseFqn = checker.getFullyQualifiedName(
responsePayloadType.symbol
);
type = ts.factory.createTypeReferenceNode(
ts.factory.createQualifiedName(
let type: ts.TypeNode;
if (responseFqn === "__type") {
// empty object {}
type = ts.factory.createTypeLiteralNode([]);
} else if (
checker.typeToString(responsePayloadType) === "any"
) {
type = ts.factory.createKeywordTypeNode(
ts.SyntaxKind.AnyKeyword
);
} else if (responseFqn.indexOf(".") !== -1) {
// <service-name>.<type-name>
const [serviceName, typeName] = responseFqn.split(
".",
2
);
type = ts.factory.createTypeReferenceNode(
ts.factory.createQualifiedName(
ts.factory.createIdentifier("AWS"),
ts.factory.createIdentifier(serviceName!)
),
ts.factory.createIdentifier(typeName!)
)
);
} else {
return [];
}

const methodSig = ts.factory.createMethodDeclaration(
undefined,
undefined,
methodName,
undefined,
undefined,
[
ts.factory.createParameterDeclaration(
undefined,
undefined,
"input",
undefined,
ts.factory.createTypeReferenceNode(
ts.factory.createQualifiedName(
ts.factory.createQualifiedName(
ts.factory.createIdentifier("AWS"),
ts.factory.createIdentifier(
paramsServiceName!
)
),
ts.factory.createIdentifier(paramsTypeName!)
)
ts.factory.createIdentifier("AWS"),
ts.factory.createIdentifier(serviceName!)
),
ts.factory.createIdentifier(typeName!)
)
),
],
ts.factory.createTypeReferenceNode("Promise", [type]),
undefined
);
);
} else {
return [];
}

const commentText = ts.displayPartsToString(
method.getDocumentationComment(checker)
);
const methodSig = ts.factory.createMethodDeclaration(
undefined,
undefined,
methodName,
undefined,
undefined,
[
ts.factory.createParameterDeclaration(
undefined,
undefined,
"input",
undefined,
ts.factory.createTypeReferenceNode(
ts.factory.createQualifiedName(
ts.factory.createQualifiedName(
ts.factory.createIdentifier("AWS"),
ts.factory.createIdentifier(
paramsServiceName!
)
),
ts.factory.createIdentifier(paramsTypeName!)
)
)
),
],
ts.factory.createTypeReferenceNode("Promise", [
type,
]),
undefined
);

if (commentText) {
ts.addSyntheticLeadingComment(
methodSig,
ts.SyntaxKind.MultiLineCommentTrivia,
`*\n* ${commentText}\n`,
true
const commentText = ts.displayPartsToString(
method.getDocumentationComment(checker)
);

if (commentText) {
ts.addSyntheticLeadingComment(
methodSig,
ts.SyntaxKind.MultiLineCommentTrivia,
`*\n* ${commentText}\n`,
true
);
}
return [methodSig];
}
return [methodSig];
}
}
}
}
}
}

return [];
})
return [];
}),
]
),
];
}
Expand All @@ -217,6 +234,22 @@ const interfaces = awsType

const sourceFile = ts.factory.createSourceFile(
[
ts.factory.createImportDeclaration(
undefined,
ts.factory.createImportClause(
true,
undefined,
ts.factory.createNamedImports([
ts.factory.createImportSpecifier(
false,
undefined,
ts.factory.createIdentifier("ClientOptions")
),
])
),
ts.factory.createStringLiteral("./index.js"),
undefined
),
ts.factory.createImportDeclaration(
undefined,
ts.factory.createImportClause(
Expand Down
16 changes: 9 additions & 7 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
import type { SDK } from "./sdk.generated.js";
import { Sha256 } from "@aws-crypto/sha256-js";
import { fromEnv } from "@aws-sdk/credential-provider-env";
import { HttpRequest } from "@aws-sdk/protocol-http";
import { SignatureV4 } from "@aws-sdk/signature-v4";
import { Sha256 } from "@aws-crypto/sha256-js";

declare const fetch: typeof import("node-fetch").default;
import type { AwsCredentialIdentity, Provider } from "@aws-sdk/types";
import type { SDK } from "./sdk.generated.js";

interface SDKProps {
export interface ClientOptions {
endpoint?: string;
credentials?: AwsCredentialIdentity | Provider<AwsCredentialIdentity>;
}

declare const fetch: typeof import("node-fetch").default;

export const AWS: SDK = new Proxy({} as any, {
get: (_, className: keyof SDK) => {
const region = process.env.AWS_REGION!;
Expand All @@ -19,10 +21,10 @@ export const AWS: SDK = new Proxy({} as any, {
const service = className.toLowerCase();

return class {
constructor(options?: SDKProps) {
constructor(options?: ClientOptions) {
const endpoint = options?.endpoint ?? resolveEndpoint(service, region);
// TODO: support other types of credential providers
const credentials = fromEnv();
const credentials = options?.credentials ?? fromEnv();
return new Proxy(
{},
{
Expand Down