@atlaskit/teams-client 5.2.0 → 5.3.0

package/is-network-error/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/is-network-error",
+  "main": "../dist/cjs/common/utils/error/isNetworkError.js",
+  "module": "../dist/esm/common/utils/error/isNetworkError.js",
+  "module:es2019": "../dist/es2019/common/utils/error/isNetworkError.js",
+  "sideEffects": false,
+  "types": "../dist/types/common/utils/error/isNetworkError.d.ts"
+}

package/is-non-member/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/is-non-member",
+  "main": "../dist/cjs/common/utils/is-non-member.js",
+  "module": "../dist/esm/common/utils/is-non-member.js",
+  "module:es2019": "../dist/es2019/common/utils/is-non-member.js",
+  "sideEffects": false,
+  "types": "../dist/types/common/utils/is-non-member.d.ts"
+}

package/is-requesting-join/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/is-requesting-join",
+  "main": "../dist/cjs/common/utils/is-requesting-join.js",
+  "module": "../dist/esm/common/utils/is-requesting-join.js",
+  "module:es2019": "../dist/es2019/common/utils/is-requesting-join.js",
+  "sideEffects": false,
+  "types": "../dist/types/common/utils/is-requesting-join.d.ts"
+}

package/is-team-ari/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/is-team-ari",
+  "main": "../dist/cjs/common/utils/is-team-ari.js",
+  "module": "../dist/esm/common/utils/is-team-ari.js",
+  "module:es2019": "../dist/es2019/common/utils/is-team-ari.js",
+  "sideEffects": false,
+  "types": "../dist/types/common/utils/is-team-ari.d.ts"
+}

package/is-user-ari/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/is-user-ari",
+  "main": "../dist/cjs/common/utils/is-user-ari.js",
+  "module": "../dist/esm/common/utils/is-user-ari.js",
+  "module:es2019": "../dist/es2019/common/utils/is-user-ari.js",
+  "sideEffects": false,
+  "types": "../dist/types/common/utils/is-user-ari.d.ts"
+}

package/log-error-message/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/log-error-message",
+  "main": "../dist/cjs/services/sentry/logErrorMessage.js",
+  "module": "../dist/esm/services/sentry/logErrorMessage.js",
+  "module:es2019": "../dist/es2019/services/sentry/logErrorMessage.js",
+  "sideEffects": false,
+  "types": "../dist/types/services/sentry/logErrorMessage.d.ts"
+}

package/log-error-message-with-package-context/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/log-error-message-with-package-context",
+  "main": "../dist/cjs/services/sentry/logErrorMessageWithPackageContext.js",
+  "module": "../dist/esm/services/sentry/logErrorMessageWithPackageContext.js",
+  "module:es2019": "../dist/es2019/services/sentry/logErrorMessageWithPackageContext.js",
+  "sideEffects": false,
+  "types": "../dist/types/services/sentry/logErrorMessageWithPackageContext.d.ts"
+}

package/log-exception/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/log-exception",
+  "main": "../dist/cjs/services/sentry/logException.js",
+  "module": "../dist/esm/services/sentry/logException.js",
+  "module:es2019": "../dist/es2019/services/sentry/logException.js",
+  "sideEffects": false,
+  "types": "../dist/types/services/sentry/logException.d.ts"
+}

package/log-exception-with-package-context/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/log-exception-with-package-context",
+  "main": "../dist/cjs/services/sentry/logExceptionWithPackageContext.js",
+  "module": "../dist/esm/services/sentry/logExceptionWithPackageContext.js",
+  "module:es2019": "../dist/es2019/services/sentry/logExceptionWithPackageContext.js",
+  "sideEffects": false,
+  "types": "../dist/types/services/sentry/logExceptionWithPackageContext.d.ts"
+}

package/log-info-message/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/log-info-message",
+  "main": "../dist/cjs/services/sentry/logInfoMessage.js",
+  "module": "../dist/esm/services/sentry/logInfoMessage.js",
+  "module:es2019": "../dist/es2019/services/sentry/logInfoMessage.js",
+  "sideEffects": false,
+  "types": "../dist/types/services/sentry/logInfoMessage.d.ts"
+}

