@aws/mynah-ui 1.0.0

package/dist/static.d.ts

@@ -0,0 +1,276 @@
+/*!
+ * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export interface ServiceConnector {
+    liveSearchHandler?: (searchPayload?: SearchPayload, suggestions?: Suggestion[]) => void;
+    liveSearchStateExternalChangeHandler?: (state: LiveSearchState) => void;
+    uiReady: () => void;
+    once: () => Promise<Suggestion[]>;
+    requestSuggestions: (searchPayload: SearchPayload, isFromHistory?: boolean, isFromAutocomplete?: boolean) => Promise<Suggestion[] | undefined>;
+    updateVoteOfSuggestion: (suggestion: Suggestion, vote: RelevancyVoteType) => void;
+    clickCodeDetails: (code: string, fileName?: string, range?: {
+        start: {
+            row: string;
+            column?: string;
+        };
+        end?: {
+            row: string;
+            column?: string;
+        };
+    }) => void;
+    recordContextChange: (changeType: ContextChangeType, queryContext: ContextType) => void;
+    triggerSuggestionEngagement: (engagement: SuggestionEngagement) => void;
+    triggerSuggestionClipboardInteraction: (suggestionId: string, type?: string, text?: string) => void;
+    triggerSuggestionEvent: (eventName: SuggestionEventName, suggestion: Suggestion) => void;
+    sendFeedback: (feedbackPayload: FeedbackPayload) => void;
+    requestHistoryRecords: (filterPayload: SearchHistoryFilters) => Promise<SearchHistoryItem[]>;
+    requestAutocomplete: (input: string) => Promise<AutocompleteItem[]>;
+    toggleLiveSearch?: (liveSearchState: LiveSearchState, onFeedReceived: (searchPayload?: SearchPayload, suggestions?: Suggestion[]) => void) => void;
+    clickAutocompleteSuggestionItem: (text: string, currSelected?: number, suggestionCount?: number) => void;
+}
+export interface StateManager {
+    getState: () => Record<string, any>;
+    setState: (state: Record<string, any>) => void;
+}
+export declare const MynahEventNames: {
+    CONTEXT_VISIBILITY_CHANGE: string;
+    REMOVE_ALL_CONTEXT: string;
+};
+export declare const MynahPortalNames: {
+    WRAPPER: string;
+    OVERLAY: string;
+    FEEDBACK_FORM: string;
+};
+export interface SearchPayloadMatchPolicy {
+    must: string[];
+    should: string[];
+    mustNot: string[];
+}
+export interface SearchPayloadCodeSelection {
+    selectedCode: string;
+    file?: {
+        range: {
+            start: {
+                row: string;
+                column: string;
+            };
+            end: {
+                row: string;
+                column: string;
+            };
+        };
+        name: string;
+    };
+}
+export interface SearchPayloadCodeQuery {
+    simpleNames: string[];
+    usedFullyQualifiedNames: string[];
+}
+export interface SearchPayload {
+    query: string;
+    matchPolicy: SearchPayloadMatchPolicy;
+    codeSelection: SearchPayloadCodeSelection;
+    codeQuery?: SearchPayloadCodeQuery;
+}
+export interface SuggestionMetaData {
+    site: string;
+    stars?: number;
+    forks?: number;
+    answers?: number;
+    isAccepted?: boolean;
+    upVotes?: number;
+    lastActivityDate?: number;
+}
+export interface Suggestion {
+    id: string;
+    title: string;
+    url: string;
+    body: string;
+    context: string[];
+    type?: string;
+    metaData?: SuggestionMetaData;
+}
+export declare enum KeyMap {
+    ESCAPE = "Escape",
+    ENTER = "Enter",
+    BACKSPACE = "Backspace",
+    DELETE = "Delete",
+    ARROW_UP = "ArrowUp",
+    ARROW_DOWN = "ArrowDown",
+    ARROW_LEFT = "ArrowLeft",
+    ARROW_RIGHT = "ArrowRight",
+    PAGE_UP = "PageUp",
+    PAGED_OWN = "PageDown",
+    HOME = "Home",
+    END = "End",
+    META = "Meta",
+    TAB = "Tab",
+    SHIFT = "Shift",
+    CONTROL = "Control",
+    ALT = "Alt"
+}
+export declare enum LiveSearchState {
+    PAUSE = "pauseLiveSearch",
+    RESUME = "resumeLiveSearch",
+    STOP = "stopLiveSearch"
+}
+export declare const SupportedCodingLanguages: string[];
+declare type ElementType<T extends readonly unknown[]> = T extends ReadonlyArray<infer ElementType> ? ElementType : never;
+export declare type SupportedCodingLanguagesType = ElementType<typeof SupportedCodingLanguages>;
+export declare const SupportedCodingLanguagesExtensionToTypeMap: {
+    ts: string;
+    js: string;
+    py: string;
+    java: string;
+    json: string;
+};
+export declare type OnCopiedToClipboardFunction = (type?: 'selection' | 'block', text?: string) => void;
+export declare type OnCopiedToClipboardFunctionWithSuggestionId = (suggestionId: string, type?: 'selection' | 'block', text?: string) => void;
+export interface SearchHistoryFilters {
+    /**
+       * Flag to define are we looking in global search-history or only in worplace
+       *
+       * @default - Search will be performed on workplace store
+       */
+    isGlobal: boolean;
+    /**
+       * Flag to define are we looking only for queries which were manually typed by the user,
+       * or only for quries whic were generated by plugin itself, or it's not important
+       *
+       * @default - We won't filter records bases on type of input
+       */
+    isManualSearch?: boolean;
+    /**
+       * Array of language filters. If user chose some, the results would be filtered
+       *
+       * @default - We won't filter records bases on languages
+       */
+    languages: string[];
+    /**
+       * User text from search bar in search-history part of UI
+       *
+       * @default - We won't filter records bases on user input in search-history search bar
+       */
+    text?: string;
+    /**
+       * Allow us to skip n-first results
+       *
+       * @default - The starting offset will be 0
+       */
+    resultOffset: number;
+    /**
+       * Limit of how many results we want to get from store
+       *
+       * @default - The records count won't be limited
+       */
+    resultLimit?: number;
+}
+export interface CodeQuery {
+    simpleNames: string[];
+    usedFullyQualifiedNames: string[];
+}
+export declare enum ContextChangeType {
+    'ADD' = "add",
+    'REMOVE' = "remove"
+}
+export declare enum SuggestionEventName {
+    CLICK = "click",
+    OPEN = "openSuggestion",
+    COPY = "copy"
+}
+export declare enum RelevancyVoteType {
+    UP = "upvote",
+    DOWN = "downvote"
+}
+/**
+ * 'interaction' will be set if there was a potential text selection or a click input was triggered by the user.
+ *  If this is a selection selectionDistanceTraveled object will also be filled
+ * 'timespend' will be set basically if there is no interaction except mouse movements in a time spent longer than the ENGAGEMENT_DURATION_LIMIT
+ *  Don't forget that in 'timespend' case, user should leave the suggestion card at some point to count it as an interaction.
+ *  (They need to go back to the code or move to another card instead)
+ */
+export declare enum EngagementType {
+    INTERACTION = "interaction",
+    TIME = "timespend"
+}
+export interface SuggestionEngagement {
+    /**
+       * Suggestion information
+       */
+    suggestion: Suggestion;
+    /**
+       * Engagement type
+       */
+    engagementType: EngagementType;
+    /**
+       * Total duration in ms till the engagement triggered.
+       */
+    engagementDurationTillTrigger: number;
+    /**
+       * This is a little bit more than what you might expect on a normal scroll position of the suggestion card.
+       * This attribute gives the value for how much the users traveled their mouses and additionally how much they scrolled to focus on that suggestion
+       */
+    scrollDistanceToEngage: number;
+    /**
+       * Total mouse movement in x and y directions till the engagament triggered.
+       * To avoid confusion: this is not the distance between start and end points, this is the total traveled distance.
+       */
+    totalMouseDistanceTraveled: {
+        x: number;
+        y: number;
+    };
+    /**
+       * If the engagementType is "interaction" and this object has a value, you can assume it as a text selection.
+       * If the engagementType is "interaction" but this object is not defined, you can assume it as a click
+       */
+    selectionDistanceTraveled?: {
+        x: number;
+        y: number;
+        selectedText?: string;
+    };
+}
+export interface SearchHistoryItem {
+    query: {
+        input: string;
+        queryContext: SearchPayloadMatchPolicy;
+        queryId?: string;
+        trigger: string;
+        codeQuery: CodeQuery;
+        codeSelection: SearchPayloadCodeSelection;
+    };
+    recordDate?: number;
+    suggestions: Suggestion[];
+}
+export declare enum ContextTypes {
+    MUST = "must",
+    SHOULD = "should",
+    MUST_NOT = "mustNot"
+}
+export declare enum ContextSource {
+    AUTO = "auto",
+    USER = "user",
+    SUGGESTION = "suggestion"
+}
+export declare enum ContextTypeClassNames {
+    should = "mynah-should-contain",
+    must = "mynah-must-contain",
+    mustNot = "mynah-must-not-contain"
+}
+export interface ContextType {
+    context: string;
+    type?: ContextTypes;
+    availableInSuggestion?: boolean;
+    visible?: boolean;
+    source: ContextSource;
+}
+export declare type FeedbackStars = 1 | 2 | 3 | 4 | 5;
+export interface FeedbackPayload {
+    stars?: FeedbackStars;
+    comment?: string;
+}
+export interface AutocompleteItem {
+    suggestion: string;
+    highlight: string;
+}
+export {};

