@atlaskit/teams-client 4.0.0

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

@@ -0,0 +1,117 @@
+import { type TeamMembership } from './membership';
+/**
+ * @private
+ * @deprecated state has been removed as part of migration to V4
+ */
+export type DeprecatedTeamState = 'DISBANDED';
+export type TeamState = 'ACTIVE' | 'PURGED' | DeprecatedTeamState;
+export type TeamMembershipSettings = 'OPEN' | 'MEMBER_INVITE' | 'EXTERNAL';
+export type TeamDiscoverability = 'DISCOVERABLE';
+export type TeamRestriction = 'ORG_MEMBERS' | 'NO_RESTRICTION';
+export type TeamPermission = 'FULL_WRITE' | 'FULL_READ' | 'NONE';
+export type ScopeMode = 'ORG_SCOPE_MODE' | 'SITE_SCOPE_MODE';
+export interface Scope {
+    id: string;
+    name: string;
+}
+export interface TeamAvatarImage {
+    largeAvatarImageUrl: string;
+    smallAvatarImageUrl: string;
+    largeHeaderImageUrl: string;
+    smallHeaderImageUrl: string;
+}
+/**
+ * @type Team
+ * Team type which doean't include the avatar image urls
+ */
+export interface Team {
+    id: string;
+    displayName: string;
+    description: string;
+    state: TeamState;
+    membershipSettings: TeamMembershipSettings;
+    /**
+     * @private
+     * @deprecated field has been removed as part of migration to V4. Will always be DISCOVERABLE
+     */
+    discoverable?: TeamDiscoverability;
+    organizationId?: string;
+    /**
+     * @private
+     * @deprecated field has been removed as part of migration to V4
+     */
+    restriction: TeamRestriction;
+    creatorId?: string;
+    permission?: TeamPermission;
+    /**
+     * @private
+     * @deprecated field has been removed as part of migration to V4
+     */
+    creatorDomain?: string;
+    memberIds?: string[];
+    membership?: {
+        members?: TeamMembership[];
+        errors?: string[];
+    };
+    /**
+     * @private
+     * @deprecated use organizationId instead
+     */
+    orgId?: string;
+    scopeMode?: ScopeMode;
+    isVerified?: boolean;
+}
+/**
+ * @type TeamWithImageUrls
+ */
+export interface TeamWithImageUrls extends Team, TeamAvatarImage {
+}
+export interface SoftDeletedTeamResponse {
+    teamResponse: {
+        displayName: string;
+        expiry: string;
+    };
+}
+export interface SoftDeletedTeam {
+    id: string;
+    displayName: string;
+    expiry: string;
+}
+/**
+ * @type ExternalReference
+ * Payload type for the createTeam API, when the team membershipSetting is EXTERNAL
+ * @property {string} source - The source of the external reference, e.g., "ATLASSIAN_GROUP".
+ * @property {string} id - Group ID of source
+ */
+export interface ExternalReference {
+    source: string;
+    id: string;
+    displayName?: string;
+    syncTeamName?: boolean;
+}
+export type TeamsPermissionApi = 'CAN_CREATE_TEAMS' | 'CAN_VIEW_TEAMS' | 'CAN_ADMIN_TEAMS';
+/**
+ * @type TeamsPermissionFromApi
+ * Mapped response from GET /api/v4/teams/permission/self/organization/{orgId}
+ */
+export type TeamsPermissionFromApi = {
+    permissions: TeamsPermissionApi[];
+};
+export type LinkedTeam = Pick<TeamWithImageUrls, 'id' | 'displayName' | 'description' | 'organizationId' | 'isVerified' | 'smallAvatarImageUrl' | 'largeAvatarImageUrl'> & {
+    linkToTeamProfile: string;
+    externalReference: {
+        id: string;
+    };
+    scopeMode: ScopeMode;
+    scope: Scope;
+};
+export interface LinkedTeamsBulkResponse {
+    teams: LinkedTeam[];
+}
+export interface LinkedTeamsProfileDetails {
+    profileUrl: string;
+}
+export interface OrgScope {
+    scopeMode: ScopeMode;
+    scopes: Scope[];
+}

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

@@ -0,0 +1,51 @@
+type UserPrivacyLevel = 'private' | 'domain' | 'public';
+export type UserStatus = 'active' | 'inactive' | 'closed';
+export type UserType = 'bot' | 'user' | 'agent';
+interface UserPrivacy {
+    level: UserPrivacyLevel;
+    domain: string;
+    isBlacklistedDomain: boolean;
+}
+export interface TeamsClientUser {
+    id: string;
+    isCurrentUser?: boolean;
+    fullName: string;
+    nickname?: string;
+    email?: string;
+    title?: string;
+    timezone?: string;
+    localTime?: string;
+    locale?: string;
+    preferredLanguage?: string;
+    location?: string;
+    companyName?: string;
+    department?: string;
+    position?: string;
+    avatarUrl?: string;
+    headerImageUrl?: string;
+    privacy?: UserPrivacy;
+    status?: UserStatus;
+    statusModifiedDate?: number;
+    isBot?: boolean;
+    isNotMentionable?: boolean;
+    phoneNumber?: string;
+    userType?: UserType;
+    isAgent?: boolean;
+}
+export interface UserInSiteUserbase {
+    isPresent: boolean;
+}
+declare const EditableUserFieldList: readonly [
+    "title",
+    "department",
+    "companyName",
+    "location",
+    "phoneNumber",
+    "fullName",
+    "nickname",
+    "locale",
+    "email"
+];
+export type EditableUserFields = Pick<TeamsClientUser, (typeof EditableUserFieldList)[number]>;
+export declare const isEditableUserField: (key: string) => key is "title" | "department" | "companyName" | "location" | "phoneNumber" | "fullName" | "nickname" | "locale" | "email";
+export {};

