feat: 为特殊格式增加别名

Author: geekact

src/base-openapi-client.ts

@@ -1,6 +1,38 @@
 import type { OpenapiClientAdapter, Methods } from './lib/adapter';
 import { utils } from './utils';
 
+export namespace string {
+ export type BigInt = string;
+ /**
+ * 2020-02-12T07:20:50.52Z
+ */
+ export type DateTime = string;
+ /**
+ * 2020-02-12
+ */
+ export type Date = string;
+ /**
+ * 07:20:50.52Z
+ */
+ export type Time = string;
+ /**
+ * example@gmail.com
+ */
+ export type Email = string;
+ /**
+ * https://example.com/foo/bar
+ */
+ export type Uri = string;
+ /**
+ * 127.0.0.1
+ */
+ export type IPv4 = string;
+ /**
+ * 2001:0DB8:0000:0023:0008:0800:200C:417A
+ */
+ export type IPv6 = string;
+}
+
 export namespace BaseOpenapiClient {
  export interface UserInputOpts<T extends object = object> {
  headers?: Record<string, unknown>;

src/lib/parse-schema.ts

@@ -22,12 +22,31 @@ export const parseSchema = (
  case 'number':
  if (parsed.format === 'int64') {
  // bigint 在传输过程中会转为字符串
- return `(string${nullable})`;
+ return `(string.BigInt${nullable})`;
  }
  return `(number${nullable})`;
  case 'string':
- if (parsed.format === 'binary') return `(Blob${nullable})`;
- return `(string${nullable})`;
+ switch (parsed.format) {
+ case 'binary':
+ return `(Blob${nullable})`;
+ case 'date':
+ return `(string.Date${nullable})`;
+ case 'date-time':
+ return `(string.DateTime${nullable})`;
+ case 'time':
+ return `(string.Time${nullable})`;
+ case 'email':
+ return `(string.Email${nullable})`;
+ case 'uri':
+ return `(string.Uri${nullable})`;
+ case 'ipv4':
+ return `(string.IPv4${nullable})`;
+ case 'ipv6':
+ return `(string.IPv6${nullable})`;
+ default:
+ return `(string${nullable})`;
+ }
+
  case 'array':
  return `((${parseSchema(docs, parsed.items)})[]${nullable})`;
  case 'object': {

test/lib/parse-schema.test.ts

@@ -15,6 +15,16 @@ describe('常规', () => {
  expect(type).toMatchInlineSnapshot(`"(string)"`);
  });
 
+ test('邮箱', () => {
+ const type = parseSchema(docs, { type: 'string', format: 'email' });
+ expect(type).toMatchInlineSnapshot(`"(string.Email)"`);
+ });
+
+ test('超链接', () => {
+ const type = parseSchema(docs, { type: 'string', format: 'uri' });
+ expect(type).toMatchInlineSnapshot(`"(string.Uri)"`);
+ });
+
  test('布尔', () => {
  const type = parseSchema(docs, { type: 'boolean' });
  expect(type).toMatchInlineSnapshot(`"(boolean)"`);
@@ -85,7 +95,28 @@ describe('常规', () => {
 
  test('bigint转为字符串', () => {
  const type = parseSchema(docs, { type: 'integer', format: 'int64' });
- expect(type).toMatchInlineSnapshot(`"(string)"`);
+ expect(type).toMatchInlineSnapshot(`"(string.BigInt)"`);
+ });
+
+ test('时间', () => {
+ expect(parseSchema(docs, { type: 'string', format: 'date' })).toMatchInlineSnapshot(
+ `"(string.Date)"`,
+ );
+ expect(
+ parseSchema(docs, { type: 'string', format: 'date-time' }),
+ ).toMatchInlineSnapshot(`"(string.DateTime)"`);
+ expect(parseSchema(docs, { type: 'string', format: 'time' })).toMatchInlineSnapshot(
+ `"(string.Time)"`,
+ );
+ });
+
+ test('ip', () => {
+ expect(parseSchema(docs, { type: 'string', format: 'ipv4' })).toMatchInlineSnapshot(
+ `"(string.IPv4)"`,
+ );
+ expect(parseSchema(docs, { type: 'string', format: 'ipv6' })).toMatchInlineSnapshot(
+ `"(string.IPv6)"`,
+ );
  });
 
  test('动态对象属性', () => {