@atlaskit/teams-public 0.2.0 → 0.3.1

package/dist/types/common/utils/http.d.ts

@@ -0,0 +1,31 @@
+export declare const EXPONENTIAL_BACKOFF_RETRY_POLICY: {
+    INITIAL_DELAY: number;
+    MAX_RETRIES: number;
+    JITTER: boolean;
+};
+/**
+ * Checks whether a status code is a 5xx HTTP code.
+ * @param {number} status HTTP status code
+ */
+export declare function is5xx(status: number): boolean;
+export declare function isFetchResponse(data: unknown): data is {
+    response: Response;
+};
+type ToTryFunctionArgs = any[];
+type ToTryFunction<T> = (...args: ToTryFunctionArgs) => Promise<T>;
+type RetryIfCallback<T> = (a: T) => boolean;
+interface WithExponentialBackoffOptions<T> {
+    initial: number;
+    jitter?: boolean;
+    max: number;
+    retryIf?: RetryIfCallback<T>;
+}
+/**
+ * Transparently wrap a function so that it is retried until it succeeds or reaches a max retry limit.
+ * The returned function has the same signature as the wrapped function.
+ *
+ * Modified from https://jsfiddle.net/pajtai/pLka0ow9/
+ */
+export declare function withExponentialBackoff<ResponseType>(toTry: ToTryFunction<ResponseType>, hofOptions?: WithExponentialBackoffOptions<ResponseType>): (...args: ToTryFunctionArgs) => Promise<ResponseType>;
+export declare const fetchWithExponentialBackoff: (...args: ToTryFunctionArgs) => Promise<Response>;
+export {};

package/dist/types/common/utils/status-code-handlers-provider.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Our REST clients are initialised when their module loads which makes it tricky for them to consume the `statusCodeHandlers` prop passed to App from the host application.
+ * This is a temporary measure to enable the clients to consume `statusCodeHandlers`.
+ * The long term solution is to replace our REST clients with Apollo client custom resolvers
+ * This will unify all remote data handling under the apollo-client module which is able to easily receive `statusCodeHandlers` as it is initialised within the React portion of our app.
+ */
+type StatusCodeHandler = (response: Response) => void;
+export interface StatusCodeHandlerMap {
+    [statusCode: number]: StatusCodeHandler;
+}
+export declare const statusCodeHandlersProvider: {
+    handlers: StatusCodeHandlerMap;
+    get(): StatusCodeHandlerMap;
+    setHandlers(handlers: StatusCodeHandlerMap): void;
+};
+export declare function handleResponse(response: Response): void;
+export {};

package/dist/types/common/utils/team-id-to-ari.d.ts

@@ -0,0 +1,2 @@
+export declare const ARI_PREFIX = "ari:cloud:identity::team/";
+export declare const teamIdToAri: (teamIdOrTeamAri: string) => string;

package/dist/types/controllers/hooks/use-team-containers/index.d.ts

@@ -0,0 +1,12 @@
+import { type Action } from 'react-sweet-state';
+import { type TeamContainers } from '../../../services/types';
+type State = {
+    teamContainers: TeamContainers;
+    loading: boolean;
+    error: Error | null;
+};
+export declare const useTeamContainersHook: import("react-sweet-state").HookFunction<State, import("react-sweet-state").BoundActions<State, {
+    fetchTeamContainers: (teamId: string) => Action<State>;
+}>, void>;
+export declare const useTeamContainers: (teamId: string) => State;
+export {};

package/dist/types/controllers/index.d.ts

@@ -0,0 +1 @@
+export { useTeamContainers } from './hooks/use-team-containers';

package/dist/types/services/agg-client/index.d.ts

