@aws/nx-plugin 0.14.2 → 0.15.0

package/src/open-api/ts-hooks/files/options-proxy.gen.ts.template

@@ -0,0 +1,210 @@
+import type {
+<%_ if (allOperations.some(op => op.isQuery)) { _%>
+  QueryFilters,
+  UseQueryOptions,
+<%_ } _%>
+<%_ if (allOperations.some(op => op.isInfiniteQuery)) { _%>
+  UseInfiniteQueryOptions,
+  InfiniteData,
+<%_ } _%>
+<%_ if (allOperations.some(op => op.isMutation)) { _%>
+  UseMutationOptions,
+<%_ } _%>
+<%_ if (allOperations.some(op => op.isStreaming)) { _%>
+  QueryFunctionContext,
+<%_ } _%>
+} from '@tanstack/react-query';
+<%_ if ((models.length + allOperations.length) > 0) { _%>
+import type {
+<%_ allOperations.filter(p => p.parameters.length > 0).forEach((op) => { _%>
+  <%- op.operationIdPascalCase %>Request,
+<%_ }); _%>
+<%_ allOperations.forEach((op) => { _%>
+  <%- op.operationIdPascalCase %>Error,
+<%_ }); _%>
+<%_ const uniq = (arr) => {
+  const set = new Set();
+  return arr.filter((item) => {
+    if (set.has(item)) {
+      return false;
+    }
+    set.add(item);
+    return true;
+  });
+} _%>
+<%_ const modelsByName = Object.fromEntries(models.map(m => [m.name, m])); _%>
+<%_ uniq(allOperations.flatMap((op) => op.result && modelsByName[op.result.type] ? [op.result.typescriptType] : [])).forEach((returnTypeModel) => { _%>
+  <%- returnTypeModel %>,
+<%_ }); _%>
+} from './types.gen.js';
+<%_ } _%>
+import { <%- className %> } from './client.gen.js';
+
+export interface <%- className %>OptionsProxyConfig {
+  client: <%- className %>;
+}
+
+export class <%- className %>OptionsProxy {
+  private $client: <%- className %>;
+
+  constructor({ client }: <%- className %>OptionsProxyConfig) {
+    this.$client = client;
+
+    <%_ allOperations.forEach((op) => { _%>
+    <%_ if (op.isQuery) { _%>
+    this._<%- op.uniqueName %>QueryKey = this._<%- op.uniqueName %>QueryKey.bind(this);
+    this._<%- op.uniqueName %>QueryOptions = this._<%- op.uniqueName %>QueryOptions.bind(this);
+    this._<%- op.uniqueName %>QueryFilter = this._<%- op.uniqueName %>QueryFilter.bind(this);
+    <%_ } _%>
+    <%_ if (op.isInfiniteQuery) { _%>
+    this._<%- op.uniqueName %>InfiniteQueryOptions = this._<%- op.uniqueName %>InfiniteQueryOptions.bind(this);
+    <%_ } _%>
+    <%_ if (op.isMutation) { _%>
+    this._<%- op.uniqueName %>MutationKey = this._<%- op.uniqueName %>MutationKey.bind(this);
+    this._<%- op.uniqueName %>MutationOptions = this._<%- op.uniqueName %>MutationOptions.bind(this);
+    <%_ } _%>
+    <%_ }); _%>
+  }
+
+<%_ if (allOperations.some(op => op.isStreaming)) { _%>
+  protected async $queryStream<T>(context: QueryFunctionContext<any>, stream: AsyncIterable<T>): Promise<T[]> {
+    const query = context.client
+      .getQueryCache()
+      .find({ queryKey: context.queryKey, exact: true });
+
+    if (query && query.state.data !== undefined) {
+      query.setState({
+        status: 'pending',
+        data: undefined,
+        error: null,
+        fetchStatus: 'fetching',
+      });
+    }
+
+    const chunks: T[] = [];
+    for await (const chunk of stream) {
+      if (context.signal.aborted) {
+        break;
+      }
+      chunks.push(chunk);
+      query?.setState({
+        status: 'success',
+        fetchStatus: 'fetching',
+      });
+      context.client.setQueryData<T[]>(context.queryKey, (prev = []) =>
+        prev.concat(chunk),
+      );
+    }
+    query?.setState({
+      fetchStatus: 'idle',
+    });
+    return chunks;
+  }
+
+  protected async $waitForStream<T>(iterable: AsyncIterable<T>) {
+    const chunks: T[] = [];
+    for await (const chunk of iterable) {
+      chunks.push(chunk);
+    }
+    return chunks;
+  }
+<%_ } _%>
+
+  public queryKey = () => ['<%- className %>'];
+
+  <%_ allOperations.forEach((op) => { _%>
+  <%_ const hasTag = op.tags && op.tags.length > 0; _%>
+  <%_ const isInputOptional = (op.parameters.length === 1 && op.parametersBody && !op.parametersBody.isRequired) || op.parameters.length === 0; _%>
+  <%_ const input = op.parameters.length > 0 ? `input${isInputOptional ? '?' : ''}: ${op.operationIdPascalCase}Request` : ''; _%>
+  <%_ const isStreaming = op.isStreaming; _%>
+  <%_ const resultType = op.result ? op.result.typescriptType : 'void'; _%>
+  <%_ const queryResultType = `${resultType}${isStreaming ? '[]' : ''}`; _%>
+  <%_ const mutationResultType = isStreaming ? `AsyncIterableIterator<${resultType}>` : resultType; _%>
+  <%_ const errorType = `${op.operationIdPascalCase}Error`; _%>
+  <%_ if (op.isQuery) { _%>
+  <%_ const queryOptionsType = `UseQueryOptions<${queryResultType}, ${errorType}>`; _%>
+  private _<%- op.uniqueName %>QueryKey(<%- input %>) {
+    return [...this.queryKey(), '<%- op.uniqueName %>'<% if (op.parameters.length > 0) { %>, input<% } %>];
+  }
+  private _<%- op.uniqueName %>QueryOptions(<%- input %><% if (op.parameters.length > 0) { %>, <% } %>options?: Omit<<%- queryOptionsType %>, 'queryFn' | 'queryKey'> & Partial<Pick<<%- queryOptionsType %>, 'queryFn' | 'queryKey'>>): <%- queryOptionsType %> {
+    return {
+      queryFn: (<% if (isStreaming) { %>context<% } %>) => <% if (isStreaming) { %>this.$queryStream(context, <% } %><% if (hasTag) { %>(this.$client as any)._<% } else { %>this.$client.<% } %><%- op.uniqueName %>(<% if (op.parameters.length > 0) { %>input<% } %>)<% if (isStreaming) { %>)<% } %>,
+      queryKey: this._<%- op.uniqueName %>QueryKey(<% if (op.parameters.length > 0) { %>input<% } %>),
+      ...options,
+    };
+  }
+  private _<%- op.uniqueName %>QueryFilter(<%- input %><% if (op.parameters.length > 0) { %>, <% } %>filter?: QueryFilters<<%- queryResultType %>, <%- errorType %>>): QueryFilters<<%- queryResultType %>, <%- errorType %>> {
+    return {
+      queryKey: this._<%- op.uniqueName %>QueryKey(<% if (op.parameters.length > 0) { %>input<% } %>),
+      ...filter,
+    };
+  }
+  <%_ } _%>
+  <%_ if (op.isInfiniteQuery) { _%>
+  <%_ const cursorType = `${op.infiniteQueryCursorProperty.typescriptType}${op.infiniteQueryCursorProperty.isRequired ? '' : ' | undefined'}${op.infiniteQueryCursorProperty.isNullable && op.infiniteQueryCursorProperty.type !== 'null' ? '' : ' | null'}`; _%>
+  <%_ const infiniteQueryOptionsType = `UseInfiniteQueryOptions<${queryResultType}, ${errorType}, InfiniteData<${queryResultType}>, ${queryResultType}, unknown[], ${cursorType}>`; _%>
+  <%_ emptyInitialPageParam = !op.infiniteQueryCursorProperty.isRequired ? 'undefined' : (op.infiniteQueryCursorProperty.isNullable ? 'null' : undefined); _%>
+  private _<%- op.uniqueName %>InfiniteQueryOptions(<%- input %><% if (op.parameters.length > 0) { %>, <% } %>options: Omit<<%- infiniteQueryOptionsType %>, 'queryFn' | 'queryKey'<%- emptyInitialPageParam ? ` | 'initialPageParam'` : '' %>> & Partial<Pick<<%- infiniteQueryOptionsType %>, 'queryFn' | 'queryKey'<%- emptyInitialPageParam ? ` | 'initialPageParam'` : '' %>>>): <%- infiniteQueryOptionsType %> {
+    return {
+      queryKey: this._<%- op.uniqueName %>QueryKey(<% if (op.parameters.length > 0) { %>input<% } %>),
+      queryFn: ({ pageParam }) => <% if (isStreaming) { %>this.$waitForStream(<% } %><% if (hasTag) { %>(this.$client as any)._<% } else { %>this.$client.<% } %><%- op.uniqueName %>({ ...input, <%- op.infiniteQueryCursorProperty.typescriptName %>: pageParam as any })<% if (isStreaming) { %>)<% } %>,
+      <%_ if (emptyInitialPageParam) { _%>
+      initialPageParam: <%- emptyInitialPageParam %>,
+      <%_ } _%>
+      ...options,
+    };
+  }
+  <%_ } _%>
+  <%_ if (op.isMutation) { _%>
+  private _<%- op.uniqueName %>MutationKey() {
+    return [...this.queryKey(), '<%- op.uniqueName %>'];
+  }
+  <%_ const mutationOptionsType = `UseMutationOptions<${mutationResultType}, ${errorType}, ${op.parameters.length > 0 ? `${op.operationIdPascalCase}Request` : 'void'}>` _%>
+  private _<%- op.uniqueName %>MutationOptions(options?: <%- mutationOptionsType %>): <%- mutationOptionsType %> {
+    return {
+      mutationFn: <% if (isStreaming) { %>async <% } %>(<% if (op.parameters.length > 0) { %>input<% } %>) => <% if (hasTag) { %>(this.$client as any)._<% } else { %>this.$client.<% } %><%- op.uniqueName %>(<% if (op.parameters.length > 0) { %>input<% } %>),
+      mutationKey: this._<%- op.uniqueName %>MutationKey(),
+      ...options,
+    };
+  }
+  <%_ } _%>
+  <%_ }); _%>
+
+  <%_ Object.entries(operationsByTag).forEach(([tag, operations]) => { _%>
+  public <%- tag %> = {
+    <%_ operations.forEach((op) => { _%>
+    <%- op.name %>: {
+      <%_ if (op.isQuery) { _%>
+      queryKey: this._<%- op.uniqueName %>QueryKey.bind(this),
+      queryOptions: this._<%- op.uniqueName %>QueryOptions.bind(this),
+      queryFilter: this._<%- op.uniqueName %>QueryFilter.bind(this),
+      <%_ } _%>
+      <%_ if (op.isInfiniteQuery) { _%>
+      infiniteQueryOptions: this._<%- op.uniqueName %>InfiniteQueryOptions.bind(this),
+      <%_ } _%>
+      <%_ if (op.isMutation) { _%>
+      mutationKey: this._<%- op.uniqueName %>MutationKey.bind(this),
+      mutationOptions: this._<%- op.uniqueName %>MutationOptions.bind(this),
+      <%_ } _%>
+    },
+    <%_ }); _%>
+  };
+  <%_ }); _%>
+
+  <%_ untaggedOperations.forEach((op) => { _%>
+  public <%- op.name %> = {
+    <%_ if (op.isQuery) { _%>
+    queryKey: this._<%- op.uniqueName %>QueryKey.bind(this),
+    queryOptions: this._<%- op.uniqueName %>QueryOptions.bind(this),
+    queryFilter: this._<%- op.uniqueName %>QueryFilter.bind(this),
+    <%_ } _%>
+    <%_ if (op.isInfiniteQuery) { _%>
+    infiniteQueryOptions: this._<%- op.uniqueName %>InfiniteQueryOptions.bind(this),
+    <%_ } _%>
+    <%_ if (op.isMutation) { _%>
+    mutationKey: this._<%- op.uniqueName %>MutationKey.bind(this),
+    mutationOptions: this._<%- op.uniqueName %>MutationOptions.bind(this),
+    <%_ } _%>
+  };
+  <%_ }); _%>
+}

