@looker/sdk-codegen 21.7.4 → 21.8.1

package/lib/esm/typescript.gen.js

@@ -1,198 +1,148 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-import { describeParam, EnumType, isSpecialName, strBody } from './sdkModels';
-import { CodeGen, trimInputs, commentBlock } from './codeGen';
-export class TypescriptGen extends CodeGen {
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.TypescriptGen = void 0;
+var _sdkModels = require("./sdkModels");
+var _codeGen = require("./codeGen");
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (typeof input !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (typeof res !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+class TypescriptGen extends _codeGen.CodeGen {
   constructor() {
     super(...arguments);
-
     _defineProperty(this, "codePath", './packages/');
-
     _defineProperty(this, "useFunctions", true);
-
     _defineProperty(this, "useInterfaces", true);
-
     _defineProperty(this, "packagePath", 'sdk/src');
-
     _defineProperty(this, "itself", 'this');
-
     _defineProperty(this, "fileExtension", '.ts');
-
     _defineProperty(this, "commentStr", '// ');
-
     _defineProperty(this, "nullStr", 'null');
-
     _defineProperty(this, "transport", 'transport');
-
     _defineProperty(this, "argDelimiter", ', ');
-
     _defineProperty(this, "paramDelimiter", ',\n');
-
     _defineProperty(this, "propDelimiter", '\n');
-
     _defineProperty(this, "indentStr", '  ');
-
     _defineProperty(this, "endTypeStr", '\n}');
-
     _defineProperty(this, "willItStream", true);
-
     _defineProperty(this, "useNamedParameters", false);
-
     _defineProperty(this, "useNamedArguments", false);
-
     _defineProperty(this, "rtlNeeds", new Set());
   }
-
   reset() {
     this.rtlNeeds = new Set();
   }
-
   sdkFileName(baseFileName) {
     var _this$versions;
-
     return this.fileName("".concat((_this$versions = this.versions) === null || _this$versions === void 0 ? void 0 : _this$versions.spec.key, "/").concat(baseFileName));
   }
-
   rtlImports() {
     var rtl = Array.from(this.rtlNeeds).join(', ');
-
     if (rtl) {
       rtl += ', ';
     }
-
     return rtl;
   }
-
   rtlImportStatement() {
     var rtl = this.rtlImports();
     return rtl ? "\nimport type { ".concat(rtl, " } from '@looker/sdk-rtl'\n") : '';
   }
-
   methodsPrologue(_indent) {
     return "\nimport type { ".concat(this.rtlImports(), "IAuthSession, ITransportSettings, SDKResponse } from '@looker/sdk-rtl'\nimport { APIMethods, encodeParam } from '@looker/sdk-rtl'\n/**\n * ").concat(this.warnEditing(), "\n *\n */\nimport { sdkVersion } from '../constants'\nimport type { I").concat(this.packageName, " } from './methodsInterface'\nimport type { ").concat(this.typeNames().join(', '), " } from './models'\n\nexport class ").concat(this.packageName, " extends APIMethods implements I").concat(this.packageName, " {\n  static readonly ApiVersion = '").concat(this.apiVersion, "'\n  constructor(authSession: IAuthSession) {\n    super(authSession, sdkVersion)\n    this.apiVersion = ").concat(this.packageName, ".ApiVersion\n    this.apiPath =\n      authSession.settings.base_url === ''\n        ? ''\n        : authSession.settings.base_url + '/api/' + this.apiVersion\n  }\n\n");
   }
-
   functionsPrologue(_indent) {
     return "\nimport type { ".concat(this.rtlImports(), "IAPIMethods, IAuthSession, ITransportSettings, SDKResponse } from '@looker/sdk-rtl'\nimport { encodeParam, functionalSdk } from '@looker/sdk-rtl'\n\n/**\n * ").concat(this.warnEditing(), "\n *\n */\n\nimport { sdkVersion } from '../constants'\nimport type { ").concat(this.typeNames().join(', '), " } from './models'\n\n/**\n * Creates a \"functional sdk\" that knows the API and Looker release version\n * @param authSession authentication session\n */\nexport const functionalSdk").concat(this.apiRef, " = (\n  authSession: IAuthSession,\n) => {\n  return functionalSdk(authSession, '").concat(this.apiVersion, "', sdkVersion)\n}\n\n");
   }
-
   interfacesPrologue(_indent) {
     return "\nimport type { ".concat(this.rtlImports(), " IAPIMethods, ITransportSettings, SDKResponse } from '@looker/sdk-rtl'\n/**\n * ").concat(this.warnEditing(), "\n *\n */\nimport type { ").concat(this.typeNames().join(', '), " } from './models'\n\nexport interface I").concat(this.packageName, " extends IAPIMethods {\n\n");
   }
-
   streamsPrologue(_indent) {
     return "\nimport type { Readable } from 'readable-stream'\nimport type { ".concat(this.rtlImports(), "IAuthSession, ITransportSettings } from '@looker/sdk-rtl'\nimport { APIMethods, encodeParam } from '@looker/sdk-rtl'\n\n/**\n * ").concat(this.warnEditing(), "\n *\n */\nimport { sdkVersion } from '../constants'\nimport type { ").concat(this.typeNames().join(', '), " } from './models'\n\nexport class ").concat(this.packageName, "Stream extends APIMethods {\n  static readonly ApiVersion = '").concat(this.apiVersion, "'\n  constructor(authSession: IAuthSession) {\n    super(authSession, sdkVersion)\n    this.apiVersion = ").concat(this.packageName, "Stream.ApiVersion\n    this.apiPath =\n      authSession.settings.base_url === ''\n        ? ''\n        : authSession.settings.base_url + '/api/' + this.apiVersion\n  }\n");
   }
-
   methodsEpilogue(_indent) {
     return '\n}';
   }
-
   modelsPrologue(_indent) {
     return "".concat(this.rtlImportStatement(), "\n/*\n * ").concat(this.warnEditing(), "\n */\n\n");
   }
-
   modelsEpilogue(_indent) {
     return '';
   }
-
   commentHeader(indent, text) {
     var commentStr = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : ' * ';
     if (this.noComment || !text) return '';
     var commentPrefix = text.includes(' License') && text.includes('Copyright (c)') ? '/*' : '/**';
-
     if (commentStr === ' ') {
-      return "".concat(indent).concat(commentPrefix, "\n\n").concat(commentBlock(text, indent, commentStr), "\n").concat(indent, " */\n");
+      return "".concat(indent).concat(commentPrefix, "\n\n").concat((0, _codeGen.commentBlock)(text, indent, commentStr), "\n").concat(indent, " */\n");
     }
-
-    return "".concat(indent).concat(commentPrefix, "\n").concat(commentBlock(text, indent, commentStr), "\n").concat(indent, " */\n");
+    return "".concat(indent).concat(commentPrefix, "\n").concat((0, _codeGen.commentBlock)(text, indent, commentStr), "\n").concat(indent, " */\n");
   }
-
   beginRegion(indent, description) {
     return "".concat(indent, "//#region ").concat(description);
   }
-
   endRegion(indent, description) {
     return "".concat(indent, "//#endregion ").concat(description);
   }
-
   declareProperty(indent, property) {
     var optional = !property.required ? '?' : '';
     var nullify = property.nullable ? ' | null' : '';
-
-    if (property.name === strBody) {
+    if (property.name === _sdkModels.strBody) {
       property.type.refCount++;
       return this.commentHeader(indent, property.description || 'body parameter for dynamically created request type') + "".concat(indent).concat(property.name).concat(optional, ": ").concat(this.typeName(property.type)).concat(nullify);
     }
-
     var mapped = this.typeMap(property.type);
     return this.commentHeader(indent, this.describeProperty(property)) + "".concat(indent).concat(this.reserve(property.name)).concat(optional, ": ").concat(mapped.name).concat(nullify);
   }
-
   impartial(param, mapped) {
-    if (param.type.intrinsic || param.location !== strBody) return mapped.name;
+    if (param.type.intrinsic || param.location !== _sdkModels.strBody) return mapped.name;
     return "Partial<".concat(mapped.name, ">");
   }
-
   paramComment(param, mapped) {
     var desc = param.description || param.type.description;
-
     if (!desc) {
       desc = this.impartial(param, mapped);
     }
-
-    return "@param ".concat(param.name, " ").concat(describeParam(_objectSpread(_objectSpread({}, param), {
+    return "@param ".concat(param.name, " ").concat((0, _sdkModels.describeParam)(_objectSpread(_objectSpread({}, param), {
       description: desc
     })));
   }
-
   declareParameter(indent, method, param) {
-    var type = param.location === strBody ? this.writeableType(param.type, method) || param.type : param.type;
+    var type = param.location === _sdkModels.strBody ? this.writeableType(param.type, method) || param.type : param.type;
     var mapped = this.typeMap(type);
     var pOpt = '';
     mapped.name = this.impartial(param, mapped);
-
     if (!param.required) {
       pOpt = mapped.default ? '' : '?';
     }
-
     return "".concat(indent).concat(this.reserve(param.name)).concat(pOpt, ": ").concat(mapped.name) + (param.required ? '' : mapped.default ? " = ".concat(mapped.default) : '');
   }
-
   makeTheCall(method, inputs) {
-    inputs = trimInputs(inputs);
     var args = this.assignParams(method, inputs);
     var fun = "// functional SDK syntax is recommended for minimizing browser payloads\nlet response = await sdk.ok(".concat(method.name, "(sdk").concat(args ? ',' : '');
     var mono = "// monolithic SDK syntax can also be used for Node apps\nlet response = await sdk.ok(sdk.".concat(method.name, "(");
     return "".concat(fun).concat(args, "))\n").concat(mono).concat(args, "))");
   }
-
   methodHeaderComment(method) {
     var _method$description;
-
     var params = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
     if (this.noComment) return '';
     var lines = [];
     var desc = (_method$description = method.description) === null || _method$description === void 0 ? void 0 : _method$description.trim();
-
     if (desc) {
       lines.push(desc);
       lines.push('');
     }
-
     var resultType = this.typeMap(method.type).name;
     lines.push("".concat(method.httpMethod, " ").concat(method.endpoint, " -> ").concat(resultType));
     lines.push('');
-
     if (method.deprecated) {
       lines.push('@deprecated');
       lines.push('');
     }
-
     if (method.responseIsBoth()) {
       lines.push('@remarks');
       lines.push('**NOTE**: Binary content may be returned by this function.');
@@ -202,13 +152,10 @@ export class TypescriptGen extends CodeGen {
       lines.push('**NOTE**: Binary content is returned by this function.');
       lines.push('');
     }
-
     params.forEach(p => lines.push("@param ".concat(p)));
     var args = method.allParams;
-
     if (args.length) {
       var requestType = this.requestTypeName(method);
-
       if (requestType) {
         requestType = method.httpMethod === 'PATCH' ? "Partial<I".concat(requestType, ">") : "I".concat(requestType);
         lines.push("@param request composed interface \"".concat(requestType, "\" for complex method parameters"));
@@ -216,12 +163,10 @@ export class TypescriptGen extends CodeGen {
         args.forEach(p => lines.push(this.paramComment(p, this.paramMappedType(p, method))));
       }
     }
-
     lines.push('@param options one-time API call overrides');
     lines.push('');
     return lines.join('\n');
   }
-
   methodHeaderDeclaration(indent, method) {
     var streamer = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
     var params = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : [];
@@ -230,7 +175,6 @@ export class TypescriptGen extends CodeGen {
     var requestType = this.requestTypeName(method);
     var bump = this.bumper(indent);
     var headComment = streamer ? this.methodHeaderComment(method, ['callback streaming output function']) : this.methodHeaderComment(method, params);
-
     if (requestType) {
       fragment = method.httpMethod === 'PATCH' ? "request: Partial<I".concat(requestType, ">") : "request: I".concat(requestType);
       params.push(fragment);
@@ -240,24 +184,19 @@ export class TypescriptGen extends CodeGen {
       if (args && args.length > 0) args.forEach(p => params.push(this.declareParameter(bump, method, p)));
       fragment = params.length > 0 ? "\n".concat(params.join(this.paramDelimiter)) : '';
     }
-
     var callback = "callback: (readable: Readable) => Promise<".concat(mapped.name, ">,");
     var header = this.commentHeader(indent, headComment) + "".concat(indent, "async ").concat(method.name, "(") + (streamer ? "\n".concat(bump).concat(callback) : '');
     var returns = streamer ? '' : ": ".concat(this.returnType(indent, method));
     return header + fragment + (fragment ? ', ' : '') + "options?: Partial<ITransportSettings>)".concat(returns, " {\n");
   }
-
   methodSignature(indent, method) {
     return this.methodHeaderDeclaration(indent, method, false);
   }
-
   encodePathParams(indent, method) {
     var bump = indent + this.indentStr;
     var encodings = '';
-
     if (method.pathParams.length > 0) {
       var prefix = this.useRequest(method) ? 'request' : '';
-
       for (var param of method.pathParams) {
         if (param.doEncode()) {
           var name = this.accessor(param.name, prefix);
@@ -265,28 +204,23 @@ export class TypescriptGen extends CodeGen {
         }
       }
     }
-
     return encodings;
   }
-
   declareMethod(indent, method) {
     var bump = this.bumper(indent);
     return this.methodSignature(indent, method) + this.encodePathParams(indent, method) + this.httpCall(bump, method) + "\n".concat(indent, "}");
   }
-
   returnType(indent, method) {
     var mapped = this.typeMap(method.type);
     var errors = this.errorResponses(indent, method);
     return "Promise<SDKResponse<".concat(mapped.name, ", ").concat(errors, ">>");
   }
-
   functionSignature(indent, method) {
     var fragment;
     var requestType = this.requestTypeName(method);
     var bump = this.bumper(indent);
     var params = ['sdk: IAPIMethods'];
     var headComment = this.methodHeaderComment(method, ['sdk IAPIMethods implementation']);
-
     if (requestType) {
       fragment = method.httpMethod === 'PATCH' ? "request: Partial<I".concat(requestType, ">") : "request: I".concat(requestType);
       params.push(fragment);
@@ -296,12 +230,10 @@ export class TypescriptGen extends CodeGen {
       if (args && args.length > 0) args.forEach(p => params.push(this.declareParameter(bump, method, p)));
       fragment = params.length > 0 ? "\n".concat(params.join(this.paramDelimiter)) : '';
     }
-
     var header = this.commentHeader(indent, headComment) + "".concat(indent, "export const ").concat(method.name, " = async (");
     var returns = this.returnType(indent, method);
     return header + fragment + (fragment ? ', ' : '') + "options?: Partial<ITransportSettings>): ".concat(returns, " => {\n");
   }
-
   declareFunction(indent, method) {
     var bump = this.bumper(indent);
     this.itself = 'sdk';
@@ -309,92 +241,73 @@ export class TypescriptGen extends CodeGen {
     this.itself = 'this';
     return result;
   }
-
   declareInterface(indent, method) {
     var sig = this.methodSignature(indent, method).trimRight();
     sig = sig.replace(/^\s*async /gm, '');
     sig = sig.substr(0, sig.length - 2);
     return "".concat(sig, "\n");
   }
-
   streamerSignature(indent, method) {
     return this.methodHeaderDeclaration(indent, method, true);
   }
-
   declareStreamer(indent, method) {
     var bump = this.bumper(indent);
     return this.streamerSignature(indent, method) + this.encodePathParams(bump, method) + this.streamCall(bump, method) + "\n".concat(indent, "}");
   }
-
   reserve(name) {
-    if (!isSpecialName(name)) return name;
+    if (!(0, _sdkModels.isSpecialName)(name)) return name;
     return "'".concat(name, "'");
   }
-
   typeName(type) {
     type.refCount++;
-
-    if (type.customType && !(type instanceof EnumType)) {
+    if (type.customType && !(type instanceof _sdkModels.EnumType)) {
       return this.reserve("I".concat(type.name));
     }
-
     return this.reserve(type.name);
   }
-
   typeSignature(indent, type) {
-    var meta = type instanceof EnumType ? 'enum' : 'interface';
+    var meta = type instanceof _sdkModels.EnumType ? 'enum' : 'interface';
     return this.commentHeader(indent, type.description) + "".concat(indent, "export ").concat(meta, " ").concat(this.typeName(type), " ").concat(this.typeOpen, "\n");
   }
-
   errorResponses(_indent, method) {
     var results = method.errorResponses.map(r => "".concat(this.typeName(r.type)));
     return results.join(' | ');
   }
-
   httpPath(path, prefix) {
     prefix = prefix || '';
     if (path.indexOf('{') >= 0) return "`".concat(path.replace(/{/gi, '${' + prefix), "`");
     return "'".concat(path, "'");
   }
-
   argGroup(_indent, args, prefix) {
     if (!args || args.length === 0) return this.nullStr;
     var hash = [];
-
     for (var arg of args) {
       var reserved = this.reserve(arg);
-
       if (prefix) {
         hash.push("".concat(reserved, ": ").concat(this.accessor(arg, prefix)));
       } else {
         hash.push(reserved);
       }
     }
-
     return "{".concat(hash.join(this.argDelimiter), "}");
   }
-
   accessor(name, prefix) {
     var reserved = this.reserve(name);
     if (!prefix) return reserved;
     if (reserved === name) return "".concat(prefix, ".").concat(name);
     return "".concat(prefix, "[").concat(reserved, "]");
   }
-
   argList(indent, args, prefix) {
     prefix = prefix || '';
     var bits = args.map(a => this.accessor(a, prefix));
     return args && args.length !== 0 ? "\n".concat(indent).concat(bits.join(this.argDelimiter)) : this.nullStr;
   }
-
   argFill(current, args) {
     if (!current && args.trim() === this.nullStr) {
       return '';
     }
-
     return "".concat(args).concat(current ? this.argDelimiter : '').concat(current);
   }
-
   httpArgs(indent, method) {
     var request = this.useRequest(method) ? 'request' : '';
     var result = this.argFill('', 'options');
@@ -402,7 +315,6 @@ export class TypescriptGen extends CodeGen {
     result = this.argFill(result, this.argGroup(indent, method.queryArgs, request));
     return result;
   }
-
   httpCall(indent, method) {
     var request = this.useRequest(method) ? 'request.' : '';
     var mapped = this.typeMap(method.type);
@@ -411,7 +323,6 @@ export class TypescriptGen extends CodeGen {
     var errors = this.errorResponses(indent, method);
     return "".concat(indent, "return ").concat(this.it(method.httpMethod.toLowerCase())) + "<".concat(mapped.name, ", ").concat(errors, ">(") + this.httpPath(method.endpoint, request) + "".concat(args ? ', ' + args : '', ")");
   }
-
   streamCall(indent, method) {
     var request = this.useRequest(method) ? 'request.' : '';
     var mapped = this.typeMap(method.type);
@@ -419,11 +330,9 @@ export class TypescriptGen extends CodeGen {
     var args = this.httpArgs(bump, method);
     return "".concat(indent, "return ").concat(this.it('authStream'), "<").concat(mapped.name, ">(callback, '").concat(method.httpMethod.toUpperCase(), "', ").concat(this.httpPath(method.endpoint, request)).concat(args ? ', ' + args : '', ")");
   }
-
   summary(indent, text) {
     return this.commentHeader(indent, text);
   }
-
   typeNames() {
     var names = [];
     if (!this.api) return names;
@@ -431,13 +340,10 @@ export class TypescriptGen extends CodeGen {
     Object.values(types).filter(type => type.refCount > 0 && !type.intrinsic).forEach(type => names.push(this.typeName(type)));
     return names;
   }
-
   typeMap(type) {
     super.typeMap(type);
     var mt = '';
-
     var asString = (_, v) => "'".concat(v, "'");
-
     var tsTypes = {
       any: {
         default: mt,
@@ -513,24 +419,20 @@ export class TypescriptGen extends CodeGen {
         asVal: (_i, _v) => ''
       }
     };
-
     if (type.elementType) {
       var map = this.typeMap(type.elementType);
-
       switch (type.className) {
         case 'ArrayType':
           return {
             default: '[]',
             name: "".concat(map.name, "[]")
           };
-
         case 'HashType':
           this.rtlNeeds.add('IDictionary');
           return {
             default: '',
             name: "IDictionary<".concat(map.name, ">")
           };
-
         case 'DelimArrayType':
           this.rtlNeeds.add('DelimArray');
           return {
@@ -538,7 +440,6 @@ export class TypescriptGen extends CodeGen {
             name: "DelimArray<".concat(map.name, ">"),
             asVal: (_, v) => "new DelimArray<".concat(map.name, ">([").concat(v, "])")
           };
-
         case 'EnumType':
           return {
             default: '',
@@ -546,10 +447,8 @@ export class TypescriptGen extends CodeGen {
             asVal: (_, v) => "".concat(type.name, ".").concat(v)
           };
       }
-
       throw new Error("Don't know how to handle: ".concat(JSON.stringify(type)));
     }
-
     if (type.name) {
       var mapped = tsTypes[type.name];
       if (mapped && mapped.name === 'Url') this.rtlNeeds.add(mapped.name);
@@ -561,6 +460,6 @@ export class TypescriptGen extends CodeGen {
       throw new Error('Cannot output a nameless type.');
     }
   }
-
 }
+exports.TypescriptGen = TypescriptGen;
 //# sourceMappingURL=typescript.gen.js.map