Skip to content
Open
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
2 changes: 1 addition & 1 deletion codegen/layouts/partials/route-class-endpoint-export.hbs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export type {{parametersTypeName}} = {{#if requiresAtLeastOneParameter}}RequireAtLeastOne<{{/if}}{{> request-object parameters=parameters}}{{#if requiresAtLeastOneParameter}}>{{/if}}
export type {{parametersTypeName}} = {{#if requiresAtLeastOneParameter}}RequireAtLeastOne<{{/if}}{{> request-object parameters=parameters}}{{#if requiresAtLeastOneParameter}}, {{atLeastOneParameterNamesUnion}}>{{/if}}

/**
* @deprecated Use {{requestTypeName}} instead.
Expand Down
1 change: 1 addition & 0 deletions codegen/layouts/partials/route-class-endpoint.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
parameters,
hasRequiredParameters: {{hasRequiredParameters}},
requiredParameterNames: [{{#each requiredParameterNames}}{{json .}}{{#unless @last}}, {{/unless}}{{/each}}],
atLeastOneParameterNames: [{{#each atLeastOneParameterNames}}{{json .}}{{#unless @last}}, {{/unless}}{{/each}}],
responseKey: {{#if returnsVoid}}undefined{{else}}'{{responseKey}}'{{/if}},
{{#if hasPagination}}hasPagination: true,
{{/if}}options,
Expand Down
22 changes: 20 additions & 2 deletions codegen/lib/layouts/route.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ export interface EndpointLayoutContext {
hasRequiredParameters: boolean
requiredParameterNames: string[]
requiresAtLeastOneParameter: boolean
atLeastOneParameterNames: string[]
atLeastOneParameterNamesUnion: string
parameters: Parameter[]
responseIsList: boolean
responseResourceTypeName: string
Expand Down Expand Up @@ -72,7 +74,9 @@ export const setRouteLayoutContext = (
file.needsRequireAtLeastOneImport =
node != null &&
'endpoints' in node &&
node.endpoints.some(requiresAtLeastOneParameter)
node.endpoints.some(
(endpoint) => getAtLeastOneParameterNames(endpoint).length > 0,
)
file.resourceTypeImports =
node != null && 'endpoints' in node
? [
Expand Down Expand Up @@ -155,7 +159,12 @@ export const getEndpointLayoutContext = (
requiredParameterNames: endpoint.request.parameters
.filter(({ isRequired }) => isRequired)
.map(({ name }) => name),
requiresAtLeastOneParameter: requiresAtLeastOneParameter(endpoint),
requiresAtLeastOneParameter:
getAtLeastOneParameterNames(endpoint).length > 0,
atLeastOneParameterNames: getAtLeastOneParameterNames(endpoint),
atLeastOneParameterNamesUnion: getAtLeastOneParameterNames(endpoint)
.map((name) => `'${name}'`)
.join(' | '),
parameters: endpoint.request.parameters,
responseIsList: endpoint.response.responseType === 'resource_list',
responseResourceTypeName:
Expand All @@ -172,6 +181,15 @@ const requiresAtLeastOneParameter = (endpoint: Endpoint): boolean =>
endpoint.request.hasRequiredParameters &&
endpoint.request.parameters.every(({ isRequired }) => !isRequired)

const paginationParameterNames = new Set(['limit', 'page_cursor'])

const getAtLeastOneParameterNames = (endpoint: Endpoint): string[] =>
requiresAtLeastOneParameter(endpoint)
? endpoint.request.parameters
.map(({ name }) => name)
.filter((name) => !paginationParameterNames.has(name))
: []

const isActionAttemptEndpoint = (endpoint: Endpoint): boolean =>
endpoint.response.responseType === 'resource' &&
endpoint.response.resourceType === 'action_attempt'
Expand Down
7 changes: 5 additions & 2 deletions src/lib/request-parameters.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export const assertValidRequestParameters = (
path: string,
hasRequiredParameters: boolean,
requiredParameterNames: readonly string[],
atLeastOneParameterNames: readonly string[],
): void => {
if (parameters === undefined) {
if (hasRequiredParameters) {
Expand Down Expand Up @@ -37,8 +38,10 @@ export const assertValidRequestParameters = (
}

if (
hasRequiredParameters &&
Object.values(parameterValues).every((value) => value === undefined)
atLeastOneParameterNames.length > 0 &&
atLeastOneParameterNames.every(
(name) => parameterValues[name] === undefined,
)
) {
throw new TypeError(`At least one parameter is required for ${path}`)
}
Expand Down
144 changes: 88 additions & 56 deletions src/lib/routes/access-codes/access-codes.ts

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

1 change: 1 addition & 0 deletions src/lib/routes/access-codes/simulate/simulate.ts

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

36 changes: 22 additions & 14 deletions src/lib/routes/access-codes/unmanaged/unmanaged.ts

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

Loading
Loading