@@ -0,0 +1,15 @@
+import { type ClientConfig } from '../base-client';
+import { BaseGraphQlClient } from '../graphql-client';
+export declare class AGGClient extends BaseGraphQlClient {
+    constructor(baseUrl: string, config: ClientConfig);
+    setBaseUrl(baseUrl: string): void;
+    getTeamContainers(teamId: string): Promise<{
+        id: string;
+        type: "ConfluenceSpace" | "JiraProject";
+        name: string;
+        icon: string;
+        createdDate: Date;
+        link: string;
+    }[]>;
+}
+export declare const aggClient: AGGClient;

package/dist/types/services/agg-client/mocks/index.d.ts

@@ -0,0 +1,55 @@
+export declare const MOCK_TEAM_CONTAINERS: {
+    graphStore: {
+        cypherQuery: {
+            edges: ({
+                node: {
+                    from: {
+                        id: string;
+                    };
+                    to: {
+                        id: string;
+                        data: {
+                            __typename: string;
+                            confluenceSpaceName: string;
+                            type: string;
+                            createdDate: string;
+                            links: {
+                                webUi: string;
+                            };
+                            icon: {
+                                path: string;
+                            };
+                            jiraProjectName?: undefined;
+                            webUrl?: undefined;
+                            created?: undefined;
+                            avatar?: undefined;
+                        };
+                    };
+                };
+            } | {
+                node: {
+                    from: {
+                        id: string;
+                    };
+                    to: {
+                        id: string;
+                        data: {
+                            __typename: string;
+                            jiraProjectName: string;
+                            webUrl: string;
+                            created: string;
+                            avatar: {
+                                medium: string;
+                            };
+                            confluenceSpaceName?: undefined;
+                            type?: undefined;
+                            createdDate?: undefined;
+                            links?: undefined;
+                            icon?: undefined;
+                        };
+                    };
+                };
+            })[];
+        };
+    };
+};

package/dist/types/services/agg-client/utils/queries/team-containers-query.d.ts

@@ -0,0 +1,44 @@
+export declare const TeamContainersQuery: string;
+export type TeamContainersQueryVariables = {
+    cypherQuery: string;
+};
+export type TeamContainersQueryResponse = {
+    cypherQuery: {
+        edges: Array<{
+            node: {
+                from: {
+                    id: string;
+                };
+                to: {
+                    id: string;
+                    data: JiraProject | ConfluenceSpace;
+                };
+            };
+        }>;
+    };
+};
+type JiraProject = {
+    __typename: 'JiraProject';
+    id: string;
+    jiraProjectName: string;
+    webUrl: string;
+    created: string;
+    avatar: {
+        medium: string;
+    };
+};
+type ConfluenceSpace = {
+    __typename: 'ConfluenceSpace';
+    id: string;
+    confluenceSpaceName?: string;
+    type: string;
+    createdDate: string;
+    links: {
+        base: string;
+        webUi: string;
+    };
+    icon: {
+        path: string;
+    };
+};
+export {};

package/dist/types/services/base-client/index.d.ts

@@ -0,0 +1,37 @@
+import { type ClientContext, type ClientContextProps } from '../types';
+type NestedContext = {
+    [key: string]: string | number | boolean | NestedContext;
+};
+export type LogExceptionFN = (ex: unknown | Error, name: string, context?: NestedContext & {
+    tags?: Record<string, string>;
+}) => void;
+export type ClientConfig = {
+    logException: LogExceptionFN;
+};
+export declare class BaseClient {
+    private config;
+    private context;
+    private cache;
+    constructor(config: ClientConfig);
+    setContext(context: ClientContextProps): void;
+    getContext(): ClientContext;
+    /**
+     *
+     * @param localValue is used for backwards compatibility
+     * @returns
+     */
+    getOrgId(localValue?: string): string;
+    /**
+     *
+     * @param localValue is used for backwards compatibility
+     * @returns
+     */
+    getCloudId(localValue?: string): string | null | undefined;
+    logException: (ex: unknown | Error, name: string, context?: NestedContext & {
+        tags?: Record<string, string>;
+    }) => void;
+    private keyWithContext;
+    cacheValue<T>(key: string, value: T, expiryMs?: number): void;
+    getCachedValue<T>(key: string): T | undefined;
+}
+export {};