package/mocks/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/teams-client/mocks",
+  "main": "../dist/cjs/mocks/index.js",
+  "module": "../dist/esm/mocks/index.js",
+  "module:es2019": "../dist/es2019/mocks/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/mocks/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/mocks/index.d.ts"
+      ]
+    }
+  }
+}

package/package.json

@@ -0,0 +1,111 @@
+{
+	"name": "@atlaskit/teams-client",
+	"version": "4.0.0",
+	"description": "A client to retrieve team related data",
+	"author": "Atlassian Pty Ltd",
+	"license": "Apache-2.0",
+	"publishConfig": {
+		"registry": "https://registry.npmjs.org/"
+	},
+	"atlassian": {
+		"team": "People and Teams Collective"
+	},
+	"repository": "https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo",
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"module:es2019": "dist/es2019/index.js",
+	"types": "dist/types/index.d.ts",
+	"typesVersions": {
+		">=4.5 <4.9": {
+			"*": [
+				"dist/types-ts4.5/*",
+				"dist/types-ts4.5/index.d.ts"
+			]
+		}
+	},
+	"sideEffects": false,
+	"atlaskit:src": "src/index.ts",
+	"af:exports": {
+		".": "./src/index.ts",
+		"./client": "./src/services/index.ts",
+		"./permissions": "./src/common/utils/permissions/index.ts",
+		"./sentry": "./src/services/sentry/index.ts",
+		"./user-info-provider": "./src/services/user-info-provider/index.ts",
+		"./utils": "./src/common/utils/index.ts",
+		"./mocks": "./src/mocks/index.ts",
+		"./types": "./src/types/index.ts",
+		"./ufo": "./src/common/utils/ufo/index.ts",
+		"./public": "./src/services/public-api-client/index.ts",
+		"./use-query-light": "./src/services/use-query-light/index.ts"
+	},
+	"scripts": {
+		"generate:types:public-api": "yarn swagger-typescript-api -p ./src/services/public-api-client/swagger.json -o ./src/services/public-api-client/generated/ --modular --no-client --union-enums",
+		"generate:docs:teams-client": "ts-node --project ../../../tsconfig.node.json ./scripts/generate-docs.ts && yarn ../../.. prettier --write packages/people-and-teams/teams-client/docs"
+	},
+	"dependencies": {
+		"@atlaskit/atlassian-context": "^0.2.0",
+		"@atlaskit/feature-gate-js-client": "^5.3.0",
+		"@atlaskit/platform-feature-flags": "^1.1.0",
+		"@atlaskit/ufo": "^0.4.0",
+		"@babel/runtime": "^7.0.0",
+		"@sentry/browser": "^6.18.2",
+		"date-fns-tz": "^2.0.0",
+		"faker": "^4.1.0",
+		"graphql": "^15.8.0",
+		"graphql-tag": "^2.10.1",
+		"lodash": "^4.17.21"
+	},
+	"peerDependencies": {
+		"react": "^18.2.0"
+	},
+	"devDependencies": {
+		"@atlassian/codegen": "^0.1.0",
+		"@atlassian/ptc-test-utils": "^0.8.0",
+		"@testing-library/react": "^13.4.0",
+		"@testing-library/react-hooks": "^8.0.1",
+		"react-dom": "^18.2.0",
+		"swagger-typescript-api": "^13.0.3",
+		"ts-morph": "^17.0.0",
+		"ts-node": "^10.9.1",
+		"typescript": "~5.4.2",
+		"wait-for-expect": "^1.2.0"
+	},
+	"techstack": {
+		"@atlassian/frontend": {
+			"import-structure": [
+				"atlassian-conventions"
+			],
+			"circular-dependencies": [
+				"file-and-folder-level"
+			]
+		},
+		"@repo/internal": {
+			"dom-events": "use-bind-event-listener",
+			"analytics": [
+				"analytics-next"
+			],
+			"design-tokens": [
+				"color",
+				"spacing"
+			],
+			"theming": [
+				"react-context"
+			],
+			"ui-components": [
+				"lite-mode"
+			],
+			"deprecation": [
+				"no-deprecated-imports"
+			],
+			"styling": [
+				"static",
+				"emotion"
+			]
+		}
+	},
+	"platform-feature-flags": {
+		"enable_edit_team_name_external_type_teams": {
+			"type": "boolean"
+		}
+	}
+}

package/permissions/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/teams-client/permissions",
+  "main": "../dist/cjs/common/utils/permissions/index.js",
+  "module": "../dist/esm/common/utils/permissions/index.js",
+  "module:es2019": "../dist/es2019/common/utils/permissions/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/common/utils/permissions/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/common/utils/permissions/index.d.ts"
+      ]
+    }
+  }
+}

package/public/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/teams-client/public",
+  "main": "../dist/cjs/services/public-api-client/index.js",
+  "module": "../dist/esm/services/public-api-client/index.js",
+  "module:es2019": "../dist/es2019/services/public-api-client/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/services/public-api-client/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.4": {
+      "*": [
+        "../dist/types-ts4.5/services/public-api-client/index.d.ts"
+      ]
+    }
+  }
+}