@atlaskit/collab-provider 20.0.16 → 20.0.17

package/dist/types-ts4.5/document/step-queue-state.d.ts

@@ -1,16 +0,0 @@
-import type { StepsPayload } from '../types';
-export declare class StepQueueState {
-    private queuePaused;
-    private queue;
-    queueSteps(data: StepsPayload): void;
-    getQueue: () => StepsPayload[];
-    filterQueue: (condition: (stepsPayload: StepsPayload) => boolean) => void;
-    /**
-     * Get whether the document service has stopped processing new steps whilst it carries out processes such as catchup.
-     * Exposed for testing
-     */
-    isPaused: () => boolean;
-    pauseQueue: () => void;
-    resumeQueue: () => void;
-    shift: () => StepsPayload | undefined;
-}

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

@@ -1,19 +0,0 @@
-export declare class Emitter<T = any> {
-    private eventEmitter;
-    /**
-     * Emit events to subscribers
-     */
-    protected emit<K extends keyof T>(evt: K, data: T[K]): this;
-    /**
-     * Subscribe to events emitted by this provider
-     */
-    on<K extends keyof T>(evt: K, handler: (args: T[K]) => void): this;
-    /**
-     * Unsubscribe from events emitted by this provider
-     */
-    off<K extends keyof T>(evt: K, handler: (args: T[K]) => void): this;
-    /**
-     * Unsubscribe from all events emitted by this provider.
-     */
-    unsubscribeAll<K extends keyof T>(evt?: K): this;
-}

package/dist/types-ts4.5/entry-points/provider.d.ts

@@ -1 +0,0 @@
-export { Provider } from '../provider/index';

package/dist/types-ts4.5/entry-points/socket-io-provider.d.ts

@@ -1 +0,0 @@
-export { createSocketIOCollabProvider, createSocketIOSocket } from '../socket-io-provider';

package/dist/types-ts4.5/entry-points/types.d.ts

@@ -1,2 +0,0 @@
-export { AcknowledgementResponseTypes } from '../types';
-export type { AcknowledgementErrorPayload, AcknowledgementPayload, AcknowledgementSuccessPayload, AddStepAcknowledgementPayload, AddStepAcknowledgementSuccessPayload, AuthCallback, BroadcastIncomingPayload, Catchupv2Options, Catchupv2Response, ChannelEvent, CollabEventDisconnectedData, Config, EventHandler, FetchAnonymousAsset, GenerateDiffStepsResponseBody, InitAndAuthData, InitPayload, InitialDraft, Lifecycle, LifecycleEvents, NamespaceStatus, PresenceData, PresencePayload, ProductInformation, ReconcileResponse, ReconnectionMetadata, Socket, StepsPayload, Storage, TelepointerPayload, } from '../types';

package/dist/types-ts4.5/entry-points/version-wrapper.d.ts

@@ -1 +0,0 @@
-export { name, nextMajorVersion, version } from '../version-wrapper';

package/dist/types-ts4.5/errors/custom-errors.d.ts

@@ -1,56 +0,0 @@
-import type { CantSyncUpErrorAttributes, DocumentUpdateErrorAttributes } from '../helpers/const';
-type ValidEventAttributeType = boolean | string | number | object;
-export declare class CustomError extends Error {
-    extraEventAttributes?: {
-        [key: string]: ValidEventAttributeType;
-    };
-    constructor(message: string, error?: unknown, extraEventAttributes?: {
-        [key: string]: ValidEventAttributeType;
-    });
-    toJSON(): {
-        name: string;
-        message: string;
-    };
-    getExtraErrorEventAttributes: () => {
-        [key: string]: ValidEventAttributeType;
-    } | undefined;
-}
-export declare class NotConnectedError extends CustomError {
-    name: string;
-}
-export declare class NotInitializedError extends CustomError {
-    name: string;
-}
-export declare class ProviderInitialisationError extends CustomError {
-    name: string;
-}
-export declare class SendTransactionError extends CustomError {
-    name: string;
-}
-export declare class DestroyError extends CustomError {
-    name: string;
-}
-export declare class SetTitleError extends CustomError {
-    name: string;
-}
-export declare class SetEditorWidthError extends CustomError {
-    name: string;
-}
-export declare class SetMetadataError extends CustomError {
-    name: string;
-}
-export declare class GetCurrentStateError extends CustomError {
-    name: string;
-}
-export declare class GetFinalAcknowledgedStateError extends CustomError {
-    name: string;
-}
-export declare class UpdateDocumentError extends CustomError {
-    name: string;
-    constructor(message: string, extraAttributes: DocumentUpdateErrorAttributes);
-}
-export declare class CantSyncUpError extends CustomError {
-    name: string;
-    constructor(message: string, extraAttributes: CantSyncUpErrorAttributes);
-}
-export {};