package/dist/translations/en.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+declare const en: {
+    searchInputAPIHelpPlaceholder: string;
+    searchInputMynahPlaceholder: string;
+};
+export default en;

package/dist/translations/i18n.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2022 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+export declare class I18N {
+    private static instance;
+    texts: {
+        searchInputAPIHelpPlaceholder: string;
+        searchInputMynahPlaceholder: string;
+    };
+    private constructor();
+    static getInstance(localLanguage?: string): I18N;
+}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@aws/mynah-ui",
+  "displayName": "AWS Mynah UI",
+  "version": "1.0.0",
+  "description": "AWS Tookit VSCode and Intellij IDE Extension Mynah UI",
+  "publisher": "Amazon Web Services",
+  "license": "Apache License 2.0",
+  "readme": "README.md",
+  "main": "./dist/main.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aws/mynah-ui"
+  },
+  "scripts": {
+    "clean": "rm -rf dist node_modules",
+    "build": "rm -rf dist && webpack --config webpack.config.js --mode production",
+    "watch": "webpack --config webpack.config.js --mode development --watch",
+    "lint-fix": "npx eslint \"./**\" --fix",
+    "lint": "npx eslint \"./**\""
+  },
+  "dependencies": {
+    "i18n-ts": "1.0.5",
+    "prismjs": "1.29.0"
+  },
+  "devDependencies": {
+    "@types/eslint": "7.2.13",
+    "@types/eslint-scope": "3.7.0",
+    "@types/estree": "0.0.49",
+    "@types/glob": "7.1.3",
+    "@types/json-schema": "7.0.7",
+    "@types/node": "12.20.12",
+    "@types/prismjs": "1.26.0",
+    "@typescript-eslint/eslint-plugin": "5.34.0",
+    "css-loader": "6.6.0",
+    "eslint": "8.22.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-standard-with-typescript": "22.0.0",
+    "eslint-plugin-header": "^3.1.1",
+    "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-n": "15.2.5",
+    "eslint-plugin-no-null": "^1.0.2",
+    "eslint-plugin-promise": "6.0.0",
+    "sass": "1.49.8",
+    "sass-loader": "12.6.0",
+    "style-loader": "3.3.1",
+    "ts-loader": "9.2.6",
+    "ts-node": "10.4.0",
+    "typescript": "4.5.2",
+    "webpack": "5.42.0",
+    "webpack-cli": "4.7.2"
+  },
+  "prettier": {
+    "printWidth": 120,
+    "trailingComma": "es5",
+    "tabWidth": 4,
+    "singleQuote": true,
+    "semi": false,
+    "bracketSpacing": true,
+    "arrowParens": "avoid",
+    "endOfLine": "lf"
+  }
+}