https://github.com/ehmpathy/sdk-code-generator
sdk codegen via endpoint introspection. generate a pit-of-success sdk for any api
https://github.com/ehmpathy/sdk-code-generator
Last synced: 7 months ago
JSON representation
sdk codegen via endpoint introspection. generate a pit-of-success sdk for any api
- Host: GitHub
- URL: https://github.com/ehmpathy/sdk-code-generator
- Owner: ehmpathy
- License: mit
- Created: 2025-06-25T02:36:35.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-06-25T02:46:00.000Z (7 months ago)
- Last Synced: 2025-06-25T03:33:51.360Z (7 months ago)
- Language: TypeScript
- Size: 0 Bytes
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
# sdk-code-generator
sdk codegen via endpoint introspection. generate a pit-of-success sdk for any api
# purpose
automate sdk maintenance via codegen to...
- sync types
- sync endpoints
- automatically
# install
```sh
npm install @ehmpathy/sdk-code-generator
```
# use
### **api-side**: generate the introspection endpoint
before an sdk can be generated, the api must be introspectable. to do so, create an endpoint that publishes a JsonSchema of your api.
this package can help do so automatically
#### 1. declare which endpoints to introspect
in your introspection config file, `codegen.sdk.ts`, specify where to find the endpoints to introspect
for example, choose endpoints via glob paths
```ts
// codegen.sdk.ts
import { ConfigIntrospectApi } from '@ehmpathy/sdk-code-generator';
export const introspect: ConfigIntrospectApi = {
input: { glob: '@src/contract/endpoints/*' },
output: '@src/contract/endpoints', // declare where to publish the introspect endpoint, as-endpoint
}
```
or
for example, choose endpoints via imports
```ts
// codegen.sdk.ts
import { ApiEndpoint } from 'as-endpoint';
import { ConfigIntrospectApi } from '@ehmpathy/sdk-code-generator';
import { endpoint as getPlantPot } from '@src/contract/endpoints/getPlantPot';
import { endpoint as setPlantPot } from '@src/contract/endpoints/setPlantPot';
import { endpoints } from '@src/contract/endpoints';
const toIntrospect: ApiEndpoint[] = [getPlantPot, setPlantPot, ...endpoints];
export const introspect: ConfigIntrospectApi = {
input: toIntrospect,
output: '@src/contract/endpoints', // declare where to publish the introspect endpoint, as-endpoint
}
```
##### 2. execute the introspection codegen
once you've declared which endpoints to introspect, you can invoke introspection via the below cli command
```sh
npx @ehmpathy/sdk-code-generator introspect -c codegen.sdk.introspect.ts
```
which will introspect your endpoints and create a new endpoint
### **sdk-side**: generate the sdk
now that an introspection endpoint is available on the api-side, we can leverage it to generate the sdk
#### 1. declare which apis to generate sdks for
in your config file, `codegen.sdk.ts`, specify which api's to generate sdk's for
```ts
import { ConfigGenerateSdk } from '@ehmpathy/sdk-code-generator';
export const generate: ConfigGenerateSdk = {
input: {
apis: [
{
interface: { lambda: 'svc-jokes' }
},
{
interface: { lambda: 'svc-comedians' }
},
{
interface: { lambda: 'svc-recommendation' }
},
// ...
]
},
output: '@src/data/sdk/',
}
```
#### 2. execute the sdk codegen
```sh
npx @ehmpathy/sdk-code-generator introspect -c codegen.sdk.introspect.ts
```
which will introspect and generate an sdk for each of the api's listed
for example
```ts
// @src/data/sdk/svcJokes.ts
import { DomainEntity } from 'domain-objects';
import { createCache } from 'simple-in-memory-cache';
import { invokeLambdaFunction } from 'simple-lambda-client';
import { HasMetadata } from 'type-fns';
import { withExpectOutkey } from 'procedure-fns';
import { withExpectOutput } from 'procedure-fns';
const service = 'svc-jokes';
export interface SvcJokesJoke {
uuid?: string;
createdAt?: string;
updatedAt?: string;
semanticHash: string | null;
variantHash: string | null;
deliveryAudioUrl: string | null;
deliveryVideoUrl: string | null;
deliveryWords: string;
}
export class SvcJokesJoke extends DomainEntity implements SvcJokesJoke {
public static primary = ['uuid'] as const
public static unique = ['semanticHash', 'variantHash'] as const
}
const getJoke = (event: {
by: PickOne<{
primary: RefByPrimary,
unique: RefByUnique
}>;
}): Promise<{
joke: HasMetadata | null;
}> =>
invokeLambdaFunction({
service,
stage,
function: 'getJoke',
event,
logDebug: log.debug,
});
const setJoke = (event: {
by: PickOne<{
upsert: SvcJokesJoke,
finsert: SvcJokesJoke,
update: Ref & Partial,
}>;
}): Promise<{
joke: HasMetadata | null;
}> =>
invokeLambdaFunction({
service,
stage,
function: 'setJoke',
event,
logDebug: log.debug,
});
export const svcJokes = {
getJoke: withExpectOutkey(getJoke),
setJoke,
};
```