package/dist/types/services/constants.d.ts

@@ -0,0 +1,4 @@
+export interface TeamsConfig {
+    stargateRoot: string;
+}
+export declare const DEFAULT_CONFIG: TeamsConfig;

package/dist/types/services/graphql-client/index.d.ts

@@ -0,0 +1 @@
+export { BaseGraphQlClient } from './main';

package/dist/types/services/graphql-client/main.d.ts

@@ -0,0 +1,8 @@
+import { BaseClient, type ClientConfig } from '../base-client';
+import { type Body, type Options, type ResultResponse } from './types';
+export declare class BaseGraphQlClient extends BaseClient {
+    private serviceUrl;
+    constructor(serviceUrl: string, config: ClientConfig);
+    setServiceUrl(serviceUrl: string): void;
+    makeGraphQLRequest<Key extends string, Data = unknown, Variables = unknown>(body: Body<Variables>, options?: Options): Promise<ResultResponse<Key, Data>>;
+}

package/dist/types/services/graphql-client/types.d.ts

@@ -0,0 +1,19 @@
+import { type ErrorData } from '../../common/utils/error';
+export interface Options {
+    operationName?: string;
+    errorPolicy?: 'none' | 'all' | 'ignore';
+}
+export type InnerResponse<T> = {
+    data: T;
+    errors?: ErrorData[];
+};
+export type ResultResponse<Key extends string, Data> = {
+    [name in Key]: Data;
+};
+export type Body<Variables> = {
+    query: string;
+    variables?: Variables;
+};
+export type GraphQLRequestDataResponse<Data> = Data | {
+    response: Response;
+};

package/dist/types/services/graphql-client/utils/index.d.ts

@@ -0,0 +1,3 @@
+import { type Body, type GraphQLRequestDataResponse, type Options, type ResultResponse } from '../types';
+export declare function makeGraphQLRequestWithoutRetries<Data, Variables>(serviceUrl: string, body: Body<Variables>, options?: Options): Promise<GraphQLRequestDataResponse<Data>>;
+export declare function handleGraphQLRequest<Key extends string, Data = unknown, Variables = unknown>(serviceUrl: string, body: Body<Variables>, options?: Options): Promise<ResultResponse<Key, Data>>;

package/dist/types/services/index.d.ts

@@ -0,0 +1 @@
+export { teamsClient, TeamsClient } from './main';

package/dist/types/services/main.d.ts

@@ -0,0 +1,25 @@
+import { type ClientContextProps, type TeamContainers } from './types';
+export declare class TeamsClient {
+    private readonly _aggClient;
+    constructor(
+    /**
+     * @param {ClientContextProps} context - Context including CloudId & OrgId to be used for all requests
+     */
+    context?: ClientContextProps);
+    /**
+     * Sets the base URL to be used in the client requests
+     * @param {string} baseUrl - The new base URL
+     */
+    setBaseUrl(baseUrl: string): void;
+    /**
+     * Sets context including CloudId & OrgId to be used for all requests
+     */
+    setContext(context: ClientContextProps): void;
+    /**
+     * Get the containers for a given team
+     * @param {string} teamId
+     * @returns {Promise<TeamContainers>}
+     */
+    getTeamContainers(teamId: string): Promise<TeamContainers>;
+}
+export declare const teamsClient: TeamsClient;

package/dist/types/services/types.d.ts

@@ -0,0 +1,19 @@
+import { type ContainerTypes } from '../common/types';
+export type ClientContext = {
+    cloudId?: string | null;
+    orgId?: string;
+    userId?: string;
+};
+export type ClientContextProps = {
+    cloudId?: string | null;
+    orgId?: string;
+    userId?: string;
+};
+export type TeamContainers = Array<{
+    id: string;
+    type: ContainerTypes;
+    name: string;
+    icon: string;
+    createdDate: Date;
+    link: string;
+}>;

