@looker/sdk-codegen 21.8.2 → 21.9.2

package/lib/sdkModels.d.ts

@@ -13,9 +13,10 @@ export declare enum TypeOfType {
     Enum = 4,
     Complex = 5
 }
+export declare const parseFields: (fields: FieldsSpec) => ArgValues;
 export declare const typeOfType: (type: IType) => TypeOfType;
 export declare const isSpecialName: (name: string) => boolean;
-export declare type ArgValues = {
+export type ArgValues = {
     [key: string]: any;
 };
 export declare const safeName: (value: string) => string;
@@ -49,14 +50,14 @@ export interface IParameter extends ITypedSymbol {
     doEncode(): boolean;
 }
 export declare const describeParam: (param: IParameter) => string;
-export declare type KeyedCollection<T> = Record<string, T>;
-export declare type MethodList = KeyedCollection<IMethod>;
-export declare type TypeList = KeyedCollection<IType>;
-export declare type TagList = KeyedCollection<MethodList>;
-export declare type TypeTagList = KeyedCollection<TypeList>;
-export declare type PropertyList = KeyedCollection<IProperty>;
-export declare type KeyList = Set<string>;
-export declare type EnumValueType = string | number;
+export type KeyedCollection<T> = Record<string, T>;
+export type MethodList = KeyedCollection<IMethod>;
+export type TypeList = KeyedCollection<IType>;
+export type TagList = KeyedCollection<MethodList>;
+export type TypeTagList = KeyedCollection<TypeList>;
+export type PropertyList = KeyedCollection<IProperty>;
+export type KeyList = Set<string>;
+export type EnumValueType = string | number;
 export declare const keyValues: (list: KeyList) => string[];
 export declare const mayQuote: (value: any, quoteChar?: string) => string;
 export declare const methodRefs: (api: IApiModel, refs: KeyList) => IMethod[];
@@ -78,8 +79,8 @@ export declare enum SearchCriterion {
     status = 8,
     response = 9
 }
-export declare type SearchCriterionTerm = keyof typeof SearchCriterion;
-export declare type SearchCriteria = Set<SearchCriterion>;
+export type SearchCriterionTerm = keyof typeof SearchCriterion;
+export type SearchCriteria = Set<SearchCriterion>;
 export declare const SearchAll: SearchCriteria;
 export declare const criteriaToSet: (criteria: string[]) => SearchCriteria;
 export declare const setToCriteria: (criteria: SearchCriteria) => string[];
@@ -99,6 +100,12 @@ export declare enum MetaType {
     Request = "Request",
     Enumerated = "Enumerated"
 }
+export interface ITypeMock {
+    fields?: FieldsSpec;
+    override?: string | ArgValues | ((response: any, mocked: any) => any);
+    httpCode?: number;
+    empty?: boolean;
+}
 export interface IType extends ISymbol {
     properties: PropertyList;
     requiredProperties: PropertyList;
@@ -121,6 +128,8 @@ export interface IType extends ISymbol {
     className: string;
     intrinsic: boolean;
     metaType: MetaType;
+    mock(options?: ITypeMock): any | undefined;
+    mockType<T>(options?: ITypeMock): T;
     instanceOf(className: string): boolean;
     asHashString(): string;
     isRecursive(): boolean;
@@ -140,7 +149,8 @@ export interface IMethodResponse {
     search(rx: RegExp, criteria: SearchCriteria): boolean;
     searchString(criteria: SearchCriteria): string;
 }
-export declare const tagTypes: (api: ApiModel, types: TypeList) => {};
+export declare const tagTypes: (api: ApiModel, types: TypeList) => ArgValues;
+export type FieldsSpec = string | string[] | ArgValues;
 export interface IProperty extends ITypedSymbol {
     required: boolean;
     nullable: boolean;
@@ -148,6 +158,9 @@ export interface IProperty extends ITypedSymbol {
     readOnly: boolean;
     writeOnly: boolean;
     deprecated: boolean;
+    schema: OAS.SchemaObject;
+    owner: string;
+    mock(options?: ITypeMock): any | undefined;
     searchString(include: SearchCriteria): string;
     search(rx: RegExp, include: SearchCriteria): boolean;
     summary(): string;
@@ -190,6 +203,7 @@ export declare class Property extends SchemadSymbol implements IProperty {
     asHashString(): string;
     searchString(criteria: SearchCriteria): string;
     search(rx: RegExp, criteria: SearchCriteria): boolean;
+    mock(options?: ITypeMock): any | undefined;
 }
 export declare class Parameter extends SchemadSymbol implements IParameter {
     description: string;
@@ -333,6 +347,8 @@ export declare class Type implements IType {
     get requiredProperties(): PropertyList;
     get optionalProperties(): PropertyList;
     get hasSpecialNeeds(): boolean;
+    mock(options?: ITypeMock): any | undefined;
+    mockType<T>(options?: ITypeMock): T;
     load(api: ApiModel): void;
     instanceOf(className: string): boolean;
     asHashString(): string;
@@ -346,12 +362,14 @@ export declare class ArrayType extends Type {
     constructor(elementType: IType, schema: OAS.SchemaObject);
     get className(): string;
     get readOnly(): boolean;
+    mock(options?: ITypeMock): any | undefined;
 }
 export declare class EnumType extends Type implements IEnumType {
     elementType: IType;
     readonly values: EnumValueType[];
     constructor(elementType: IType, schema: OAS.SchemaObject, api: ApiModel, typeName?: string, methodName?: string);
     private findName;
+    mock(_options?: ITypeMock): any | undefined;
     searchString(criteria: SearchCriteria): string;
     get className(): string;
     get readOnly(): boolean;
@@ -373,6 +391,7 @@ export declare class IntrinsicType extends Type {
     static stringTypes: string[];
     isString: boolean;
     constructor(name: string);
+    mock(options?: ITypeMock): any;
     get className(): string;
     get intrinsic(): boolean;
     get readOnly(): boolean;
@@ -384,6 +403,7 @@ export declare class WriteType extends Type {
     constructor(api: IApiModel, type: IType);
     private static readonlyProps;
 }
+export declare const specToModel: (spec: any) => ApiModel;
 export interface IApiModel extends IModel {
     version: string;
     description: string;
@@ -418,7 +438,7 @@ export declare class ApiModel implements ISymbolTable, IApiModel {
     resolveType(schema: string | OAS.SchemaObject | OAS.ReferenceObject, style?: string, typeName?: string, methodName?: string): IType;
     private requestTypeName;
     makeRequestType(method: IMethod): RequestType;
-    registerEnum(type: IType, methodName?: string): IType;
+    registerEnum(type: IType, methodName?: string): IType | EnumType;
     private _getRequestType;
     getRequestType(method: IMethod): IType | undefined;
     getEnumList(): TypeList;