package/log-info-message-with-package-context/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/log-info-message-with-package-context",
+  "main": "../dist/cjs/services/sentry/logInfoMessageWithPackageContext.js",
+  "module": "../dist/esm/services/sentry/logInfoMessageWithPackageContext.js",
+  "module:es2019": "../dist/es2019/services/sentry/logInfoMessageWithPackageContext.js",
+  "sideEffects": false,
+  "types": "../dist/types/services/sentry/logInfoMessageWithPackageContext.d.ts"
+}

package/mock-team-membership-response-with-n-edges/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/mock-team-membership-response-with-n-edges",
+  "main": "../dist/cjs/mocks/mock-team-membership-response-with-n-edges.js",
+  "module": "../dist/esm/mocks/mock-team-membership-response-with-n-edges.js",
+  "module:es2019": "../dist/es2019/mocks/mock-team-membership-response-with-n-edges.js",
+  "sideEffects": false,
+  "types": "../dist/types/mocks/mock-team-membership-response-with-n-edges.d.ts"
+}

package/mock-teams-client-admin-endpoints/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/mock-teams-client-admin-endpoints",
+  "main": "../dist/cjs/mocks/mock-teams-client-admin-endpoints.js",
+  "module": "../dist/esm/mocks/mock-teams-client-admin-endpoints.js",
+  "module:es2019": "../dist/es2019/mocks/mock-teams-client-admin-endpoints.js",
+  "sideEffects": false,
+  "types": "../dist/types/mocks/mock-teams-client-admin-endpoints.d.ts"
+}

package/mock-teams-client-endpoints/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/mock-teams-client-endpoints",
+  "main": "../dist/cjs/mocks/mock-teams-client-endpoints.js",
+  "module": "../dist/esm/mocks/mock-teams-client-endpoints.js",
+  "module:es2019": "../dist/es2019/mocks/mock-teams-client-endpoints.js",
+  "sideEffects": false,
+  "types": "../dist/types/mocks/mock-teams-client-endpoints.d.ts"
+}

package/mock-teams-client-invite-only-member-endpoints/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/mock-teams-client-invite-only-member-endpoints",
+  "main": "../dist/cjs/mocks/mock-teams-client-invite-only-member-endpoints.js",
+  "module": "../dist/esm/mocks/mock-teams-client-invite-only-member-endpoints.js",
+  "module:es2019": "../dist/es2019/mocks/mock-teams-client-invite-only-member-endpoints.js",
+  "sideEffects": false,
+  "types": "../dist/types/mocks/mock-teams-client-invite-only-member-endpoints.d.ts"
+}

package/mock-teams-client-not-member-endpoints/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/mock-teams-client-not-member-endpoints",
+  "main": "../dist/cjs/mocks/mock-teams-client-not-member-endpoints.js",
+  "module": "../dist/esm/mocks/mock-teams-client-not-member-endpoints.js",
+  "module:es2019": "../dist/es2019/mocks/mock-teams-client-not-member-endpoints.js",
+  "sideEffects": false,
+  "types": "../dist/types/mocks/mock-teams-client-not-member-endpoints.d.ts"
+}

package/mock-teams-client-requesting-to-join-endpoints/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/mock-teams-client-requesting-to-join-endpoints",
+  "main": "../dist/cjs/mocks/mock-teams-client-requesting-to-join-endpoints.js",
+  "module": "../dist/esm/mocks/mock-teams-client-requesting-to-join-endpoints.js",
+  "module:es2019": "../dist/es2019/mocks/mock-teams-client-requesting-to-join-endpoints.js",
+  "sideEffects": false,
+  "types": "../dist/types/mocks/mock-teams-client-requesting-to-join-endpoints.d.ts"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/teams-client",
-	"version": "5.2.0",
+	"version": "5.3.0",
 	"description": "A client to retrieve team related data",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",

package/public-api-client/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/public-api-client",
+  "main": "../dist/cjs/services/public-api-client/PublicApiClient.js",
+  "module": "../dist/esm/services/public-api-client/PublicApiClient.js",
+  "module:es2019": "../dist/es2019/services/public-api-client/PublicApiClient.js",
+  "sideEffects": false,
+  "types": "../dist/types/services/public-api-client/PublicApiClient.d.ts"
+}

