@mattermost/types 10.4.0 → 10.5.0

package/lib/client4.d.ts

@@ -27,6 +27,7 @@ export type OptsSignalExt = {
 export type StatusOK = {
     status: 'OK';
 };
+export declare const isStatusOK: (x: StatusOK | Record<string, unknown>) => x is StatusOK;
 export type FetchPaginatedThreadOptions = {
     fetchThreads?: boolean;
     collapsedThreads?: boolean;

package/lib/client4.js

@@ -2,7 +2,7 @@
 // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogLevel = void 0;
+exports.isStatusOK = exports.LogLevel = void 0;
 var LogLevel;
 (function (LogLevel) {
     LogLevel["Error"] = "ERROR";
@@ -10,3 +10,5 @@ var LogLevel;
     LogLevel["Info"] = "INFO";
     LogLevel["Debug"] = "DEBUG";
 })(LogLevel || (exports.LogLevel = LogLevel = {}));
+const isStatusOK = (x) => (x === null || x === void 0 ? void 0 : x.status) === 'OK';
+exports.isStatusOK = isStatusOK;

package/lib/config.d.ts

@@ -120,6 +120,7 @@ export type ClientConfig = {
     FileLevel: string;
     FeatureFlagAppsEnabled: string;
     FeatureFlagCallsEnabled: string;
+    FeatureFlagCustomProfileAttributes: string;
     FeatureFlagWebSocketEventScope: string;
     ForgotPasswordLink: string;
     GiphySdkKey: string;

package/lib/files.d.ts

@@ -1,6 +1,7 @@
 export type FileInfo = {
     id: string;
     user_id: string;
+    channel_id: string;
     create_at: number;
     update_at: number;
     delete_at: number;

package/lib/general.d.ts

@@ -1,10 +1,13 @@
 import type { ClientConfig, ClientLicense } from './config';
+import type { UserPropertyField } from './properties';
+import type { IDMappedObjects } from './utilities';
 export type GeneralState = {
     config: Partial<ClientConfig>;
     firstAdminVisitMarketplaceStatus: boolean;
     firstAdminCompleteSetup: boolean;
     license: ClientLicense;
     serverVersion: string;
+    customProfileAttributes: IDMappedObjects<UserPropertyField>;
 };
 export type SystemSetting = {
     name: string;

package/lib/plugins.d.ts

@@ -47,6 +47,7 @@ export type PluginSettingSection = {
     header?: string;
     footer?: string;
     custom?: boolean;
+    fallback?: boolean;
 };
 export type PluginSetting = {
     key: string;

package/lib/properties.d.ts

@@ -0,0 +1,31 @@
+export type PropertyField = {
+    id: string;
+    group_id: string;
+    name: string;
+    type: string;
+    attrs?: {
+        [key: string]: unknown;
+    };
+    target_id?: string;
+    target_type?: string;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+};
+export type PropertyValue<T> = {
+    id: string;
+    target_id: string;
+    target_type: string;
+    group_id: string;
+    value: T;
+    create_at: number;
+    update_at: number;
+    delete_at: number;
+};
+export type UserPropertyFieldType = 'text';
+export type UserPropertyFieldGroupID = 'custom_profile_attributes';
+export type UserPropertyField = PropertyField & {
+    type: UserPropertyFieldType;
+    group_id: UserPropertyFieldGroupID;
+};
+export type UserPropertyFieldPatch = Partial<Pick<UserPropertyField, 'name' | 'attrs' | 'type'>>;

package/lib/properties.js

@@ -0,0 +1,4 @@
+"use strict";
+// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
+// See LICENSE.txt for license information.
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/utilities.d.ts

@@ -20,6 +20,16 @@ export type RelationOneToManyUnique<E1 extends {
 export type IDMappedObjects<E extends {
     id: string;
 }> = RelationOneToOne<E, E>;
+export type IDMappedCollection<T extends {
+    id: string;
+}> = {
+    data: IDMappedObjects<T>;
+    order: Array<T['id']>;
+    errors?: RelationOneToOne<T, Error>;
+    warnings?: RelationOneToOne<T, {
+        [Key in keyof T]?: string;
+    }>;
+};
 export type DeepPartial<T> = {
     [K in keyof T]?: (T[K] extends Set<any> ? T[K] : T[K] extends Map<any, any> ? T[K] : T[K] extends object ? DeepPartial<T[K]> : T[K] extends object | undefined ? DeepPartial<T[K]> : T[K]);
 };
@@ -31,7 +41,49 @@ export type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<
     [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
 }[Keys];
 export type Intersection<T1, T2> = Omit<Omit<T1 & T2, keyof (Omit<T1, keyof (T2)>)>, keyof (Omit<T2, keyof (T1)>)>;
+/** https://stackoverflow.com/a/66605669 */
+type Only<T, U> = {
+    [P in keyof T]: T[P];
+} & {
+    [P in keyof U]?: never;
+};
+export type Either<T, U> = Only<T, U> | Only<U, T>;
 export type PartialExcept<T extends Record<string, unknown>, TKeysNotPartial extends keyof T> = Partial<T> & Pick<T, TKeysNotPartial>;
 export declare function isArrayOf<T>(v: unknown, check: (e: unknown) => boolean): v is T[];
 export declare function isStringArray(v: unknown): v is string[];
 export declare function isRecordOf<T>(v: unknown, check: (e: unknown) => boolean): v is Record<string, T>;
+export declare const collectionFromArray: <T extends {
+    id: string;
+}>(arr?: T[]) => IDMappedCollection<T>;
+export declare const collectionToArray: <T extends {
+    id: string;
+}>({ data, order }: IDMappedCollection<T>) => T[];
+export declare const collectionReplaceItem: <T extends {
+    id: string;
+}>(collection: IDMappedCollection<T>, item: T) => {
+    data: IDMappedObjects<T> & {
+        [x: string]: T;
+    };
+    order: T["id"][];
+    errors?: RelationOneToOne<T, Error> | undefined;
+    warnings?: RelationOneToOne<T, { [Key in keyof T]?: string | undefined; }> | undefined;
+};
+export declare const collectionAddItem: <T extends {
+    id: string;
+}>(collection: IDMappedCollection<T>, item: T) => {
+    data: IDMappedObjects<T> & {
+        [x: string]: T;
+    };
+    order: string[];
+    errors?: RelationOneToOne<T, Error> | undefined;
+    warnings?: RelationOneToOne<T, { [Key in keyof T]?: string | undefined; }> | undefined;
+};
+export declare const collectionRemoveItem: <T extends {
+    id: string;
+}>(collection: IDMappedCollection<T>, item: T) => {
+    data: IDMappedObjects<T>;
+    order: T["id"][];
+    errors?: RelationOneToOne<T, Error> | undefined;
+    warnings?: RelationOneToOne<T, { [Key in keyof T]?: string | undefined; }> | undefined;
+};
+export {};

package/lib/utilities.js

@@ -2,6 +2,7 @@
 // Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
 // See LICENSE.txt for license information.
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.collectionRemoveItem = exports.collectionAddItem = exports.collectionReplaceItem = exports.collectionToArray = exports.collectionFromArray = void 0;
 exports.isArrayOf = isArrayOf;
 exports.isStringArray = isStringArray;
 exports.isRecordOf = isRecordOf;
@@ -26,3 +27,30 @@ function isRecordOf(v, check) {
     }
     return true;
 }
+const collectionFromArray = (arr = []) => {
+    return arr.reduce((current, item) => {
+        current.data = Object.assign(Object.assign({}, current.data), { [item.id]: item });
+        current.order.push(item.id);
+        return current;
+    }, { data: {}, order: [] });
+};
+exports.collectionFromArray = collectionFromArray;
+const collectionToArray = ({ data, order }) => {
+    return order.map((id) => data[id]);
+};
+exports.collectionToArray = collectionToArray;
+const collectionReplaceItem = (collection, item) => {
+    return Object.assign(Object.assign({}, collection), { data: Object.assign(Object.assign({}, collection.data), { [item.id]: item }) });
+};
+exports.collectionReplaceItem = collectionReplaceItem;
+const collectionAddItem = (collection, item) => {
+    return Object.assign(Object.assign({}, collection), { data: Object.assign(Object.assign({}, collection.data), { [item.id]: item }), order: [...collection.order, item.id] });
+};
+exports.collectionAddItem = collectionAddItem;
+const collectionRemoveItem = (collection, item) => {
+    const data = Object.assign({}, collection.data);
+    Reflect.deleteProperty(data, item.id);
+    const order = collection.order.filter((id) => id !== item.id);
+    return Object.assign(Object.assign({}, collection), { data, order });
+};
+exports.collectionRemoveItem = collectionRemoveItem;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mattermost/types",
-  "version": "10.4.0",
+  "version": "10.5.0",
   "description": "Shared type definitions used by the Mattermost web app",
   "keywords": [
     "mattermost"