refactor(action-menu): clearly mark public api (#1163)

Signed-off-by: Timo Glastra <[email protected]>

packages/action-menu/src/ActionMenuApi.ts

@@ -25,6 +25,9 @@ import {
 } from './handlers'
 import { ActionMenuService } from './services'
 
+/**
+ * @public
+ */
 @injectable()
 export class ActionMenuApi {
   private connectionService: ConnectionService

packages/action-menu/src/ActionMenuApiOptions.ts

@@ -1,25 +1,40 @@
 import type { ActionMenuRole } from './ActionMenuRole'
 import type { ActionMenu, ActionMenuSelection } from './models'
 
+/**
+ * @public
+ */
 export interface FindActiveMenuOptions {
   connectionId: string
   role: ActionMenuRole
 }
 
+/**
+ * @public
+ */
 export interface ClearActiveMenuOptions {
   connectionId: string
   role: ActionMenuRole
 }
 
+/**
+ * @public
+ */
 export interface RequestMenuOptions {
   connectionId: string
 }
 
+/**
+ * @public
+ */
 export interface SendMenuOptions {
   connectionId: string
   menu: ActionMenu
 }
 
+/**
+ * @public
+ */
 export interface PerformActionOptions {
   connectionId: string
   performedAction: ActionMenuSelection

packages/action-menu/src/ActionMenuEvents.ts

@@ -2,9 +2,16 @@ import type { ActionMenuState } from './ActionMenuState'
 import type { ActionMenuRecord } from './repository'
 import type { BaseEvent } from '@aries-framework/core'
 
+/**
+ * @public
+ */
 export enum ActionMenuEventTypes {
   ActionMenuStateChanged = 'ActionMenuStateChanged',
 }
+
+/**
+ * @public
+ */
 export interface ActionMenuStateChangedEvent extends BaseEvent {
   type: typeof ActionMenuEventTypes.ActionMenuStateChanged
   payload: {

packages/action-menu/src/ActionMenuModule.ts

@@ -7,6 +7,9 @@ import { ActionMenuRole } from './ActionMenuRole'
 import { ActionMenuRepository } from './repository'
 import { ActionMenuService } from './services'
 
+/**
+ * @public
+ */
 export class ActionMenuModule implements Module {
   public readonly api = ActionMenuApi
 

packages/action-menu/src/ActionMenuRole.ts

@@ -2,6 +2,7 @@
  * Action Menu roles based on the flow defined in RFC 0509.
  *
  * @see https://github.com/hyperledger/aries-rfcs/tree/main/features/0509-action-menu#roles
+ * @public
  */
 export enum ActionMenuRole {
   Requester = 'requester',

packages/action-menu/src/ActionMenuState.ts

@@ -2,6 +2,7 @@
  * Action Menu states based on the flow defined in RFC 0509.
  *
  * @see https://github.com/hyperledger/aries-rfcs/tree/main/features/0509-action-menu#states
+ * @public
  */
 export enum ActionMenuState {
   Null = 'null',

packages/action-menu/src/__tests__/ActionMenuModule.test.ts

@@ -2,13 +2,11 @@ import type { DependencyManager, FeatureRegistry } from '@aries-framework/core'
 
 import { Protocol } from '@aries-framework/core'
 
-import {
-  ActionMenuApi,
-  ActionMenuModule,
-  ActionMenuRepository,
-  ActionMenuRole,
-  ActionMenuService,
-} from '@aries-framework/action-menu'
+import { ActionMenuApi } from '../ActionMenuApi'
+import { ActionMenuModule } from '../ActionMenuModule'
+import { ActionMenuRole } from '../ActionMenuRole'
+import { ActionMenuRepository } from '../repository'
+import { ActionMenuService } from '../services'
 
 const dependencyManager = {
   registerInstance: jest.fn(),

packages/action-menu/src/errors/ActionMenuProblemReportError.ts

@@ -5,9 +5,16 @@ import { ProblemReportError } from '@aries-framework/core'
 
 import { ActionMenuProblemReportMessage } from '../messages'
 
+/**
+ * @internal
+ */
 interface ActionMenuProblemReportErrorOptions extends ProblemReportErrorOptions {
   problemCode: ActionMenuProblemReportReason
 }
+
+/**
+ * @internal
+ */
 export class ActionMenuProblemReportError extends ProblemReportError {
   public problemReport: ActionMenuProblemReportMessage
 

packages/action-menu/src/errors/ActionMenuProblemReportReason.ts

@@ -2,6 +2,7 @@
  * Action Menu errors discussed in RFC 0509.
  *
  * @see https://github.com/hyperledger/aries-rfcs/tree/main/features/0509-action-menu#unresolved-questions
+ * @internal
  */
 export enum ActionMenuProblemReportReason {
   Timeout = 'timeout',

packages/action-menu/src/handlers/ActionMenuProblemReportHandler.ts

@@ -3,6 +3,9 @@ import type { Handler, HandlerInboundMessage } from '@aries-framework/core'
 
 import { ActionMenuProblemReportMessage } from '../messages'
 
+/**
+ * @internal
+ */
 export class ActionMenuProblemReportHandler implements Handler {
   private actionMenuService: ActionMenuService
   public supportedMessages = [ActionMenuProblemReportMessage]

packages/action-menu/src/handlers/MenuMessageHandler.ts

@@ -3,6 +3,9 @@ import type { Handler, HandlerInboundMessage } from '@aries-framework/core'
 
 import { MenuMessage } from '../messages'
 
+/**
+ * @internal
+ */
 export class MenuMessageHandler implements Handler {
   private actionMenuService: ActionMenuService
   public supportedMessages = [MenuMessage]

packages/action-menu/src/handlers/MenuRequestMessageHandler.ts

@@ -3,6 +3,9 @@ import type { Handler, HandlerInboundMessage } from '@aries-framework/core'
 
 import { MenuRequestMessage } from '../messages'
 
+/**
+ * @internal
+ */
 export class MenuRequestMessageHandler implements Handler {
   private actionMenuService: ActionMenuService
   public supportedMessages = [MenuRequestMessage]

packages/action-menu/src/handlers/PerformMessageHandler.ts

@@ -3,6 +3,9 @@ import type { Handler, HandlerInboundMessage } from '@aries-framework/core'
 
 import { PerformMessage } from '../messages'
 
+/**
+ * @internal
+ */
 export class PerformMessageHandler implements Handler {
   private actionMenuService: ActionMenuService
   public supportedMessages = [PerformMessage]

packages/action-menu/src/index.ts

@@ -4,7 +4,5 @@ export * from './ActionMenuModule'
 export * from './ActionMenuEvents'
 export * from './ActionMenuRole'
 export * from './ActionMenuState'
-export * from './messages'
 export * from './models'
-export * from './repository'
-export * from './services'
+export * from './repository/ActionMenuRecord'

packages/action-menu/src/messages/ActionMenuProblemReportMessage.ts

@@ -6,6 +6,7 @@ export type ActionMenuProblemReportMessageOptions = ProblemReportMessageOptions
 
 /**
  * @see https://github.com/hyperledger/aries-rfcs/blob/main/features/0035-report-problem/README.md
+ * @internal
  */
 export class ActionMenuProblemReportMessage extends ProblemReportMessage {
   /**

packages/action-menu/src/messages/MenuMessage.ts

@@ -6,6 +6,9 @@ import { IsInstance, IsOptional, IsString } from 'class-validator'
 
 import { ActionMenuOption } from '../models'
 
+/**
+ * @internal
+ */
 export interface MenuMessageOptions {
   id?: string
   title: string
@@ -15,6 +18,9 @@ export interface MenuMessageOptions {
   threadId?: string
 }
 
+/**
+ * @internal
+ */
 export class MenuMessage extends AgentMessage {
   public constructor(options: MenuMessageOptions) {
     super()

packages/action-menu/src/messages/MenuRequestMessage.ts

@@ -1,9 +1,15 @@
 import { AgentMessage, IsValidMessageType, parseMessageType } from '@aries-framework/core'
 
+/**
+ * @internal
+ */
 export interface MenuRequestMessageOptions {
   id?: string
 }
 
+/**
+ * @internal
+ */
 export class MenuRequestMessage extends AgentMessage {
   public constructor(options: MenuRequestMessageOptions) {
     super()

packages/action-menu/src/messages/PerformMessage.ts

@@ -1,13 +1,19 @@
 import { AgentMessage, IsValidMessageType, parseMessageType } from '@aries-framework/core'
 import { IsOptional, IsString } from 'class-validator'
 
+/**
+ * @internal
+ */
 export interface PerformMessageOptions {
   id?: string
   name: string
   params?: Record<string, string>
   threadId: string
 }
 
+/**
+ * @internal
+ */
 export class PerformMessage extends AgentMessage {
   public constructor(options: PerformMessageOptions) {
     super()

packages/action-menu/src/models/ActionMenu.ts

@@ -5,12 +5,18 @@ import { IsInstance, IsString } from 'class-validator'
 
 import { ActionMenuOption } from './ActionMenuOption'
 
+/**
+ * @public
+ */
 export interface ActionMenuOptions {
   title: string
   description: string
   options: ActionMenuOptionOptions[]
 }
 
+/**
+ * @public
+ */
 export class ActionMenu {
   public constructor(options: ActionMenuOptions) {
     if (options) {

packages/action-menu/src/models/ActionMenuOption.ts

@@ -5,6 +5,9 @@ import { IsBoolean, IsInstance, IsOptional, IsString } from 'class-validator'
 
 import { ActionMenuForm } from './ActionMenuOptionForm'
 
+/**
+ * @public
+ */
 export interface ActionMenuOptionOptions {
   name: string
   title: string
@@ -13,6 +16,9 @@ export interface ActionMenuOptionOptions {
   form?: ActionMenuFormOptions
 }
 
+/**
+ * @public
+ */
 export class ActionMenuOption {
   public constructor(options: ActionMenuOptionOptions) {
     if (options) {

packages/action-menu/src/models/ActionMenuOptionForm.ts

@@ -5,12 +5,18 @@ import { IsInstance, IsString } from 'class-validator'
 
 import { ActionMenuFormParameter } from './ActionMenuOptionFormParameter'
 
+/**
+ * @public
+ */
 export interface ActionMenuFormOptions {
   description: string
   params: ActionMenuFormParameterOptions[]
   submitLabel: string
 }
 
+/**
+ * @public
+ */
 export class ActionMenuForm {
   public constructor(options: ActionMenuFormOptions) {
     if (options) {

packages/action-menu/src/models/ActionMenuOptionFormParameter.ts

@@ -1,9 +1,15 @@
 import { IsBoolean, IsEnum, IsOptional, IsString } from 'class-validator'
 
+/**
+ * @public
+ */
 export enum ActionMenuFormInputType {
   Text = 'text',
 }
 
+/**
+ * @public
+ */
 export interface ActionMenuFormParameterOptions {
   name: string
   title: string
@@ -13,6 +19,9 @@ export interface ActionMenuFormParameterOptions {
   type?: ActionMenuFormInputType
 }
 
+/**
+ * @public
+ */
 export class ActionMenuFormParameter {
   public constructor(options: ActionMenuFormParameterOptions) {
     if (options) {

packages/action-menu/src/models/ActionMenuSelection.ts

@@ -1,10 +1,16 @@
 import { IsOptional, IsString } from 'class-validator'
 
+/**
+ * @public
+ */
 export interface ActionMenuSelectionOptions {
   name: string
   params?: Record<string, string>
 }
 
+/**
+ * @public
+ */
 export class ActionMenuSelection {
   public constructor(options: ActionMenuSelectionOptions) {
     if (options) {

packages/action-menu/src/repository/ActionMenuRecord.ts

@@ -7,6 +7,9 @@ import { Type } from 'class-transformer'
 
 import { ActionMenuSelection, ActionMenu } from '../models'
 
+/**
+ * @public
+ */
 export interface ActionMenuRecordProps {
   id?: string
   state: ActionMenuState
@@ -19,14 +22,23 @@ export interface ActionMenuRecordProps {
   tags?: CustomActionMenuTags
 }
 
+/**
+ * @public
+ */
 export type CustomActionMenuTags = TagsBase
 
+/**
+ * @public
+ */
 export type DefaultActionMenuTags = {
   role: ActionMenuRole
   connectionId: string
   threadId: string
 }
 
+/**
+ * @public
+ */
 export class ActionMenuRecord
   extends BaseRecord<DefaultActionMenuTags, CustomActionMenuTags>
   implements ActionMenuRecordProps

packages/action-menu/src/repository/ActionMenuRepository.ts

@@ -2,6 +2,9 @@ import { EventEmitter, InjectionSymbols, inject, injectable, Repository, Storage
 
 import { ActionMenuRecord } from './ActionMenuRecord'
 
+/**
+ * @internal
+ */
 @injectable()
 export class ActionMenuRepository extends Repository<ActionMenuRecord> {
   public constructor(