package/dist/types/ui/team-containers/add-container-card/index.d.ts

@@ -1,7 +1,8 @@
-/// <reference types="react" />
+import React from 'react';
 import { type ContainerTypes } from '../../../common/types';
 interface AddContainerCardProps {
     containerType: ContainerTypes;
+    onAddAContainerClick: (e: React.MouseEvent<HTMLButtonElement>) => void;
 }
-export declare const AddContainerCard: ({ containerType }: AddContainerCardProps) => JSX.Element;
+export declare const AddContainerCard: ({ containerType, onAddAContainerClick, }: AddContainerCardProps) => React.JSX.Element;
 export {};

package/dist/types/ui/team-containers/linked-container-card/index.d.ts

@@ -1,13 +1,10 @@
-/**
- * @jsxRuntime classic
- * @jsx jsx
- */
-/// <reference types="react" />
+import React from 'react';
 import { type ContainerTypes } from '../../../common/types';
 interface LinkedContainerCardProps {
     containerType: ContainerTypes;
     title: string;
     containerIcon: string;
+    link: string;
 }
-export declare const LinkedContainerCard: ({ containerType, title, containerIcon, }: LinkedContainerCardProps) => JSX.Element;
+export declare const LinkedContainerCard: ({ containerType, title, containerIcon, link, }: LinkedContainerCardProps) => React.JSX.Element;
 export {};

package/dist/types/ui/team-containers/main.d.ts

@@ -1,4 +1,6 @@
 import React from 'react';
+import { type TeamContainerProps } from './types';
 export declare const ICON_BACKGROUND: "var(--ds-icon-inverse)";
 export declare const ICON_COLOR: "var(--ds-icon-subtle)";
-export declare const TeamContainers: () => React.JSX.Element;
+export declare const MAX_NUMBER_OF_CONTAINERS_TO_SHOW = 4;
+export declare const TeamContainers: ({ teamId, onAddAContainerClick }: TeamContainerProps) => React.JSX.Element;

package/dist/types/ui/team-containers/team-containers-skeleton/index.d.ts

@@ -0,0 +1,6 @@
+import React from 'react';
+interface TeamContainersSkeletonProps {
+    numberOfContainers: number;
+}
+export declare const TeamContainersSkeleton: ({ numberOfContainers }: TeamContainersSkeletonProps) => React.JSX.Element;
+export {};

package/dist/types/ui/team-containers/team-containers-skeleton/linked-container-card-skeleton/index.d.ts

@@ -0,0 +1,2 @@
+import React from 'react';
+export declare const LinkedContainerCardSkeleton: () => React.JSX.Element;

package/dist/types/ui/team-containers/types.d.ts

@@ -1,6 +1,11 @@
+/// <reference types="react" />
 export interface TeamContainerProps {
     /**
      * The team id to fetch the team container for
      */
     teamId: string;
+    /**
+     * The function to call when the add a container button is clicked
+     */
+    onAddAContainerClick: (e: React.MouseEvent<HTMLButtonElement>) => void;
 }

package/dist/types-ts4.5/common/types.d.ts

@@ -1 +1 @@
-export type ContainerTypes = 'confluence' | 'jira' | 'loom';
+export type ContainerTypes = 'ConfluenceSpace' | 'JiraProject';

package/dist/types-ts4.5/common/utils/error/index.d.ts

