Research
Security News
Malicious npm Package Typosquats react-login-page to Deploy Keylogger
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
conjure-typescript
Advanced tools
Readme
CLI to generate TypeScript Interfaces and clients from Conjure API definitions.
The generated clients provide a simple Promise based interface for executing strongly typed remote procedure calls from the browser or node.
The recommended way to use conjure-typescript is via a build tool like gradle-conjure. However, if you don't want to use gradle-conjure, there is also an executable which conforms to RFC 002, published on maven.org.
conjure-typescript generate <input> <output> [..Options]
Generate TypeScript bindings for a Conjure API
Positionals:
input The location of the API IR
output The output directory for the generated code
Options:
--version Show version number [boolean]
--help Show help [boolean]
--packageVersion The version of the generated package [string]
--packageName The name of the generated package [string]
--flavorizedAliases Generates flavoured types for compatible aliases. [boolean] [default: false]
--nodeCompatibleModules Generate node compatible javascript [boolean] [default: false]
--rawSource Generate raw source without any package metadata [boolean] [default: false]
--readonlyInterfaces Generated interfaces have readonly properties and collections [boolean] [default: false]
--productDependencies Path to a file containing a list of product dependencies [string]
This project is versioned according to SemVer. We consider the generated code to be part of the 'public API' of conjure-typescript, i.e. TypeScript generated by old conjure-typescript and new conjure-typescript (within a major version) should be compatible, so your consumers should be able to upgrade without compilation problems.
We also consider the command line interface and feature flags to be public API.
Conjure object: ManyFieldExample
Objects can easily be instantiated:
const example: ManyFieldExample = {
string: "foo",
integer: 123,
optionalItem: "bar",
items: []
}
Conjure union: UnionTypeExample
Union types can be one of a few variants. To interact with a union value, users should use the .accept
method and define a Visitor that handles each of the possible variants, including the possibility of an unknown variant.
const unionExample = IUnionTypeExample.string("Hello, world");
const output = IUnionTypeExample.visit(unionExample, {
string: (value: string) => {
// your logic here!
},
set: (value: string[]) => {},
// ...
unknown: (unknownType: IUnionTypeExample) => {}
});
Visitors may seem clunky in TypeScript, but they have the upside of compile-time assurance that you've handled all the possible variants. If you upgrade an API dependency and the API author added a new variant, the TypeScript compiler will force you to explicitly deal with this new variant. We intentionally avoid switch
statements.
We also generate type-guards:
if (IUnionTypeExample.isString(unionTypeExample)) {
const inner: string = unionTypeExample.string;
}
Conjure enum: EnumExample
conjure-typescript leverages TypeScript's string Enums.
export enum EnumExample {
ONE = "ONE",
TWO = "TWO"
}
console.log(EnumExample.ONE); // prints "ONE"
Conjure alias
TypeScript uses structural (duck-typing) so aliases are currently elided.
Example service interface: PrimitiveService
export interface IPrimitiveService {
getPrimitive(): Promise<number>;
}
export class PrimitiveService {
public getPrimitive(): Promise<number> {
return this.bridge.callEndpoint<number>({
endpointName: "getPrimitive",
endpointPath: "/getPrimitive",
method: "GET",
requestMediaType: MediaType.APPLICATION_JSON,
responseMediaType: MediaType.APPLICATION_JSON,
});
}
}
Use clients from conjure-typescript-runtime which configures the browser's Fetch API with sensible defaults:
import { DefaultHttpApiBridge } from "conjure-client";
const recipes = new RecipeBookService(new DefaultHttpApiBridge({
baseUrl: "https://some.base.url.com",
userAgent: {
productName: "yourProductName",
productVersion: "1.0.0"
}
}));
const results: Recipe[] = await recipes.getRecipes();
For instructions on how to set up your local development environment, check out the Contributing document.
This project is made available under the Apache 2.0 License.
FAQs
Unknown package
The npm package conjure-typescript receives a total of 55 weekly downloads. As such, conjure-typescript popularity was classified as not popular.
We found that conjure-typescript demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.
Security News
The JavaScript community has launched the e18e initiative to improve ecosystem performance by cleaning up dependency trees, speeding up critical parts of the ecosystem, and documenting lighter alternatives to established tools.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.