wasm-ast-types 0.11.3 → 0.13.0

package/src/utils/types.ts

@@ -0,0 +1,459 @@
+import * as t from '@babel/types';
+import { camel, pascal } from 'case';
+import { propertySignature } from './babel';
+import { TSTypeAnnotation } from '@babel/types';
+import { RenderContext } from '../context';
+import { JSONSchema } from '../types';
+
+export function getResponseType(
+  context: RenderContext,
+  underscoreName: string
+) {
+  const methodName = camel(underscoreName);
+  return pascal(
+    context.contract?.responses?.[underscoreName]?.title
+    ??
+    // after v1.1 is adopted, we can deprecate this and require the above response
+    `${methodName}Response`
+  );
+};
+
+const getTypeStrFromRef = ($ref) => {
+  if ($ref?.startsWith('#/definitions/')) {
+    return $ref.replace('#/definitions/', '');
+  }
+  throw new Error('what is $ref: ' + $ref);
+}
+
+export const getTypeFromRef = ($ref) => {
+  return t.tsTypeReference(t.identifier(getTypeStrFromRef($ref)))
+}
+
+const getArrayTypeFromRef = ($ref) => {
+  return t.tsArrayType(
+    getTypeFromRef($ref)
+  );
+}
+
+const getTypeOrRef = (obj) => {
+  if (obj.type) {
+    return getType(obj.type)
+  }
+  if (obj.$ref) {
+    return getTypeFromRef(obj.$ref);
+  }
+  throw new Error('contact maintainers cannot find type for ' + obj)
+}
+
+const getArrayTypeFromItems = (items) => {
+  // passing in [{"type":"string"}]
+  if (Array.isArray(items)) {
+    return t.tsArrayType(
+      t.tsArrayType(
+        getTypeOrRef(items[0])
+      )
+    );
+  }
+
+  // passing in {"items": [{"type":"string"}]}
+  const detect = detectType(items.type);
+
+  if (detect.type === 'array') {
+    if (Array.isArray(items.items)) {
+      return t.tsArrayType(
+        t.tsArrayType(
+          getTypeOrRef(items.items[0])
+        )
+      );
+    } else {
+      return t.tsArrayType(
+        getArrayTypeFromItems(
+          items.items
+        )
+      );
+    }
+  }
+
+
+  return t.tsArrayType(
+    getType(detect.type)
+  );
+}
+
+
+export const detectType = (type: string | string[]) => {
+  let optional = false;
+  let theType = '';
+  if (Array.isArray(type)) {
+    if (type.length !== 2) {
+      throw new Error('[getType(array length)] case not handled by transpiler. contact maintainers.')
+    }
+    const [nullableType, nullType] = type;
+    if (nullType !== 'null') {
+      throw new Error('[getType(null)] case not handled by transpiler. contact maintainers.')
+    }
+    theType = nullableType;
+    optional = true;
+  } else {
+    theType = type;
+  }
+
+  return {
+    type: theType,
+    optional
+  };
+}
+
+export const getTypeInfo = (info: JSONSchema) => {
+  let type = undefined;
+  let optional = undefined;
+
+  if (Array.isArray(info.anyOf)) {
+    // assuming 2nd is null, but let's check to ensure
+    if (info.anyOf.length !== 2) {
+      throw new Error('case not handled by transpiler. contact maintainers.')
+    }
+    const [nullableType, nullType] = info.anyOf;
+    if (nullType?.type !== 'null') {
+      throw new Error('[nullableType.type]: case not handled by transpiler. contact maintainers.')
+    }
+    if (!nullableType?.$ref) {
+      if (nullableType.title) {
+        type = t.tsTypeReference(t.identifier(nullableType.title));
+      } else {
+        throw new Error('[nullableType.title] case not handled by transpiler. contact maintainers.')
+      }
+    } else {
+      type = getTypeFromRef(nullableType?.$ref);
+    }
+    optional = true;
+  }
+
+
+  if (typeof info.type === 'string') {
+    if (info.type === 'array') {
+      if (typeof info.items === 'object' && !Array.isArray(info.items)) {
+        if (info.items.$ref) {
+          type = getArrayTypeFromRef(info.items.$ref);
+        } else if (info.items.title) {
+          type = t.tsArrayType(
+            t.tsTypeReference(
+              t.identifier(info.items.title)
+            )
+          );
+        } else if (info.items.type) {
+          type = getArrayTypeFromItems(info.items);
+        } else {
+          throw new Error('[info.items] case not handled by transpiler. contact maintainers.')
+        }
+      } else {
+        throw new Error('[info.items] case not handled by transpiler. contact maintainers.')
+      }
+    } else {
+      const detect = detectType(info.type);
+      type = getType(detect.type);
+      optional = detect.optional;
+    }
+  }
+
+  if (Array.isArray(info.type)) {
+    // assuming 2nd is null, but let's check to ensure
+    if (info.type.length !== 2) {
+      throw new Error('please report this to maintainers (field type): ' + JSON.stringify(info, null, 2))
+    }
+    const [nullableType, nullType] = info.type;
+    if (nullType !== 'null') {
+      throw new Error('please report this to maintainers (field type): ' + JSON.stringify(info, null, 2))
+    }
+
+    if (nullableType === 'array' && typeof info.items === 'object' && !Array.isArray(info.items)) {
+
+      if (info.items.type) {
+        const detect = detectType(info.items.type);
+        if (detect.type === 'array') {
+          // wen recursion?
+          type = t.tsArrayType(
+            getArrayTypeFromItems(info.items)
+          );
+        } else {
+          type = t.tsArrayType(
+            getType(detect.type)
+          );
+        }
+        optional = detect.optional;
+      } else if (info.items.$ref) {
+        type = getArrayTypeFromRef(info.items.$ref);
+        // } else if (info.items.title) {
+        //   type = t.tsArrayType(
+        //     t.tsTypeReference(
+        //       t.identifier(info.items.title)
+        //     )
+        //   );
+      } else if (info.items.type) {
+        type = getArrayTypeFromItems(info.items);
+      } else {
+        throw new Error('[info.items] case not handled by transpiler. contact maintainers.')
+      }
+
+    } else {
+      const detect = detectType(nullableType);
+      optional = detect.optional;
+      if (detect.type === 'array') {
+        type = getArrayTypeFromItems(
+          info.items
+        );
+      } else {
+        type = getType(detect.type);
+      }
+
+    }
+
+    optional = true;
+  }
+
+  return {
+    type,
+    optional
+  };
+
+}
+
+
+export const getType = (type: string) => {
+  switch (type) {
+    case 'string':
+      return t.tsStringKeyword();
+    case 'boolean':
+      return t.tSBooleanKeyword();
+    case 'integer':
+      return t.tsNumberKeyword();
+    default:
+      throw new Error('contact maintainers [unknown type]: ' + type);
+  }
+}
+
+export const getPropertyType = (
+  context: RenderContext,
+  schema: JSONSchema,
+  prop: string
+) => {
+  const props = schema.properties ?? {};
+  let info = props[prop];
+
+  let type = null;
+  let optional = !schema.required?.includes(prop);
+
+  if (info.allOf && info.allOf.length === 1) {
+    info = info.allOf[0];
+  }
+
+  if (typeof info.$ref === 'string') {
+    type = getTypeFromRef(info.$ref)
+  }
+
+  const typeInfo = getTypeInfo(info);
+  if (typeof typeInfo.optional !== 'undefined') {
+    optional = typeInfo.optional;
+  }
+  if (typeof typeInfo.type !== 'undefined') {
+    type = typeInfo.type;
+  }
+
+  if (!type) {
+    throw new Error('cannot find type for ' + JSON.stringify(info))
+  }
+
+  if (schema.required?.includes(prop)) {
+    optional = false;
+  }
+
+  return { type, optional };
+};
+
+
+export function getPropertySignatureFromProp(
+  context: RenderContext,
+  jsonschema: JSONSchema,
+  prop: string,
+  camelize: boolean
+) {
+  if (jsonschema.properties[prop].type === 'object') {
+    if (jsonschema.properties[prop].title) {
+      return propertySignature(
+        camelize ? camel(prop) : prop,
+        t.tsTypeAnnotation(
+          t.tsTypeReference(t.identifier(jsonschema.properties[prop].title))
+        )
+      );
+    } else {
+      throw new Error('getPropertySignatureFromProp() contact maintainer');
+    }
+  }
+
+  if (Array.isArray(jsonschema.properties[prop].allOf)) {
+    const isOptional = !jsonschema.required?.includes(prop);
+    const unionTypes = jsonschema.properties[prop].allOf.map(el => {
+      if (el.title) return el.title;
+      if (el.$ref) return getTypeStrFromRef(el.$ref);
+      return el.type;
+    });
+    // @ts-ignore:next-line
+    const uniqUnionTypes = [...new Set(unionTypes)];
+
+    if (uniqUnionTypes.length === 1) {
+      return propertySignature(
+        camelize ? camel(prop) : prop,
+        t.tsTypeAnnotation(
+          t.tsTypeReference(
+            t.identifier(uniqUnionTypes[0])
+          )
+        ),
+        isOptional
+      );
+    } else {
+      return propertySignature(
+        camelize ? camel(prop) : prop,
+        t.tsTypeAnnotation(
+          t.tsUnionType(
+            uniqUnionTypes.map(typ =>
+              t.tsTypeReference(
+                t.identifier(typ)
+              )
+            )
+          )
+        ),
+        isOptional
+      );
+    }
+  } else if (Array.isArray(jsonschema.properties[prop].oneOf)) {
+    const isOptional = !jsonschema.required?.includes(prop);
+    const unionTypes = jsonschema.properties[prop].oneOf.map(el => {
+      if (el.title) return el.title;
+      if (el.$ref) return getTypeStrFromRef(el.$ref);
+      return el.type;
+    });
+    // @ts-ignore:next-line
+    const uniqUnionTypes = [...new Set(unionTypes)];
+    if (uniqUnionTypes.length === 1) {
+      return propertySignature(
+        camelize ? camel(prop) : prop,
+        t.tsTypeAnnotation(
+          t.tsTypeReference(
+            t.identifier(uniqUnionTypes[0])
+          )
+        ),
+        isOptional
+      );
+    } else {
+      return propertySignature(
+        camelize ? camel(prop) : prop,
+        t.tsTypeAnnotation(
+          t.tsUnionType(
+            uniqUnionTypes.map(typ =>
+              t.tsTypeReference(
+                t.identifier(typ)
+              )
+            )
+          )
+        ),
+        isOptional
+      );
+    }
+
+  }
+
+  try {
+    getPropertyType(context, jsonschema, prop);
+  } catch (e) {
+    console.log(e);
+    console.log(JSON.stringify(jsonschema, null, 2), prop);
+  }
+
+  const { type, optional } = getPropertyType(context, jsonschema, prop);
+  return propertySignature(
+    camelize ? camel(prop) : prop,
+    t.tsTypeAnnotation(
+      type
+    ),
+    optional
+  );
+}
+
+export const getParamsTypeAnnotation = (
+  context: RenderContext,
+  jsonschema: any,
+  camelize: boolean = true
+): t.TSTypeAnnotation => {
+  const keys = Object.keys(jsonschema.properties ?? {});
+
+  if (!keys.length && jsonschema.$ref) {
+    return t.tsTypeAnnotation(getTypeFromRef(jsonschema.$ref))
+  }
+
+  if (!keys.length) return undefined;
+
+  const typedParams = keys.map(prop => getPropertySignatureFromProp(
+    context,
+    jsonschema,
+    prop,
+    camelize
+  ));
+
+  return t.tsTypeAnnotation(
+    t.tsTypeLiteral(
+      // @ts-ignore:next-line
+      [
+        ...typedParams
+      ]
+    )
+  )
+}
+
+export const createTypedObjectParams = (
+  context: RenderContext,
+  jsonschema: JSONSchema,
+  camelize: boolean = true
+): t.ObjectPattern => {
+
+  const keys = Object.keys(jsonschema.properties ?? {});
+  if (!keys.length) {
+
+    // is there a ref?
+    if (jsonschema.$ref) {
+      const obj = context.refLookup(jsonschema.$ref);
+      if (obj) {
+        return createTypedObjectParams(
+          context,
+          obj,
+          camelize
+        );
+      }
+    }
+
+    // no results...
+    return;
+  }
+
+  const params = keys.map(prop => {
+    return t.objectProperty(
+      camelize ? t.identifier(camel(prop)) : t.identifier(prop),
+      camelize ? t.identifier(camel(prop)) : t.identifier(prop),
+      false,
+      true
+    );
+  });
+
+  const obj = t.objectPattern(
+    [
+      ...params
+    ]
+  );
+
+  obj.typeAnnotation = getParamsTypeAnnotation(
+    context,
+    jsonschema,
+    camelize
+  );
+
+  return obj;
+};

