@atlaskit/teams-client 5.1.1 → 5.3.0

package/scripts/utils.ts

@@ -1,269 +1 @@
-import {
-	type JSDoc,
-	type JSDocTag,
-	type JSDocTagInfo,
-	type MethodDeclaration,
-	Project,
-	type ts,
-	type Type,
-} from 'ts-morph';
-
-type ParsedParam = {
-	name: string;
-	type: string;
-	required: boolean;
-	docs: string;
-};
-type ParsedMethod = {
-	name: string;
-	params: ParsedParam[];
-	returnType: string;
-	docs: string;
-	tags: string;
-};
-
-// Define a type for the parsed information
-type ParsedInfo = {
-	name: string;
-	docs: string;
-	methods: ParsedMethod[];
-}[];
-
-// Initialize a Project
-const project = new Project();
-
-const SINGLE_INDENT = '  ';
-
-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'),
-		};
-	});
-}
-
-export function docsToString(docs: JSDoc[]): string {
-	return docs.length > 0
-		? docs
-				.map((d) => d.getDescription())
-				.join('\n')
-				.trim()
-		: '';
-}
-
-export function docsToTagsString(docs: JSDoc[]): string {
-	return docs
-		.flatMap((doc) => doc.getTags())
-		.filter((t) => !['private'].includes(t.getTagName()))
-		.map(tagToString)
-		.join('\n')
-		.trim();
-}
-
-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,
-	};
-}
-
-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;
-}
-
-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}` : '';
-}
-
-export function stripImportPath(typeText: string): string {
-	return typeText.replace(/import\("[^"]+"\)\./g, '');
-}
-
-export function indent(level: number): string {
-	return SINGLE_INDENT.repeat(level);
-}
-
-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();
-}
-
-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());
-}
-
-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}` : '';
-}
-
-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'
-	);
-}
-
-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`;
-	}, '');
-}
-
-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'
-		);
-	}, '');
-}
+export const SINGLE_INDENT: any = '  ';

package/slo-ignore-error/package.json

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

package/slo-ignore-http-error/package.json

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

package/team-containers/package.json

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

package/to-team-ari/package.json

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

package/to-team-id/package.json

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

package/to-user-ari/package.json

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

package/to-user-id/package.json

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

package/use-query-light/use-lazy-query-light/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/use-query-light/use-lazy-query-light",
+  "main": "../../dist/cjs/services/use-query-light/useLazyQueryLight.js",
+  "module": "../../dist/esm/services/use-query-light/useLazyQueryLight.js",
+  "module:es2019": "../../dist/es2019/services/use-query-light/useLazyQueryLight.js",
+  "sideEffects": false,
+  "types": "../../dist/types/services/use-query-light/useLazyQueryLight.d.ts"
+}

package/use-query-light/use-query-light/package.json

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

package/use-query-light-error/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@atlaskit/teams-client/use-query-light-error",
+  "main": "../dist/cjs/services/use-query-light/UseQueryLightError.js",
+  "module": "../dist/esm/services/use-query-light/UseQueryLightError.js",
+  "module:es2019": "../dist/es2019/services/use-query-light/UseQueryLightError.js",
+  "sideEffects": false,
+  "types": "../dist/types/services/use-query-light/UseQueryLightError.d.ts"
+}

package/use-teams-client-setup-next/package.json

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

package/user-can/package.json

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

package/user-info-provider/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@atlaskit/teams-client/user-info-provider",
-  "main": "../dist/cjs/services/user-info-provider/index.js",
-  "module": "../dist/esm/services/user-info-provider/index.js",
-  "module:es2019": "../dist/es2019/services/user-info-provider/index.js",
+  "main": "../dist/cjs/services/user-info-provider/main.js",
+  "module": "../dist/esm/services/user-info-provider/main.js",
+  "module:es2019": "../dist/es2019/services/user-info-provider/main.js",
   "sideEffects": false,
-  "types": "../dist/types/services/user-info-provider/index.d.ts"
+  "types": "../dist/types/services/user-info-provider/main.d.ts"
 }

package/dist/cjs/common/utils/ufo/utils.js

@@ -1,26 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.isIgnoredError = exports.createErrorMetadata = void 0;
-var _error = require("../error");
-var createErrorMetadata = exports.createErrorMetadata = function createErrorMetadata(error) {
-  return {
-    error: {
-      name: error.name,
-      message: error.message,
-      stack: error.stack,
-      traceId: error instanceof _error.HttpError ? error.traceId : undefined,
-      status: error instanceof _error.HttpError ? error.status : undefined
-    }
-  };
-};
-var ignoredErrors = ['SLOIgnoreError', 'SLOIgnoreHttpError'];
-var isIgnoredError = exports.isIgnoredError = function isIgnoredError(error) {
-  var errorName = error === null || error === void 0 ? void 0 : error.constructor.name;
-  if (!errorName) {
-    return false;
-  }
-  return ignoredErrors.includes(errorName);
-};

package/dist/cjs/services/graphql-client/index.js

@@ -1,12 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "BaseGraphQlClient", {
-  enumerable: true,
-  get: function get() {
-    return _main.BaseGraphQlClient;
-  }
-});
-var _main = require("./main");

package/dist/cjs/services/index.js

@@ -1,18 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "TeamsClient", {
-  enumerable: true,
-  get: function get() {
-    return _main.TeamsClient;
-  }
-});
-Object.defineProperty(exports, "teamsClient", {
-  enumerable: true,
-  get: function get() {
-    return _main.teamsClient;
-  }
-});
-var _main = require("./main");

package/dist/cjs/services/team-central-client/utils.js

@@ -1,12 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getUnshardedTeamCentralGraphqlUrl = exports.getTeamCentralGraphqlUrl = void 0;
-var getTeamCentralGraphqlUrl = exports.getTeamCentralGraphqlUrl = function getTeamCentralGraphqlUrl(baseUrl, cloudId) {
-  return "".concat(baseUrl, "/townsquare/s/").concat(cloudId, "/graphql");
-};
-var getUnshardedTeamCentralGraphqlUrl = exports.getUnshardedTeamCentralGraphqlUrl = function getUnshardedTeamCentralGraphqlUrl(baseUrl) {
-  return "".concat(baseUrl, "/watermelon/graphql");
-};

package/dist/cjs/services/user-info-provider/index.js

@@ -1,18 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "UserInfoProvider", {
-  enumerable: true,
-  get: function get() {
-    return _main.UserInfoProvider;
-  }
-});
-Object.defineProperty(exports, "userInfoProvider", {
-  enumerable: true,
-  get: function get() {
-    return _main.userInfoProvider;
-  }
-});
-var _main = require("./main");

package/dist/es2019/common/utils/ufo/utils.js

@@ -1,18 +0,0 @@
-import { HttpError } from '../error';
-export const createErrorMetadata = error => ({
-  error: {
-    name: error.name,
-    message: error.message,
-    stack: error.stack,
-    traceId: error instanceof HttpError ? error.traceId : undefined,
-    status: error instanceof HttpError ? error.status : undefined
-  }
-});
-const ignoredErrors = ['SLOIgnoreError', 'SLOIgnoreHttpError'];
-export const isIgnoredError = error => {
-  const errorName = error === null || error === void 0 ? void 0 : error.constructor.name;
-  if (!errorName) {
-    return false;
-  }
-  return ignoredErrors.includes(errorName);
-};

package/dist/es2019/services/graphql-client/index.js

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

package/dist/es2019/services/index.js

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

package/dist/es2019/services/team-central-client/utils.js

@@ -1,2 +0,0 @@
-export const getTeamCentralGraphqlUrl = (baseUrl, cloudId) => `${baseUrl}/townsquare/s/${cloudId}/graphql`;
-export const getUnshardedTeamCentralGraphqlUrl = baseUrl => `${baseUrl}/watermelon/graphql`;

package/dist/es2019/services/user-info-provider/index.js

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

package/dist/esm/common/utils/ufo/utils.js

@@ -1,20 +0,0 @@
-import { HttpError } from '../error';
-export var createErrorMetadata = function createErrorMetadata(error) {
-  return {
-    error: {
-      name: error.name,
-      message: error.message,
-      stack: error.stack,
-      traceId: error instanceof HttpError ? error.traceId : undefined,
-      status: error instanceof HttpError ? error.status : undefined
-    }
-  };
-};
-var ignoredErrors = ['SLOIgnoreError', 'SLOIgnoreHttpError'];
-export var isIgnoredError = function isIgnoredError(error) {
-  var errorName = error === null || error === void 0 ? void 0 : error.constructor.name;
-  if (!errorName) {
-    return false;
-  }
-  return ignoredErrors.includes(errorName);
-};

package/dist/esm/services/graphql-client/index.js

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

package/dist/esm/services/index.js

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

package/dist/esm/services/user-info-provider/index.js

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

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

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

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

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

package/dist/types/services/team-central-client/utils.d.ts

@@ -1,2 +0,0 @@
-export declare const getTeamCentralGraphqlUrl: (baseUrl: string, cloudId: string) => string;
-export declare const getUnshardedTeamCentralGraphqlUrl: (baseUrl: string) => string;

package/dist/types/services/user-info-provider/index.d.ts

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