package/src/open-api/ts-hooks/generator.d.ts

@@ -4,8 +4,13 @@
  */
 import { Tree } from '@nx/devkit';
 import { OpenApiHooksSchema } from './schema';
+import { CodeGenData } from '../utils/codegen-data/types';
 /**
  * Generates typescript hooks from an openapi spec
  */
 export declare const openApiTsHooksGenerator: (tree: Tree, options: OpenApiHooksSchema) => Promise<void>;
+/**
+ * Generate OpenAPI typescript hooks in the target directory
+ */
+export declare const generateOpenApiTsHooks: (tree: Tree, data: CodeGenData, outputPath: string) => void;
 export default openApiTsHooksGenerator;

package/src/open-api/ts-hooks/generator.js

@@ -1,11 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.openApiTsHooksGenerator = void 0;
+exports.generateOpenApiTsHooks = exports.openApiTsHooksGenerator = void 0;
 const tslib_1 = require("tslib");
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+const devkit_1 = require("@nx/devkit");
 const parse_1 = require("../utils/parse");
 const codegen_data_1 = require("../utils/codegen-data");
 const generator_1 = require("../ts-client/generator");
 const format_1 = require("../../utils/format");
+const path_1 = tslib_1.__importDefault(require("path"));
 /**
  * Generates typescript hooks from an openapi spec
  */
