@trpc/openapi 0.0.0-alpha.0 → 11.13.2-alpha

package/dist/index.d.cts

@@ -0,0 +1,63 @@
+//#region src/generate.d.ts
+/**
+ * A minimal JSON Schema subset used for OpenAPI 3.1 schemas.
+ */
+interface JsonSchema {
+  $ref?: string;
+  $defs?: Record<string, JsonSchema>;
+  type?: string | string[];
+  properties?: Record<string, JsonSchema>;
+  required?: string[];
+  items?: JsonSchema | false;
+  prefixItems?: JsonSchema[];
+  const?: string | number | boolean | null;
+  enum?: (string | number | boolean | null)[];
+  oneOf?: JsonSchema[];
+  anyOf?: JsonSchema[];
+  allOf?: JsonSchema[];
+  not?: JsonSchema;
+  additionalProperties?: JsonSchema | boolean;
+  discriminator?: {
+    propertyName: string;
+    mapping?: Record<string, string>;
+  };
+  format?: string;
+  description?: string;
+  minItems?: number;
+  maxItems?: number;
+  $schema?: string;
+}
+interface GenerateOptions {
+  /**
+   * The name of the exported router symbol.
+   * @default 'AppRouter'
+   */
+  exportName?: string;
+  /** Title for the generated OpenAPI `info` object. */
+  title?: string;
+  /** Version string for the generated OpenAPI `info` object. */
+  version?: string;
+}
+interface OpenAPIDocument {
+  openapi: string;
+  jsonSchemaDialect?: string;
+  info: {
+    title: string;
+    version: string;
+  };
+  paths: Record<string, Record<string, unknown>>;
+  components: Record<string, unknown>;
+}
+/**
+ * Analyse the given TypeScript router file using the TypeScript compiler and
+ * return an OpenAPI 3.1 document describing all query and mutation procedures.
+ *
+ * @param routerFilePath - Absolute or relative path to the file that exports
+ *   the AppRouter.
+ * @param options - Optional generation settings (export name, title, version).
+ */
+declare function generateOpenAPIDocument(routerFilePath: string, options?: GenerateOptions): Promise<OpenAPIDocument>;
+//# sourceMappingURL=generate.d.ts.map
+//#endregion
+export { GenerateOptions, JsonSchema, OpenAPIDocument, generateOpenAPIDocument };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/generate.ts"],"sourcesContent":[],"mappings":";;AAcA;;AAEyB,UAFR,UAAA,CAEQ;EAAU,IAAzB,CAAA,EAAA,MAAA;EAAM,KAEc,CAAA,EAFpB,MAEoB,CAAA,MAAA,EAFL,UAEK,CAAA;EAAU,IAAzB,CAAA,EAAA,MAAA,GAAA,MAAA,EAAA;EAAM,UAEX,CAAA,EAFK,MAEL,CAAA,MAAA,EAFoB,UAEpB,CAAA;EAAU,QACJ,CAAA,EAAA,MAAA,EAAA;EAAU,KAGhB,CAAA,EAJA,UAIA,GAAA,KAAA;EAAU,WACV,CAAA,EAJM,UAIN,EAAA;EAAU,KACV,CAAA,EAAA,MAAA,GAAA,MAAA,GAAA,OAAA,GAAA,IAAA;EAAU,IACZ,CAAA,EAAA,CAAA,MAAA,GAAA,MAAA,GAAA,OAAA,GAAA,IAAA,CAAA,EAAA;EAAU,KACO,CAAA,EAJf,UAIe,EAAA;EAAU,KACiB,CAAA,EAJ1C,UAI0C,EAAA;EAAM,KAAA,CAAA,EAHhD,UAGgD,EAAA;EAsBzC,GAAA,CAAA,EAxBT,UAwBS;EAYA,oBAAe,CAAA,EAnCP,UAmCO,GAAA,OAAA;EAAA,aAAA,CAAA,EAAA;IAIR,YAAA,EAAA,MAAA;IAAf,OAAA,CAAA,EAtC2C,MAsC3C,CAAA,MAAA,EAAA,MAAA,CAAA;EAAM,CAAA;EACK,MAAA,CAAA,EAAA,MAAA;EAqmCE,WAAA,CAAA,EAAA,MAAA;EAAuB,QAAA,CAAA,EAAA,MAAA;EAAA,QAElC,CAAA,EAAA,MAAA;EAAoB,OACpB,CAAA,EAAA,MAAA;;AAAD,UAznCO,eAAA,CAynCP;;;;;;;;;;;UA7mCO,eAAA;;;;;;;SAIR,eAAe;cACV;;;;;;;;;;iBAqmCQ,uBAAA,mCAEX,kBACR,QAAQ"}

