@claspo/editor 1.0.13 → 1.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@claspo/editor",
-  "version": "1.0.13",
+  "version": "1.0.15",
   "description": "Claspo Editor SDK and types",
   "main": "src/index.js",
   "types": "src/index.d.ts",
@@ -19,6 +19,7 @@
     "build:types": "node scripts/build-types.js && node scripts/types-postprocessing.js && node scripts/generate-enum-values.js",
     "build:docs": "typedoc --options typedoc.md.json && node scripts/postprocess-md.js && node scripts/add-frontmatter.js",
     "build:all": "npm run build:types && npm run build:docs",
+    "sync:docs": "node ../../../scripts/sync-docs.js --package=editor",
 
     "generate-reexports": "echo 'DO NOT CALL IT, WILL REWRITE editor-config.interface.ts' && node scripts/generate-esng-reexports.js"
   },
@@ -29,8 +30,8 @@
   },
   "peerDependencies": {
     "rxjs": ">=6.0.0",
-    "@claspo/common": "6.0.6",
-    "@claspo/document-connector": "15.0.5"
+    "@claspo/common": "6.0.14",
+    "@claspo/document-connector": "15.0.12"
   },
   "peerDependenciesMeta": {
     "rxjs": { "optional": true }

package/src/index.js

@@ -44,7 +44,7 @@ exports.ClComponentSyncState = Object.freeze({
   ONLY_THIS_CROSS_ENV_WHILE_VALUES_MATCH: "ONLY_THIS_CROSS_ENV_WHILE_VALUES_MATCH",
 });
 
-exports.PlacementInsertType = Object.freeze({
+exports.WidgetPlacementInsertType = Object.freeze({
   BEFORE_BEGIN: "BEFORE_BEGIN",
   AFTER_BEGIN: "AFTER_BEGIN",
   BEFORE_END: "BEFORE_END",
@@ -76,38 +76,12 @@ exports.ContactMappingOptionType = Object.freeze({
   UNKNOWN: "unknown",
 });
 
-exports.FormPublishStatus = Object.freeze({
+exports.WidgetPublishStatus = Object.freeze({
   FOR_ALL: "FOR_ALL",
   PAUSED: "PAUSED",
   DEBUG: "DEBUG",
 });
 
-exports.FormTestingStatus = Object.freeze({
-  TESTING: "TESTING",
-  OFF: "OFF",
-});
-
-exports.EsWidgetLayoutType = Object.freeze({
-  BUILT_IN: "BUILT_IN",
-  DETACHED: "DETACHED",
-  FLOATING_BOX: "FLOATING_BOX",
-  FLOATING_BAR: "FLOATING_BAR",
-  LAUNCHER: "LAUNCHER",
-  CONTENT_LOCKER: "CONTENT_LOCKER",
-  SLIDE_UP: "SLIDE_UP",
-  POP_UP: "POP_UP",
-  BOTTOM_BAR: "BOTTOM_BAR",
-});
-
-exports.EsWidgetType = Object.freeze({
-  SUBSCRIPTION_FORM: "SUBSCRIPTION_FORM",
-  INFORMER: "INFORMER",
-  REQUEST_FORM: "REQUEST_FORM",
-  LAUNCHER: "LAUNCHER",
-  AGE_VERIFY: "AGE_VERIFY",
-  TEASER: "TEASER",
-});
-
 exports.EsFormIntegrationType = Object.freeze({
   WEBHOOK: "webhook",
   EMBEDDED: "embedded",

package/src/types.d.ts

@@ -1,6 +1,9 @@
+import { ComponentManifestI } from '@claspo/common/component-manifest/ComponentManifest.interface';
 import { ClPropertyPaneManifestModelName } from '@claspo/common/component-manifest/PropertyPaneManifest.interface';
-import { ClBaseComponentI, ClComponentType, ClDocumentActionType, ClDocumentI as CommonDocumentI, ClDocumentSharedI as CommonDocumentSharedI } from '@claspo/common/document/Document.interface';
+import { ClBaseComponentI, ClBaseComponentI as ClBaseComponentI$1, ClComponentType, ClDocumentActionType, ClDocumentI as CommonDocumentI, ClDocumentSharedI as CommonDocumentSharedI } from '@claspo/common/document/Document.interface';
+import { LayoutType, LayoutType as LayoutType$1 } from '@claspo/common/LayoutType';
 import { PrizePoolModelI, PrizePoolOptionI } from '@claspo/common/PrizePool.interface';
+import { WidgetType, WidgetType as WidgetType$1 } from '@claspo/common/WidgetType';
 import LayoutFactory from '@claspo/document-connector/layouts/LayoutFactory';
 import { Observable } from 'rxjs';
 declare enum BaseListSortOption {
@@ -64,7 +67,31 @@ export interface ClComponentSyncMapI {
 	syncState: ClComponentSyncState | null;
 	env?: ClPreviewEnvironment;
 }
-declare enum PlacementInsertType {
+export interface BaseListDtoI<T> {
+	totalCount: number;
+	items: T[];
+}
+export interface UserInfoI {
+	userId: number;
+	userName: string;
+	language: string;
+}
+export interface ComponentTranslateMapI {
+	[propPath: string]: string;
+}
+export interface LanguageTranslateState {
+	[id: string]: ComponentTranslateMapI;
+}
+export interface TranslateRequestI {
+	json: TranslateRequestJsonI;
+	sourceLanguage: string;
+	targetLanguage: string;
+}
+export interface TranslateRequestJsonI {
+	widgetTranslations: LanguageTranslateState;
+	teaserTranslations?: LanguageTranslateState;
+}
+declare enum WidgetPlacementInsertType {
 	BEFORE_BEGIN = "BEFORE_BEGIN",
 	AFTER_BEGIN = "AFTER_BEGIN",
 	BEFORE_END = "BEFORE_END",
@@ -132,84 +159,49 @@ export interface ContactMappingOptionLimitsI {
 	MIN_VALUE?: number;
 	ANNUAL?: boolean;
 }
-export interface FormsListItemI {
+export interface WidgetsListItemI {
 	id: number;
 	name: string;
-	publishStatus: FormPublishStatus;
-	testingStatus: FormTestingStatus;
-	fullyConfigured: boolean;
+	publishStatus: WidgetPublishStatus;
 	createdDate: string;
 	updatedDate: string;
-	draft: boolean;
 	variantIds: number[];
-	abTestId: number | null;
-	config: EsFormVariantI;
-	restrictions?: EsFormRestrictionI;
-	deleted?: boolean;
+	config: WidgetVariantDtoI;
 }
-export declare enum FormPublishStatus {
+export declare enum WidgetPublishStatus {
 	FOR_ALL = "FOR_ALL",
 	PAUSED = "PAUSED",// teaser disabled. Any other status means that teaser is enabled and status works as usual
 	DEBUG = "DEBUG"
 }
-declare enum FormTestingStatus {
-	TESTING = "TESTING",
-	OFF = "OFF"
-}
-export interface EsFormI {
+export interface WidgetModelI {
 	id: number;
 	name: string;
-	publishStatus: FormPublishStatus;
+	publishStatus: WidgetPublishStatus;
 	createdDate: string;
 	updatedDate: string;
-	variants: EsFormVariantI[];
-	config: EsFormVariantI;
+	variants: WidgetVariantDtoI[];
+	config: WidgetVariantDtoI;
 }
-export interface EsFormRestrictionI {
-	BRANDED?: EsFormBrandingI;
-}
-export interface EsFormBrandingI {
-	reason?: string;
-}
-export interface EsFormVariantI {
+export interface WidgetVariantDtoI {
 	formId: number;
 	id: number;
-	config: EsFormVariantConfigI;
-	appearances: EsFormVariantAppearanceI[];
+	config: WidgetVariantConfigDtoI;
+	appearances: WidgetAppearanceBriefI[];
 	linkedToVariantId: number;
-	type: EsWidgetType;
+	type: WidgetType;
 	revision?: string;
 	publishedRevision?: string;
 }
-export interface EsFormVariantConfigI {
-	type: EsWidgetLayoutType;
-	placements?: EsFormVariantPlacementI[];
+export interface WidgetVariantConfigDtoI {
+	type: LayoutType$1;
+	placements?: WidgetPlacementI[];
 	prizePoolIds?: string[];
 }
-export declare enum EsWidgetLayoutType {
-	BUILT_IN = "BUILT_IN",
-	DETACHED = "DETACHED",
-	FLOATING_BOX = "FLOATING_BOX",
-	FLOATING_BAR = "FLOATING_BAR",
-	LAUNCHER = "LAUNCHER",
-	CONTENT_LOCKER = "CONTENT_LOCKER",
-	SLIDE_UP = "SLIDE_UP",
-	POP_UP = "POP_UP",
-	BOTTOM_BAR = "BOTTOM_BAR"
-}
-export declare enum EsWidgetType {
-	SUBSCRIPTION_FORM = "SUBSCRIPTION_FORM",
-	INFORMER = "INFORMER",
-	REQUEST_FORM = "REQUEST_FORM",
-	LAUNCHER = "LAUNCHER",
-	AGE_VERIFY = "AGE_VERIFY",
-	TEASER = "TEASER"
-}
-export interface EsFormVariantPlacementI {
+export interface WidgetPlacementI {
 	selector: string | null;
-	insertType: PlacementInsertType | null;
+	insertType: WidgetPlacementInsertType | null;
 }
-export interface EsFormVariantAppearanceI {
+export interface WidgetAppearanceBriefI {
 	id: number | string;
 	language: string | null;
 	origin: boolean | null;
@@ -232,7 +224,7 @@ export interface EsFormIntegrationParamsI {
 	uuid: string;
 	consumers?: string[];
 }
-export interface EsFormAppearanceI {
+export interface WidgetAppearanceI {
 	id: number | string;
 	origin: boolean;
 	language: string | null;
@@ -244,64 +236,40 @@ export interface EsFormAppearanceI {
 	revision?: string;
 	publishedRevision?: string;
 }
-export interface FormLanguageI {
+export interface WidgetLanguageI {
 	languageCode: string;
 	name: string;
 	localisation: MessageLanguageLocalisationI;
 }
-export interface FormVariantI {
+export interface WidgetVariantI {
 	formId: number;
 	id: number;
-	config: FormVariantConfigI;
-	appearances: EsFormVariantAppearanceI[];
+	config: WidgetVariantConfigI;
+	appearances: WidgetAppearanceBriefI[];
 	linkedToVariantId: number | null;
-	type: EsWidgetType;
+	type: WidgetType;
 	revision: string | null;
 	publishedRevision: string | null;
 }
-export interface FormVariantConfigI {
-	type: EsWidgetLayoutType;
-	placements: EsFormVariantPlacementI[];
+export interface WidgetVariantConfigI {
+	type: LayoutType$1;
+	placements: WidgetPlacementI[];
 	prizePoolIds?: string[];
 }
-export interface BaseListDtoI<T> {
-	totalCount: number;
-	items: T[];
-}
-export interface UserInfoI {
-	userId: number;
-	userName: string;
-	language: string;
-}
-export interface ComponentTranslateMapI {
-	[propPath: string]: string;
-}
-export interface LanguageTranslateState {
-	[id: string]: ComponentTranslateMapI;
-}
-export interface TranslateRequestI {
-	json: TranslateRequestJsonI;
-	sourceLanguage: string;
-	targetLanguage: string;
-}
-export interface TranslateRequestJsonI {
-	widgetTranslations: LanguageTranslateState;
-	teaserTranslations?: LanguageTranslateState;
-}
 export interface CreateWidgetRevisionRequestI {
 	changesSaved: boolean;
 	payload: WidgetRevisionPayloadI;
 }
 export interface WidgetRevisionPayloadI {
-	type: EsWidgetType;
+	type: WidgetType;
 	presentation: WidgetRevisionPresentationI;
 	appearances: WidgetRevisionAppearanceI[];
 	prizePoolIds?: string[];
-	publishStatus?: FormPublishStatus;
+	publishStatus?: WidgetPublishStatus;
 	linkedTo?: number | null;
 }
 export interface WidgetRevisionPresentationI {
-	type: EsWidgetLayoutType;
+	type: LayoutType$1;
 }
 export interface WidgetRevisionAppearanceI {
 	id: number | string;
@@ -338,16 +306,16 @@ export declare enum WidgetProjectConfigId {
 	CABINET_AB_TESTS = "CABINET_AB_TESTS"
 }
 export interface BaseFormsListRequestParamsI {
-	layoutTypes?: EsWidgetLayoutType[];
+	layoutTypes?: LayoutType$1[];
 	order?: BaseListOrderOption;
 	search?: string;
 	offset?: number;
 	limit?: number;
 	sort?: BaseListSortOption;
-	types?: EsWidgetType[];
+	types?: WidgetType[];
 	projectId?: number;
 	filters?: FormListRequestFilter;
-	publishStatus?: FormPublishStatus;
+	publishStatus?: WidgetPublishStatus;
 	publishDateFrom?: string;
 	publishDateTo?: string;
 	withDeleted?: boolean;
@@ -361,14 +329,14 @@ declare enum FormListRequestFilter {
 export interface CreateFormParamsI {
 	name: string;
 	variant: CreateFormParamsVariantI;
-	publishStatus?: FormPublishStatus;
+	publishStatus?: WidgetPublishStatus;
 }
 export interface CreateFormParamsVariantI {
 	description: string;
-	type: EsWidgetType;
-	config: EsFormVariantConfigI;
+	type: WidgetType;
+	config: WidgetVariantConfigDtoI;
 	integration: EsFormVariantIntegrationV2I | null;
-	appearances: EsFormAppearanceI[];
+	appearances: WidgetAppearanceI[];
 	draft: boolean;
 	linkedToVariantId?: number;
 }
@@ -526,7 +494,7 @@ export interface EditorConfigI {
 	/** Available languages for multilingual versions of the same widget
 	 * @default A set of popular languages will be used
 	 * */
-	languagesForMultilingualVersions?: FormLanguageI[];
+	languagesForMultilingualVersions?: WidgetLanguageI[];
 	/**
 	 * Callback fired on initial data loading errors.
 	 * If not provided, default error UI will be shown.
@@ -694,7 +662,7 @@ export interface TeaserFeatureConfigI {
 	/** Default document model for new teasers */
 	defaultDocumentModel: ClDocumentI;
 	/** Layouts where teaser is available */
-	enabledForLayouts?: EsWidgetLayoutType[];
+	enabledForLayouts?: LayoutType[];
 	/** Component panel configuration for teaser editor */
 	availableComponentsPanel?: AvailableComponentsPanelConfigI;
 }
@@ -703,18 +671,18 @@ export interface TeaserFeatureConfigI {
  */
 export interface CloseEditorCallbackPayloadI {
 	/** Current widget variant data */
-	variant: FormVariantI;
+	variant: WidgetVariantI;
 }
 /**
  * Payload passed to {@link EditorConfigI.getRevisionPayloadCallback}.
  */
 export interface GetRevisionPayloadCallbackPayloadI {
 	/** Current widget variant */
-	variant: FormVariantI;
+	variant: WidgetVariantI;
 	/** All widget appearances (desktop, mobile, etc.) */
-	appearances: EsFormAppearanceI[];
+	appearances: WidgetAppearanceI[];
 	/** Current publish status */
-	publishStatus: FormPublishStatus | null;
+	publishStatus: WidgetPublishStatus | null;
 }
 /**
  * Payload passed to {@link EditorConfigI.initialLoadErrorCallback}.
@@ -960,7 +928,7 @@ export interface ResolvedDataI {
 	/** Teaser (minimized widget) data, if enabled */
 	teaserData: ResolvedWidgetDataI | null;
 	/** List of widgets that can be linked */
-	linkedWidgets: FormsListItemI[];
+	linkedWidgets: WidgetsListItemI[];
 	/** Prize pools for gamification widgets */
 	prizePools?: PrizePoolModelI[];
 }
@@ -969,15 +937,15 @@ export interface ResolvedDataI {
  */
 export interface ResolvedWidgetDataI {
 	/** Widget variant (form) data */
-	variant: EsFormVariantI;
+	variant: WidgetVariantDtoI;
 	/** All appearances (desktop, mobile, etc.) */
-	appearances: EsFormAppearanceI[];
+	appearances: WidgetAppearanceI[];
 	/** Latest saved revision */
 	latestRevision: WidgetRevisionI | null;
 	/** Currently loaded revision */
 	currentRevision: WidgetRevisionI | null;
 	/** Current publish status */
-	publishStatus: FormPublishStatus | null;
+	publishStatus: WidgetPublishStatus | null;
 }
 /**
  * Data passed to {@link EditorApiConfigI.saveWidgetData}.
@@ -1000,15 +968,15 @@ export interface DataToSaveI {
  */
 export interface WidgetDataToSaveI {
 	/** Original appearances (for comparison) */
-	pristineAppearances: EsFormAppearanceI[];
+	pristineAppearances: WidgetAppearanceI[];
 	/** Modified appearances */
-	updatedAppearances: EsFormAppearanceI[];
+	updatedAppearances: WidgetAppearanceI[];
 	/** Original variant (for comparison) */
-	pristineVariant: FormVariantI;
+	pristineVariant: WidgetVariantI;
 	/** Modified variant */
-	updatedVariant: FormVariantI;
+	updatedVariant: WidgetVariantI;
 	/** Current publish status */
-	publishStatus: FormPublishStatus | null;
+	publishStatus: WidgetPublishStatus | null;
 }
 /**
  * HTTP API configuration for all editor operations.
@@ -1032,11 +1000,11 @@ export interface EditorApiConfigI {
 	/** Save widget data (appearances, variant, configs) */
 	saveWidgetData: (data: DataToSaveI) => Observable<void> | Promise<void>;
 	/** Fetch appearances for a specific widget */
-	getWidgetAppearances: (payload: GetWidgetAppearancesPayloadI) => Observable<EsFormAppearanceI[]> | Promise<EsFormAppearanceI[]>;
+	getWidgetAppearances: (payload: GetWidgetAppearancesPayloadI) => Observable<WidgetAppearanceI[]> | Promise<WidgetAppearanceI[]>;
 	/** Create a new widget revision (save point) */
 	createWidgetRevision: (payload: CreateWidgetRevisionPayloadI) => Observable<CreateWidgetRevisionResponseI> | Promise<CreateWidgetRevisionResponseI>;
 	/** Fetch list of widgets for linking */
-	getWidgetsList: (params: BaseFormsListRequestParamsI) => Observable<BaseListDtoI<FormsListItemI>> | Promise<BaseListDtoI<FormsListItemI>>;
+	getWidgetsList: (params: BaseFormsListRequestParamsI) => Observable<BaseListDtoI<WidgetsListItemI>> | Promise<BaseListDtoI<WidgetsListItemI>>;
 	/** Get files from common directory (icons, backgrounds, etc.) */
 	getFilesFromCommonDir: (payload: GetFilesFromCommonDirPayloadI) => Observable<Array<{
 		url: string;
@@ -1181,9 +1149,9 @@ export interface GetTemplatePayloadI {
  */
 export interface CreateWidgetResponseI {
 	/** Created widget variant */
-	variant: FormVariantI;
+	variant: WidgetVariantI;
 	/** Created widget appearances */
-	appearances: EsFormAppearanceI[];
+	appearances: WidgetAppearanceI[];
 }
 /**
  * Logo configuration for the editor header.
@@ -1229,8 +1197,10 @@ export interface ClContactMappingOptionI {
 }
 
 export {
+	LayoutType,
 	PrizePoolModelI,
 	PrizePoolOptionI,
+	WidgetType$1 as WidgetType,
 };
 
 export {};