package/dist/types-ts4.5/errors/error-code-mapper.d.ts

@@ -1,3 +0,0 @@
-import type { InternalError } from './internal-errors';
-import type { ProviderError } from '@atlaskit/editor-common/collab';
-export declare const errorCodeMapper: (error: InternalError) => ProviderError | undefined;

package/dist/types-ts4.5/errors/internal-errors.d.ts

@@ -1,110 +0,0 @@
-import type { NCSErrors } from './ncs-errors';
-export declare enum INTERNAL_ERROR_CODE {
-    TOKEN_PERMISSION_ERROR = "TOKEN_PERMISSION_ERROR",
-    RECONNECTION_NETWORK_ISSUE = "RECONNECTION_NETWORK_ISSUE",
-    CONNECTION_ERROR = "CONNECTION_ERROR",
-    RECONNECTION_ERROR = "RECONNECTION_ERROR",
-    DOCUMENT_NOT_FOUND = "DOCUMENT_NOT_FOUND",
-    CATCHUP_FAILED = "CATCHUP_FAILED",
-    DOCUMENT_RESTORE_ERROR = "DOCUMENT_RESTORE_ERROR",
-    ADD_STEPS_ERROR = "ADD_STEPS_ERROR",
-    DOCUMENT_UPDATE_ERROR = "DOCUMENT_UPDATE_ERROR",
-    VIEW_ONLY_STEPS_ERROR = "VIEW_ONLY_STEPS_ERROR",
-    OUT_OF_SYNC_CLIENT_DATA_LOSS_EVENT = "OUT_OF_SYNC_CLIENT_DATA_LOSS_EVENT"
-}
-type DocumentRecoveryError = {
-    data: {
-        code: INTERNAL_ERROR_CODE.DOCUMENT_RESTORE_ERROR;
-        status: number;
-    };
-    message: string;
-};
-type AddStepsError = {
-    data: {
-        code: INTERNAL_ERROR_CODE.ADD_STEPS_ERROR;
-        status: number;
-    };
-    message: string;
-};
-type OutOfSyncClientDatalossEvent = {
-    data: {
-        code: INTERNAL_ERROR_CODE.OUT_OF_SYNC_CLIENT_DATA_LOSS_EVENT;
-        meta: {
-            reason?: string;
-        };
-    };
-    message: string;
-};
-export type CatchUpFailedError = {
-    data: {
-        code: INTERNAL_ERROR_CODE.CATCHUP_FAILED;
-        status: number;
-    };
-    message: string;
-};
-export type TokenPermissionError = {
-    data: {
-        code: INTERNAL_ERROR_CODE.TOKEN_PERMISSION_ERROR;
-        meta: {
-            originalError?: unknown;
-            reason?: string;
-        };
-        status: number;
-    };
-    message: string;
-};
-export type ReconnectionError = {
-    data: {
-        code: INTERNAL_ERROR_CODE.RECONNECTION_ERROR;
-        status: number;
-    };
-    message: string;
-};
-export type ConnectionError = {
-    data: {
-        code: INTERNAL_ERROR_CODE.CONNECTION_ERROR;
-    };
-    message: string;
-};
-export type ReconnectionNetworkError = {
-    data: {
-        code: INTERNAL_ERROR_CODE.RECONNECTION_NETWORK_ISSUE;
-    };
-    message: string;
-};
-export type DocumentNotFoundError = {
-    data: {
-        code: INTERNAL_ERROR_CODE.DOCUMENT_NOT_FOUND;
-        status: number;
-    };
-    message: string;
-};
-/**
- * When we try to apply state updates to the editor, if that fails to apply the user can enter an invalid state where no
- * changes can be saved to NCS.
- */
-export type InternalDocumentUpdateFailure = {
-    data: {
-        code: INTERNAL_ERROR_CODE.DOCUMENT_UPDATE_ERROR;
-        meta: {
-            editorVersion?: number;
-            newVersion?: number;
-        };
-        status: 500;
-    };
-    message: 'The provider failed to apply changes to the editor';
-};
-/**
- * When in view only mode, we should not generate any steps whatsoever.
- */
-export type ViewOnlyStepsError = {
-    data: {
-        code: INTERNAL_ERROR_CODE.VIEW_ONLY_STEPS_ERROR;
-    };
-    message: 'Attempted to send steps in view only mode';
-};
-/**
- * A union of all possible internal errors, that are mapped to another error if being emitted to the editor.
- */
-export type InternalError = NCSErrors | DocumentRecoveryError | AddStepsError | CatchUpFailedError | TokenPermissionError | ReconnectionError | ConnectionError | ReconnectionNetworkError | DocumentNotFoundError | InternalDocumentUpdateFailure | OutOfSyncClientDatalossEvent;
-export {};