@@ -13,9 +19,16 @@ const openApiTsHooksGenerator = (tree, options) => tslib_1.__awaiter(void 0, voi
     const spec = yield (0, parse_1.parseOpenApiSpec)(tree, options.openApiSpecPath);
     const data = yield (0, codegen_data_1.buildOpenApiCodeGenData)(spec);
     (0, generator_1.generateOpenApiTsClient)(tree, data, options.outputPath);
-    // TODO: generate hooks which wrap the client
+    (0, exports.generateOpenApiTsHooks)(tree, data, options.outputPath);
     yield (0, format_1.formatFilesInSubtree)(tree);
 });
 exports.openApiTsHooksGenerator = openApiTsHooksGenerator;
+/**
+ * Generate OpenAPI typescript hooks in the target directory
+ */
+const generateOpenApiTsHooks = (tree, data, outputPath) => {
+    (0, devkit_1.generateFiles)(tree, path_1.default.join(__dirname, 'files'), outputPath, data);
+};
+exports.generateOpenApiTsHooks = generateOpenApiTsHooks;
 exports.default = exports.openApiTsHooksGenerator;
 //# sourceMappingURL=generator.js.map

package/src/open-api/ts-hooks/generator.js.map

@@ -1 +1 @@
-{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/open-api/ts-hooks/generator.ts"],"names":[],"mappings":";;;;AAMA,0CAAkD;AAClD,wDAAgE;AAChE,sDAAiE;AACjE,+CAA0D;AAE1D;;GAEG;AACI,MAAM,uBAAuB,GAAG,CACrC,IAAU,EACV,OAA2B,EAC3B,EAAE;IACF,MAAM,IAAI,GAAG,MAAM,IAAA,wBAAgB,EAAC,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAEnE,MAAM,IAAI,GAAG,MAAM,IAAA,sCAAuB,EAAC,IAAI,CAAC,CAAC;IAEjD,IAAA,mCAAuB,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAExD,6CAA6C;IAE7C,MAAM,IAAA,6BAAoB,EAAC,IAAI,CAAC,CAAC;AACnC,CAAC,CAAA,CAAC;AAbW,QAAA,uBAAuB,2BAalC;AAEF,kBAAe,+BAAuB,CAAC"}
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../../../../../packages/nx-plugin/src/open-api/ts-hooks/generator.ts"],"names":[],"mappings":";;;;AAAA;;;GAGG;AACH,uCAAiD;AAEjD,0CAAkD;AAClD,wDAAgE;AAChE,sDAAiE;AACjE,+CAA0D;AAC1D,wDAAwB;AAGxB;;GAEG;AACI,MAAM,uBAAuB,GAAG,CACrC,IAAU,EACV,OAA2B,EAC3B,EAAE;IACF,MAAM,IAAI,GAAG,MAAM,IAAA,wBAAgB,EAAC,IAAI,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IAEnE,MAAM,IAAI,GAAG,MAAM,IAAA,sCAAuB,EAAC,IAAI,CAAC,CAAC;IAEjD,IAAA,mCAAuB,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IACxD,IAAA,8BAAsB,EAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAEvD,MAAM,IAAA,6BAAoB,EAAC,IAAI,CAAC,CAAC;AACnC,CAAC,CAAA,CAAC;AAZW,QAAA,uBAAuB,2BAYlC;AAEF;;GAEG;AACI,MAAM,sBAAsB,GAAG,CACpC,IAAU,EACV,IAAiB,EACjB,UAAkB,EAClB,EAAE;IACF,IAAA,sBAAa,EAAC,IAAI,EAAE,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;AACvE,CAAC,CAAC;AANW,QAAA,sBAAsB,0BAMjC;AAEF,kBAAe,+BAAuB,CAAC"}