package/random-returned-new-team-data/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/random-returned-new-team-data",
+  "main": "../dist/cjs/mocks/random-returned-new-team-data.js",
+  "module": "../dist/esm/mocks/random-returned-new-team-data.js",
+  "module:es2019": "../dist/es2019/mocks/random-returned-new-team-data.js",
+  "sideEffects": false,
+  "types": "../dist/types/mocks/random-returned-new-team-data.d.ts"
+}

package/random-team-membership/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/random-team-membership",
+  "main": "../dist/cjs/mocks/random-team-membership.js",
+  "module": "../dist/esm/mocks/random-team-membership.js",
+  "module:es2019": "../dist/es2019/mocks/random-team-membership.js",
+  "sideEffects": false,
+  "types": "../dist/types/mocks/random-team-membership.d.ts"
+}

package/random-team-memberships/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/random-team-memberships",
+  "main": "../dist/cjs/mocks/random-team-memberships.js",
+  "module": "../dist/esm/mocks/random-team-memberships.js",
+  "module:es2019": "../dist/es2019/mocks/random-team-memberships.js",
+  "sideEffects": false,
+  "types": "../dist/types/mocks/random-team-memberships.d.ts"
+}

package/scripts/docs-to-string.ts

@@ -0,0 +1,10 @@
+import { type JSDoc } from 'ts-morph';
+
+export function docsToString(docs: JSDoc[]): string {
+	return docs.length > 0
+		? docs
+				.map((d) => d.getDescription())
+				.join('\n')
+				.trim()
+		: '';
+}

package/scripts/docs-to-tags-string.ts

@@ -0,0 +1,12 @@
+import { type JSDoc } from 'ts-morph';
+
+import { tagToString } from './tag-to-string';
+
+export function docsToTagsString(docs: JSDoc[]): string {
+	return docs
+		.flatMap((doc) => doc.getTags())
+		.filter((t) => !['private'].includes(t.getTagName()))
+		.map(tagToString)
+		.join('\n')
+		.trim();
+}

package/scripts/generate-docs.ts

@@ -3,7 +3,8 @@ import { join } from 'path';
 
 import { createSignedArtifact } from '@atlassian/codegen';
 
-import { parseFile, toMarkdown } from './utils';
+import { parseFile } from './parse-file';
+import { toMarkdown } from './to-markdown';
 
 const path = `${process.cwd()}/src/services/main.ts`;
 

package/scripts/get-method-parameters.ts

@@ -0,0 +1,18 @@
+import { type MethodDeclaration } from 'ts-morph';
+
+import type { ParsedParam } from './parsed-param';
+import { typeToText } from './type-to-text';
+
+export function getMethodParameters(method: MethodDeclaration): ParsedParam[] {
+	return method.getParameters().map((param) => {
+		return {
+			name: param.getName(),
+			type: typeToText(param.getType()),
+			required: !param.isOptional(),
+			docs: param
+				.getDecorators()
+				.map((d) => d.getText())
+				.join('\n'),
+		};
+	});
+}

package/scripts/get-prop-docs.ts

@@ -0,0 +1,24 @@
+import { type JSDocTagInfo } from 'ts-morph';
+
+function jsdocTagToString(tag: JSDocTagInfo): string {
+	try {
+		const name = tag.getName();
+		if (['private'].includes(name)) {
+			return '';
+		}
+		const comment = JSON.parse(JSON.stringify(tag.getText()) as any)[0].text.trim();
+		if (comment === '') {
+			return `${name}`;
+		}
+		if (name === '') {
+			return `${comment}`;
+		}
+		return `*${name}*: ${comment}`;
+	} catch {
+		return '';
+	}
+}
+
+export function getPropDocs(tags: JSDocTagInfo[]): string {
+	return tags.map(jsdocTagToString).join('').trim();
+}

package/scripts/indent.ts

@@ -0,0 +1,5 @@
+import { SINGLE_INDENT } from './utils';
+
+export function indent(level: number): string {
+	return SINGLE_INDENT.repeat(level);
+}

package/scripts/method-to-markdown.ts

@@ -0,0 +1,14 @@
+import { paramsToMarkdown } from './params-to-markdown';
+import type { ParsedMethod } from './parsed-method';
+import { SINGLE_INDENT } from './utils';
+
+export function methodToMarkdown(method: ParsedMethod): string {
+	return (
+		`### ${method.name} <a name="${method.name}"></a>\n` +
+		`${method.docs ? method.docs + '\n' : ''}` +
+		`${method.tags ? method.tags + '\n' : ''}` +
+		paramsToMarkdown(method.params) +
+		`#### Returns\n${SINGLE_INDENT}* ${method.returnType}\n` +
+		'---\n'
+	);
+}