@@ -0,0 +1,59 @@
+export declare enum StatusCode {
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    TIMEOUT = 408,
+    GONE = 410,
+    PAYLOAD_TOO_LARGE = 413
+}
+declare class CommonError extends Error {
+    message: string;
+    name: string;
+    stack: string;
+    constructor(message?: string);
+}
+export declare class DefaultError extends CommonError {
+    constructor({ message }: {
+        message?: string;
+    });
+}
+/**
+ * These errors will not fail UFO experiences
+ */
+export declare class SLOIgnoreError extends CommonError {
+    constructor({ message }: {
+        message?: string;
+    });
+}
+interface HttpErrorArguments {
+    message: string;
+    status: number;
+    traceId?: string;
+    path?: string;
+}
+export declare class HttpError extends CommonError {
+    status: number;
+    traceId?: string;
+    path?: string;
+    constructor({ message, status, traceId, path }: HttpErrorArguments);
+}
+interface ResultErrorData {
+    category: string;
+    message: string;
+    fields?: object;
+}
+interface FieldError {
+    message: string;
+    field: string;
+}
+export interface ErrorData {
+    category: string;
+    message: string;
+    fields?: FieldError[];
+}
+export declare class GraphQLError extends CommonError {
+    fields?: any;
+    category?: string;
+    constructor({ message, category, fields }: Partial<ResultErrorData>);
+    static from: (rawErrors: ErrorData[]) => GraphQLError;
+}
+export {};

package/dist/types-ts4.5/common/utils/http.d.ts

@@ -0,0 +1,31 @@
+export declare const EXPONENTIAL_BACKOFF_RETRY_POLICY: {
+    INITIAL_DELAY: number;
+    MAX_RETRIES: number;
+    JITTER: boolean;
+};
+/**
+ * Checks whether a status code is a 5xx HTTP code.
+ * @param {number} status HTTP status code
+ */
+export declare function is5xx(status: number): boolean;
+export declare function isFetchResponse(data: unknown): data is {
+    response: Response;
+};
+type ToTryFunctionArgs = any[];
+type ToTryFunction<T> = (...args: ToTryFunctionArgs) => Promise<T>;
+type RetryIfCallback<T> = (a: T) => boolean;
+interface WithExponentialBackoffOptions<T> {
+    initial: number;
+    jitter?: boolean;
+    max: number;
+    retryIf?: RetryIfCallback<T>;
+}
+/**
+ * Transparently wrap a function so that it is retried until it succeeds or reaches a max retry limit.
+ * The returned function has the same signature as the wrapped function.
+ *
+ * Modified from https://jsfiddle.net/pajtai/pLka0ow9/
+ */
+export declare function withExponentialBackoff<ResponseType>(toTry: ToTryFunction<ResponseType>, hofOptions?: WithExponentialBackoffOptions<ResponseType>): (...args: ToTryFunctionArgs) => Promise<ResponseType>;
+export declare const fetchWithExponentialBackoff: (...args: ToTryFunctionArgs) => Promise<Response>;
+export {};

package/dist/types-ts4.5/common/utils/status-code-handlers-provider.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Our REST clients are initialised when their module loads which makes it tricky for them to consume the `statusCodeHandlers` prop passed to App from the host application.
+ * This is a temporary measure to enable the clients to consume `statusCodeHandlers`.
+ * The long term solution is to replace our REST clients with Apollo client custom resolvers
+ * This will unify all remote data handling under the apollo-client module which is able to easily receive `statusCodeHandlers` as it is initialised within the React portion of our app.
+ */
+type StatusCodeHandler = (response: Response) => void;
+export interface StatusCodeHandlerMap {
+    [statusCode: number]: StatusCodeHandler;
+}
+export declare const statusCodeHandlersProvider: {
+    handlers: StatusCodeHandlerMap;
+    get(): StatusCodeHandlerMap;
+    setHandlers(handlers: StatusCodeHandlerMap): void;
+};
+export declare function handleResponse(response: Response): void;
+export {};

package/dist/types-ts4.5/common/utils/team-id-to-ari.d.ts

@@ -0,0 +1,2 @@
+export declare const ARI_PREFIX = "ari:cloud:identity::team/";
+export declare const teamIdToAri: (teamIdOrTeamAri: string) => string;