package/dist/types-ts4.5/errors/ncs-errors.d.ts

@@ -1,184 +0,0 @@
-export declare enum NCS_ERROR_CODE {
-    HEAD_VERSION_UPDATE_FAILED = "HEAD_VERSION_UPDATE_FAILED",
-    VERSION_NUMBER_ALREADY_EXISTS = "VERSION_NUMBER_ALREADY_EXISTS",
-    INSUFFICIENT_EDITING_PERMISSION = "INSUFFICIENT_EDITING_PERMISSION",
-    FORBIDDEN_USER_TOKEN = "FORBIDDEN_USER_TOKEN",
-    DOCUMENT_NOT_FOUND = "DOCUMENT_NOT_FOUND",
-    INIT_DATA_LOAD_FAILED = "INIT_DATA_LOAD_FAILED",
-    ERROR_MAPPING_ERROR = "ERROR_MAPPING_ERROR",
-    NAMESPACE_INVALID = "NAMESPACE_INVALID",
-    NAMESPACE_NOT_FOUND = "NAMESPACE_NOT_FOUND",
-    TENANT_INSTANCE_MAINTENANCE = "TENANT_INSTANCE_MAINTENANCE",
-    LOCKED_DOCUMENT = "LOCKED_DOCUMENT",
-    EMPTY_BROADCAST = "EMPTY_BROADCAST",
-    DYNAMO_ERROR = "DYNAMO_ERROR",
-    INVALID_ACTIVATION_ID = "INVALID_ACTIVATION_ID",
-    INVALID_DOCUMENT_ARI = "INVALID_DOCUMENT_ARI",
-    INVALID_CLOUD_ID = "INVALID_CLOUD_ID",
-    RATE_LIMIT_ERROR = "RATE_LIMIT_ERROR",
-    PROSEMIRROR_SCHEMA_VALIDATION_ERROR = "PROSEMIRROR_SCHEMA_VALIDATION_ERROR"
-}
-type HeadVersionUpdateFailedError = {
-    data: {
-        code: NCS_ERROR_CODE.HEAD_VERSION_UPDATE_FAILED;
-        meta: {
-            currentVersion: any;
-            incomingVersion: number;
-        };
-        status: number;
-    };
-    message: string;
-};
-type VersionAlreadyPresentInDynamoError = {
-    data: {
-        code: NCS_ERROR_CODE.VERSION_NUMBER_ALREADY_EXISTS;
-        meta: string;
-        status: number;
-    };
-    message: string;
-};
-type InsufficientEditingPermissionError = {
-    data: {
-        code: NCS_ERROR_CODE.INSUFFICIENT_EDITING_PERMISSION;
-        meta: {
-            description: string;
-            reason?: string;
-        };
-        status: number;
-    };
-    message: string;
-};
-type ForbiddenUserTokenError = {
-    data: {
-        code: NCS_ERROR_CODE.FORBIDDEN_USER_TOKEN;
-        meta: string;
-        status: number;
-    };
-    message: string;
-};
-type NCSDocumentNotFoundError = {
-    data: {
-        code: NCS_ERROR_CODE.DOCUMENT_NOT_FOUND;
-        status: number;
-    };
-    message: string;
-};
-type FailedToLoadInitDataError = {
-    data: {
-        code: NCS_ERROR_CODE.INIT_DATA_LOAD_FAILED;
-        status: number;
-    };
-    message: string;
-};
-/**
- * The backend has retrieved the document successfully, as ADF, but failed to convert it to Prosemirror.
- * This might be because invalid ADF has been written to a document, as it was not validated correctly.
- */
-type ProsemirrorSchemaValidationError = {
-    data: {
-        code: NCS_ERROR_CODE.PROSEMIRROR_SCHEMA_VALIDATION_ERROR;
-        status: number;
-    };
-    message: string;
-};
-type ErrorMappingError = {
-    data: {
-        code: NCS_ERROR_CODE.ERROR_MAPPING_ERROR;
-        status: number;
-    };
-    message: string;
-};
-type InvalidNamespaceDefinedError = {
-    data: {
-        code: NCS_ERROR_CODE.NAMESPACE_INVALID;
-        meta: string;
-        status: number;
-    };
-    message: string;
-};
-type SocketNamespaceNotFoundError = {
-    data: {
-        code: NCS_ERROR_CODE.NAMESPACE_NOT_FOUND;
-        meta: string;
-        status: number;
-    };
-    message: string;
-};
-type TenantInstanceMaintenanceError = {
-    data: {
-        code: NCS_ERROR_CODE.TENANT_INSTANCE_MAINTENANCE;
-        meta: {
-            description: string;
-            reason: string;
-        };
-        status: number;
-    };
-    message: string;
-};
-type NamespaceLockedError = {
-    data: {
-        code: NCS_ERROR_CODE.LOCKED_DOCUMENT;
-        meta: string;
-        status: number;
-    };
-    message: string;
-};
-type EmptyBroadcastError = {
-    data: {
-        code: NCS_ERROR_CODE.EMPTY_BROADCAST;
-        meta: string;
-        status: number;
-    };
-    message: string;
-};
-type DynamoError = {
-    data: {
-        code: NCS_ERROR_CODE.DYNAMO_ERROR;
-        meta: string;
-        status: number;
-    };
-    message: string;
-};
-type InvalidActivationIdError = {
-    data: {
-        code: NCS_ERROR_CODE.INVALID_ACTIVATION_ID;
-        meta: string;
-        status: number;
-    };
-    message: string;
-};
-type InvalidDocumentAriError = {
-    data: {
-        code: NCS_ERROR_CODE.INVALID_DOCUMENT_ARI;
-        meta: string;
-        status: number;
-    };
-    message: string;
-};
-type InvalidCloudIdError = {
-    data: {
-        code: NCS_ERROR_CODE.INVALID_CLOUD_ID;
-        meta: string;
-        status: number;
-    };
-    message: string;
-};
-/**
- * The client is trying to send too many messages or messages that are too large. This not expected to be a standard
- * operating condition and should only ever indicate a frontend bug.
- */
-export type RateLimitError = {
-    data: {
-        code: NCS_ERROR_CODE.RATE_LIMIT_ERROR;
-        meta: {
-            maxStepSize: number;
-            rateLimitType: number;
-            stepCounter: number;
-            stepSizeCounter: number;
-        };
-        status: 500;
-    };
-    message: string;
-};
-export type NCSErrors = HeadVersionUpdateFailedError | VersionAlreadyPresentInDynamoError | InsufficientEditingPermissionError | ForbiddenUserTokenError | NCSDocumentNotFoundError | FailedToLoadInitDataError | ErrorMappingError | InvalidNamespaceDefinedError | SocketNamespaceNotFoundError | TenantInstanceMaintenanceError | NamespaceLockedError | EmptyBroadcastError | DynamoError | InvalidActivationIdError | InvalidDocumentAriError | InvalidCloudIdError | RateLimitError | ProsemirrorSchemaValidationError;
-export {};