package/dist/index.d.mts

@@ -0,0 +1,63 @@
+//#region src/generate.d.ts
+/**
+ * A minimal JSON Schema subset used for OpenAPI 3.1 schemas.
+ */
+interface JsonSchema {
+  $ref?: string;
+  $defs?: Record<string, JsonSchema>;
+  type?: string | string[];
+  properties?: Record<string, JsonSchema>;
+  required?: string[];
+  items?: JsonSchema | false;
+  prefixItems?: JsonSchema[];
+  const?: string | number | boolean | null;
+  enum?: (string | number | boolean | null)[];
+  oneOf?: JsonSchema[];
+  anyOf?: JsonSchema[];
+  allOf?: JsonSchema[];
+  not?: JsonSchema;
+  additionalProperties?: JsonSchema | boolean;
+  discriminator?: {
+    propertyName: string;
+    mapping?: Record<string, string>;
+  };
+  format?: string;
+  description?: string;
+  minItems?: number;
+  maxItems?: number;
+  $schema?: string;
+}
+interface GenerateOptions {
+  /**
+   * The name of the exported router symbol.
+   * @default 'AppRouter'
+   */
+  exportName?: string;
+  /** Title for the generated OpenAPI `info` object. */
+  title?: string;
+  /** Version string for the generated OpenAPI `info` object. */
+  version?: string;
+}
+interface OpenAPIDocument {
+  openapi: string;
+  jsonSchemaDialect?: string;
+  info: {
+    title: string;
+    version: string;
+  };
+  paths: Record<string, Record<string, unknown>>;
+  components: Record<string, unknown>;
+}
+/**
+ * Analyse the given TypeScript router file using the TypeScript compiler and
+ * return an OpenAPI 3.1 document describing all query and mutation procedures.
+ *
+ * @param routerFilePath - Absolute or relative path to the file that exports
+ *   the AppRouter.
+ * @param options - Optional generation settings (export name, title, version).
+ */
+declare function generateOpenAPIDocument(routerFilePath: string, options?: GenerateOptions): Promise<OpenAPIDocument>;
+//# sourceMappingURL=generate.d.ts.map
+//#endregion
+export { GenerateOptions, JsonSchema, OpenAPIDocument, generateOpenAPIDocument };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/generate.ts"],"sourcesContent":[],"mappings":";;AAcA;;AAEyB,UAFR,UAAA,CAEQ;EAAU,IAAzB,CAAA,EAAA,MAAA;EAAM,KAEc,CAAA,EAFpB,MAEoB,CAAA,MAAA,EAFL,UAEK,CAAA;EAAU,IAAzB,CAAA,EAAA,MAAA,GAAA,MAAA,EAAA;EAAM,UAEX,CAAA,EAFK,MAEL,CAAA,MAAA,EAFoB,UAEpB,CAAA;EAAU,QACJ,CAAA,EAAA,MAAA,EAAA;EAAU,KAGhB,CAAA,EAJA,UAIA,GAAA,KAAA;EAAU,WACV,CAAA,EAJM,UAIN,EAAA;EAAU,KACV,CAAA,EAAA,MAAA,GAAA,MAAA,GAAA,OAAA,GAAA,IAAA;EAAU,IACZ,CAAA,EAAA,CAAA,MAAA,GAAA,MAAA,GAAA,OAAA,GAAA,IAAA,CAAA,EAAA;EAAU,KACO,CAAA,EAJf,UAIe,EAAA;EAAU,KACiB,CAAA,EAJ1C,UAI0C,EAAA;EAAM,KAAA,CAAA,EAHhD,UAGgD,EAAA;EAsBzC,GAAA,CAAA,EAxBT,UAwBS;EAYA,oBAAe,CAAA,EAnCP,UAmCO,GAAA,OAAA;EAAA,aAAA,CAAA,EAAA;IAIR,YAAA,EAAA,MAAA;IAAf,OAAA,CAAA,EAtC2C,MAsC3C,CAAA,MAAA,EAAA,MAAA,CAAA;EAAM,CAAA;EACK,MAAA,CAAA,EAAA,MAAA;EAqmCE,WAAA,CAAA,EAAA,MAAA;EAAuB,QAAA,CAAA,EAAA,MAAA;EAAA,QAElC,CAAA,EAAA,MAAA;EAAoB,OACpB,CAAA,EAAA,MAAA;;AAAD,UAznCO,eAAA,CAynCP;;;;;;;;;;;UA7mCO,eAAA;;;;;;;SAIR,eAAe;cACV;;;;;;;;;;iBAqmCQ,uBAAA,mCAEX,kBACR,QAAQ"}