package/scripts/params-to-markdown.ts

@@ -0,0 +1,14 @@
+import type { ParsedParam } from './parsed-param';
+import { SINGLE_INDENT } from './utils';
+
+export function paramsToMarkdown(params: ParsedParam[]): string {
+	const paramsList = params.reduce(
+		(paramMarkdown, param) =>
+			paramMarkdown +
+			`${param.docs.length > 0 ? `${param.docs}\n` : ''}${SINGLE_INDENT}* ${
+				param.name
+			}: ${param.type}\n`,
+		'',
+	);
+	return params.length > 0 ? `#### Parameters\n${paramsList}` : '';
+}

package/scripts/parse-file.ts

@@ -0,0 +1,26 @@
+import { Project } from 'ts-morph';
+
+import { parseMethod } from './parse-method';
+import type { ParsedInfo } from './parsed-info';
+
+// Initialize a Project
+const project = new Project();
+
+export function parseFile(path: string): ParsedInfo {
+	// Add the TypeScript file we want to parse
+	const file = project.addSourceFileAtPath(path);
+
+	// Get all the classes in the file
+	const classes = file.getClasses();
+
+	const parsedInfo: ParsedInfo = classes.map((cls) => {
+		const methods = cls.getMethods().map(parseMethod);
+
+		return {
+			name: cls.getName() || '',
+			docs: cls.getJsDocs()[0]?.getDescription() || '',
+			methods,
+		};
+	});
+	return parsedInfo;
+}

package/scripts/parse-method.ts

@@ -0,0 +1,23 @@
+import { type MethodDeclaration } from 'ts-morph';
+
+import { docsToString } from './docs-to-string';
+import { docsToTagsString } from './docs-to-tags-string';
+import { getMethodParameters } from './get-method-parameters';
+import type { ParsedMethod } from './parsed-method';
+import { typeToText } from './type-to-text';
+
+export function parseMethod(method: MethodDeclaration): ParsedMethod {
+	const params = getMethodParameters(method);
+
+	const docs = method.getJsDocs();
+	const docText = docsToString(docs);
+	const tags = docsToTagsString(docs);
+
+	return {
+		name: method.getName(),
+		params,
+		returnType: typeToText(method.getReturnType()),
+		docs: docText,
+		tags: tags,
+	};
+}

package/scripts/parsed-info.ts

@@ -0,0 +1,8 @@
+import type { ParsedMethod } from './parsed-method';
+
+export // Define a type for the parsed information
+type ParsedInfo = {
+	name: string;
+	docs: string;
+	methods: ParsedMethod[];
+}[];

package/scripts/parsed-method.ts

@@ -0,0 +1,9 @@
+import type { ParsedParam } from './parsed-param';
+
+export type ParsedMethod = {
+	name: string;
+	params: ParsedParam[];
+	returnType: string;
+	docs: string;
+	tags: string;
+};

package/scripts/parsed-param.ts

@@ -0,0 +1,6 @@
+export type ParsedParam = {
+	name: string;
+	type: string;
+	required: boolean;
+	docs: string;
+};

package/scripts/strip-import-path.ts