package/dist/types-ts4.5/feature-flags/index.d.ts

@@ -1,9 +0,0 @@
-import type { NCSFeatureFlags, RequiredNCSFeatureFlags, SupportedProduct } from './types';
-/**
- * Takes a record of {NCS Feature Flag Names → boolean} and a supported product name.
- * Returns the corresponding product’s Launch Darkly Keys for each of the flags set as true in the input record.
- * */
-export declare const getProductSpecificFeatureFlags: (flags: RequiredNCSFeatureFlags, product: SupportedProduct) => Array<string>;
-export declare function getCollabProviderFeatureFlag<T = boolean>(flagName: keyof NCSFeatureFlags, featureFlags?: {
-    [key: string]: boolean;
-}): T;

package/dist/types-ts4.5/feature-flags/types.d.ts

@@ -1,13 +0,0 @@
-export interface NCSFeatureFlags {
-    testFF?: boolean;
-}
-export interface WithNCSFeatureFlags {
-    featureFlags?: NCSFeatureFlags;
-}
-export type RequiredNCSFeatureFlags = Record<keyof Required<NCSFeatureFlags>, boolean>;
-export type NCSFeatureFlagsMap = Record<keyof Required<NCSFeatureFlags>, string>;
-export declare const supportedProducts: readonly [
-    "confluence"
-];
-export type SupportedProduct = (typeof supportedProducts)[number];
-export type ProductKeys = Record<SupportedProduct, NCSFeatureFlagsMap>;