package/dist/types-ts4.5/controllers/hooks/use-team-containers/index.d.ts

@@ -0,0 +1,12 @@
+import { type Action } from 'react-sweet-state';
+import { type TeamContainers } from '../../../services/types';
+type State = {
+    teamContainers: TeamContainers;
+    loading: boolean;
+    error: Error | null;
+};
+export declare const useTeamContainersHook: import("react-sweet-state").HookFunction<State, import("react-sweet-state").BoundActions<State, {
+    fetchTeamContainers: (teamId: string) => Action<State>;
+}>, void>;
+export declare const useTeamContainers: (teamId: string) => State;
+export {};

package/dist/types-ts4.5/controllers/index.d.ts

@@ -0,0 +1 @@
+export { useTeamContainers } from './hooks/use-team-containers';

package/dist/types-ts4.5/services/agg-client/index.d.ts

@@ -0,0 +1,15 @@
+import { type ClientConfig } from '../base-client';
+import { BaseGraphQlClient } from '../graphql-client';
+export declare class AGGClient extends BaseGraphQlClient {
+    constructor(baseUrl: string, config: ClientConfig);
+    setBaseUrl(baseUrl: string): void;
+    getTeamContainers(teamId: string): Promise<{
+        id: string;
+        type: "ConfluenceSpace" | "JiraProject";
+        name: string;
+        icon: string;
+        createdDate: Date;
+        link: string;
+    }[]>;
+}
+export declare const aggClient: AGGClient;

package/dist/types-ts4.5/services/agg-client/mocks/index.d.ts

@@ -0,0 +1,55 @@
+export declare const MOCK_TEAM_CONTAINERS: {
+    graphStore: {
+        cypherQuery: {
+            edges: ({
+                node: {
+                    from: {
+                        id: string;
+                    };
+                    to: {
+                        id: string;
+                        data: {
+                            __typename: string;
+                            confluenceSpaceName: string;
+                            type: string;
+                            createdDate: string;
+                            links: {
+                                webUi: string;
+                            };
+                            icon: {
+                                path: string;
+                            };
+                            jiraProjectName?: undefined;
+                            webUrl?: undefined;
+                            created?: undefined;
+                            avatar?: undefined;
+                        };
+                    };
+                };
+            } | {
+                node: {
+                    from: {
+                        id: string;
+                    };
+                    to: {
+                        id: string;
+                        data: {
+                            __typename: string;
+                            jiraProjectName: string;
+                            webUrl: string;
+                            created: string;
+                            avatar: {
+                                medium: string;
+                            };
+                            confluenceSpaceName?: undefined;
+                            type?: undefined;
+                            createdDate?: undefined;
+                            links?: undefined;
+                            icon?: undefined;
+                        };
+                    };
+                };
+            })[];
+        };
+    };
+};

package/dist/types-ts4.5/services/agg-client/utils/queries/team-containers-query.d.ts

@@ -0,0 +1,44 @@
+export declare const TeamContainersQuery: string;
+export type TeamContainersQueryVariables = {
+    cypherQuery: string;
+};
+export type TeamContainersQueryResponse = {
+    cypherQuery: {
+        edges: Array<{
+            node: {
+                from: {
+                    id: string;
+                };
+                to: {
+                    id: string;
+                    data: JiraProject | ConfluenceSpace;
+                };
+            };
+        }>;
+    };
+};
+type JiraProject = {
+    __typename: 'JiraProject';
+    id: string;
+    jiraProjectName: string;
+    webUrl: string;
+    created: string;
+    avatar: {
+        medium: string;
+    };
+};
+type ConfluenceSpace = {
+    __typename: 'ConfluenceSpace';
+    id: string;
+    confluenceSpaceName?: string;
+    type: string;
+    createdDate: string;
+    links: {
+        base: string;
+        webUi: string;
+    };
+    icon: {
+        path: string;
+    };
+};
+export {};