@@ -0,0 +1,3 @@
+export function stripImportPath(typeText: string): string {
+	return typeText.replace(/import\("[^"]+"\)\./g, '');
+}

package/scripts/table-of-contents.ts

@@ -0,0 +1,14 @@
+import type { ParsedInfo } from './parsed-info';
+
+export function tableOfContents(parsedInfo: ParsedInfo): string {
+	return parsedInfo.reduce((toc, cls) => {
+		const classToc = cls.methods.reduce(
+			(methodToc, method) =>
+				methodToc +
+				`* [${method.name}](#${method.name})${method.docs.length > 0 ? ` - ${method.docs}` : ''}\n`,
+			'',
+		);
+
+		return toc + `## Methods\n${classToc}\n---\n`;
+	}, '');
+}

package/scripts/tag-to-string.ts

@@ -0,0 +1,10 @@
+import { type JSDocTag, type ts } from 'ts-morph';
+
+export function tagToString(tag: JSDocTag<ts.JSDocTag>): string {
+	const tagName = tag.getTagName().toLowerCase();
+	const tagText = tag.getText(true).replace(/\*/g, '');
+	if (tagName === 'deprecated') {
+		return `* ***${tagName.toLocaleUpperCase()}*** - ${tagText}`;
+	}
+	return tagText.trim().length > 0 ? `* ${tagText}` : '';
+}

package/scripts/to-markdown.ts

@@ -0,0 +1,19 @@
+import { methodToMarkdown } from './method-to-markdown';
+import type { ParsedInfo } from './parsed-info';
+import { tableOfContents } from './table-of-contents';
+
+export function toMarkdown(parsedInfo: ParsedInfo): string {
+	return parsedInfo.reduce((markdown, cls) => {
+		const classMarkdown = cls.methods.reduce(
+			(methodMarkdown, method) => methodMarkdown + methodToMarkdown(method),
+			'',
+		);
+
+		return (
+			markdown +
+			`## ${cls.name}\n${cls.docs}\n${tableOfContents(parsedInfo)}` +
+			classMarkdown +
+			'\n'
+		);
+	}, '');
+}

package/scripts/type-to-text.ts

@@ -0,0 +1,80 @@
+import { type ts, type Type } from 'ts-morph';
+
+import { getPropDocs } from './get-prop-docs';
+import { indent } from './indent';
+import { stripImportPath } from './strip-import-path';
+
+export function typeToText(t: Type<ts.Type>, level: number = 1): string {
+	try {
+		if (t.isLiteral()) {
+			return `\\\`'${t.getLiteralValueOrThrow()}'\\\``;
+		}
+		if (t.isUnion()) {
+			return t
+				.getUnionTypes()
+				.map((t) => typeToText(t, level + 1))
+				.join(' | ');
+		}
+		// if (t.isEnum()) {
+		// }
+		if (t.isArray()) {
+			const text = stripImportPath(typeToText(t.getArrayElementTypeOrThrow(), level + 1)).trim();
+			return `${stripImportPath(t.getText())}\n${indent(level + 1)}${
+				text.startsWith('*') ? text : `* ${text}`
+			}`;
+		}
+
+		if (t.getSymbol()?.getName() === 'Promise') {
+			const typeArgs = t.getTypeArguments();
+			if (typeArgs.length > 0) {
+				const text = typeToText(typeArgs[0], level + 1).trim();
+				return `${stripImportPath(t.getText())}\n${indent(level + 1)}${
+					text.startsWith('*') ? text : `* ${text}`
+				}`;
+			}
+		}
+		if (t.isTuple()) {
+			const tupleText = t.getText().replace(/\[|\]/g, '').split(',');
+
+			const text = t
+				.getTupleElements()
+				.map((t, i) => {
+					const elementName =
+						tupleText.length > i ? `${stripImportPath(tupleText[i].split(':')[0]).trim()}: ` : '';
+					return `${elementName}${typeToText(t, level + 1)}`.trim();
+				})
+				.join(`\n${indent(level + 1)}* `)
+				.trim();
+			return `\n${indent(level + 1)}${text.startsWith('*') ? text : `* ${text}`}`;
+		}
+
+		if (t.isObject()) {
+			const properties = t.getProperties();
+			const propsText = properties
+				.map((prop) => {
+					const propName = prop.getName();
+					if (['then', 'catch', 'finally', '__@toStringTag@2998'].includes(propName)) {
+						return '';
+					}
+
+					const propDocs = getPropDocs(prop.getJsDocTags());
+
+					return `${indent(level + 1)}* ${propName}: ${typeToText(
+						prop.getValueDeclarationOrThrow().getType(),
+						level + 1,
+					)}${propDocs.length > 0 ? ` - ${propDocs}` : ''}`;
+				})
+				.filter((s) => s.trim().length > 2)
+				.join(`\n`);
+			const typeName = stripImportPath(t.getText());
+
+			if (propsText.length === 0) {
+				return `${indent(level)}* ${typeName}`;
+			}
+			return `\n${
+				typeName ? `${indent(level)}* ${typeName}\n${propsText}` : `${indent(level)}* ${propsText}`
+			}\n`;
+		}
+	} catch {}
+	return stripImportPath(t.getText());
+}