package/types/client/client.d.ts

@@ -8,7 +8,7 @@ export declare const createWasmQueryMethod: (context: RenderContext, jsonschema:
 export declare const createQueryClass: (context: RenderContext, className: string, implementsClassName: string, queryMsg: QueryMsg) => t.ExportNamedDeclaration;
 export declare const getWasmMethodArgs: (context: RenderContext, jsonschema: JSONSchema) => t.ObjectProperty[];
 export declare const createWasmExecMethod: (context: RenderContext, jsonschema: JSONSchema) => t.ClassProperty;
-export declare const createExecuteClass: (context: RenderContext, className: string, implementsClassName: string, extendsClassName: string, execMsg: ExecuteMsg) => t.ExportNamedDeclaration;
+export declare const createExecuteClass: (context: RenderContext, className: string, implementsClassName: string, extendsClassName: string | null, execMsg: ExecuteMsg) => t.ExportNamedDeclaration;
 export declare const createExecuteInterface: (context: RenderContext, className: string, extendsClassName: string | null, execMsg: ExecuteMsg) => t.ExportNamedDeclaration;
 export declare const createPropertyFunctionWithObjectParams: (context: RenderContext, methodName: string, responseType: string, jsonschema: JSONSchema) => t.TSPropertySignature;
 export declare const createPropertyFunctionWithObjectParamsForExec: (context: RenderContext, methodName: string, responseType: string, jsonschema: JSONSchema) => t.TSPropertySignature;

package/types/context/context.d.ts

@@ -9,6 +9,7 @@ export interface ReactQueryOptions {
 }
 export interface TSClientOptions {
     enabled?: boolean;
+    execExtendsQuery?: boolean;
 }
 export interface MessageComposerOptions {
     enabled?: boolean;