Merge "Add @hidden tag to internals"

src/assistant.ts

@@ -26,6 +26,7 @@ export interface AppOptions {
   debug?: boolean
 }
 
+/** @hidden */
 export interface ServiceBaseApp {
   /** @public */
   handler: StandardHandler
@@ -51,6 +52,7 @@ export interface BaseApp extends ServiceBaseApp {
   debug: boolean
 }
 
+/** @hidden */
 const create = (options?: AppOptions): BaseApp => ({
   frameworks: Object.assign({}, builtin),
   handler: () => Promise.reject(new Error('StandardHandler not set')),
@@ -60,6 +62,7 @@ const create = (options?: AppOptions): BaseApp => ({
   debug: !!(options && options.debug),
 })
 
+/** @hidden */
 export const attach = <TService>(
   service: TService,
   options?: AppOptions,

src/common.ts

@@ -18,31 +18,44 @@ import * as Debug from 'debug'
 
 const name = 'actions-on-google'
 
+/** @hidden */
 export const debug = Debug(`${name}:debug`)
+
+/** @hidden */
 export const warn = Debug(`${name}:warn`)
 
+/** @hidden */
 export const error = console.error.bind(console) as typeof console.error
+
+/** @hidden */
 export const info = console.log.bind(console) as typeof console.log
 
 warn.log = error
 debug.log = info
 
+/** @hidden */
 export interface JsonObject {
   // tslint:disable-next-line:no-any JSON value can be anything
   [key: string]: any
 }
 
+/** @hidden */
 export const values = <T>(o: { [key: string]: T }) => Object.keys(o).map(k => o[k])
 
+/** @hidden */
 export const clone = <T>(o: T): T => JSON.parse(JSON.stringify(o))
 
+/** @hidden */
 export const stringify =
   (o: {}, override?: {}) => JSON.stringify(Object.assign(clone(o), override), null, 2)
 
+/** @hidden */
 export type ProtoAny<TType, TSpec> = { '@type': TType } & TSpec
 
+/** @hidden */
 export const toArray = <T>(a: T | T[]) => Array.isArray(a) ? a : [a]
 
+/** @hidden */
 export interface ApiClientObjectMap<TValue> {
   [key: string]: TValue
 }

src/framework/express.ts

@@ -27,6 +27,7 @@ export interface ExpressHandler {
   (request: Request, response: Response): void
 }
 
+/** @hidden */
 export class Express implements Framework<ExpressHandler> {
   handle(standard: StandardHandler) {
     return (request: Request, response: Response) => {
@@ -51,4 +52,5 @@ export class Express implements Framework<ExpressHandler> {
   }
 }
 
+/** @hidden */
 export const express = new Express()

src/framework/framework.ts

@@ -48,6 +48,7 @@ export interface BuiltinFrameworks extends Frameworks {
   lambda: Lambda
 }
 
+/** @hidden */
 export const builtin: BuiltinFrameworks = {
   express,
   lambda,

src/framework/lambda.ts

@@ -27,6 +27,7 @@ export interface LambdaHandler {
   (event: JsonObject, context: Context, callback: Callback): Promise<void>
 }
 
+/** @hidden */
 export class Lambda implements Framework<LambdaHandler> {
   handle(standard: StandardHandler) {
     return async (event: JsonObject, context: Context, callback: Callback) => {
@@ -58,4 +59,5 @@ export class Lambda implements Framework<LambdaHandler> {
   }
 }
 
+/** @hidden */
 export const lambda = new Lambda()

src/service/actionssdk/actionssdk.ts

@@ -51,6 +51,7 @@ export interface ActionsSdkIntentHandler<
   ): Promise<any> | any
 }
 
+/** @hidden */
 export interface ActionSdkIntentHandlers {
   [intent: string]: ActionsSdkIntentHandler<
     {},
@@ -60,6 +61,7 @@ export interface ActionSdkIntentHandlers {
   > | string | undefined
 }
 
+/** @hidden */
 export interface ActionsSdkHandlers<
   TConvData,
   TUserStorage,

src/service/actionssdk/conversation/argument/argument.ts

@@ -176,6 +176,7 @@ export interface ArgumentsParsed extends ArgumentsNamed {
   [name: string]: Argument | undefined
 }
 
+/** @hidden */
 export interface ArgumentsIndexable {
   [key: string]: Argument
 }

src/service/actionssdk/conversation/conversation.ts

@@ -81,17 +81,20 @@ export type Response =
   MediaObject |
   Question<Intent, JsonObject>
 
+/** @hidden */
 export interface ConversationResponse {
   richResponse: Api.GoogleActionsV2RichResponse
   expectUserResponse: boolean
   userStorage: string
   expectedIntent?: Api.GoogleActionsV2ExpectedIntent
 }
 
+/** @hidden */
 export interface ConversationOptionsInit<TUserStorage> {
   storage?: TUserStorage
 }
 
+/** @hidden */
 export interface ConversationOptions<TUserStorage> {
   request: Api.GoogleActionsV2AppRequest
   headers: Headers
@@ -376,6 +379,7 @@ export interface ExceptionHandler<
   (conv: TConversation, error: Error): Promise<any> | any
 }
 
+/** @hidden */
 export interface Traversed {
   [key: string]: boolean
 }

src/service/actionssdk/conversation/question/option/option.ts

@@ -57,8 +57,10 @@ export interface OptionItem {
   image?: Api.GoogleActionsV2UiElementsImage
 }
 
+/** @hidden */
 export interface ApiOptionItem extends Api.GoogleActionsV2UiElementsCarouselSelectCarouselItem { }
 
+/** @hidden */
 export const convert = (items: OptionItems) => Object.keys(items).map(key => {
   const value = items[key]
   if (typeof value === 'string') {

src/service/dialogflow/conv.ts

@@ -26,11 +26,13 @@ import { Incoming } from './incoming'
 const APP_DATA_CONTEXT = '_actions_on_google'
 const APP_DATA_CONTEXT_LIFESPAN = 99
 
+/** @hidden */
 export interface SystemIntent {
   intent: string
   data: ProtoAny<string, JsonObject>
 }
 
+/** @hidden */
 export interface GoogleAssistantResponse {
   expectUserResponse: boolean
   noInputPrompts?: ActionsApi.GoogleActionsV2SimpleResponse[]
@@ -40,6 +42,7 @@ export interface GoogleAssistantResponse {
   userStorage?: string
 }
 
+/** @hidden */
 export interface PayloadGoogle {
   google: GoogleAssistantResponse
 }

src/service/dialogflow/dialogflow.ts

@@ -50,6 +50,7 @@ export interface DialogflowIntentHandler<
   ): Promise<any> | any
 }
 
+/** @hidden */
 export interface DialogflowIntentHandlers {
   [event: string]: DialogflowIntentHandler<
     Contexts,
@@ -61,6 +62,7 @@ export interface DialogflowIntentHandlers {
   > | string | undefined
 }
 
+/** @hidden */
 export interface DialogflowHandlers<
   TConvData,
   TUserStorage,

typedoc.json

@@ -2,7 +2,8 @@
   "out": "docs",
   "exclude": [
     "**/_test/**/*.*",
-    "**/index.ts"
+    "**/index.ts",
+    "**/common.ts"
   ],
   "ignoreCompilerErrors": true,
   "disableOutputCheck": true,