@cntrl-site/sdk 1.28.0-2 → 1.28.0-4

package/lib/types/article/Item.d.ts

@@ -1,10 +1,10 @@
-import { RichTextBlock, RichTextStyle, TextAlign, TextTransform, VerticalAlign } from './RichText';
 import { ArticleItemType } from './ArticleItemType';
-import { AreaAnchor, ItemArea } from './ItemArea';
+import { ItemArea } from './ItemArea';
 import { ItemState } from './ItemState';
-import { FXControlAny } from './FX';
 import { CompoundSettings } from './CompoundSettings';
+import { StickyParams, Link, ImageCommonParams, VideoCommonParams, RichTextCommonParams, RectangleCommonParams, VimeoEmbedCommonParams, YoutubeEmbedCommonParams, CustomCommonParams, GroupCommonParams, CompoundCommonParams, CodeEmbedCommonParams, ComponentCommonParams, ImageLayoutParams, VideoLayoutParams, RichTextLayoutParams, RectangleLayoutParams, VimeoEmbedLayoutParams, YoutubeEmbedLayoutParams, CustomLayoutParams, GroupLayoutParams, CompoundLayoutParams, CodeEmbedLayoutParams, ComponentLayoutParams } from './Params.type';
 export type ItemAny = Item<ArticleItemType>;
+type LayoutIdentifier = string;
 export interface Item<T extends ArticleItemType> {
     id: string;
     type: T;
@@ -44,213 +44,6 @@ export interface ItemLayoutParamsMap {
     [ArticleItemType.CodeEmbed]: CodeEmbedLayoutParams;
     [ArticleItemType.Component]: ComponentLayoutParams;
 }
-interface CommonParamsBase {
-    pointerEvents?: 'never' | 'when_visible' | 'always';
-}
-export interface MediaCommonParams extends CommonParamsBase {
-    url: string;
-    hasGLEffect?: boolean;
-    fragmentShader: string | null;
-    FXControls?: FXControlAny[];
-    FXTextures?: string[];
-}
-interface VideoCommonParams extends MediaCommonParams {
-    coverUrl: string | null;
-    scrollPlaybackFrameData?: ScrollPlaybackFrameData | null;
-}
-interface ImageCommonParams extends MediaCommonParams {
-}
-interface RichTextCommonParams extends CommonParamsBase {
-    text: string;
-    blocks?: RichTextBlock[];
-}
-interface RectangleCommonParams extends CommonParamsBase {
-    ratioLock: boolean;
-}
-interface CustomCommonParams extends CommonParamsBase {
-    name: string;
-}
-interface GroupCommonParams extends CommonParamsBase {
-}
-interface CompoundCommonParams extends CommonParamsBase {
-    overflow: 'hidden' | 'visible';
-}
-interface CodeEmbedCommonParams extends CommonParamsBase {
-    html: string;
-    scale: boolean;
-    iframe: boolean;
-}
-export interface VimeoEmbedCommonParams extends CommonParamsBase {
-    url: string;
-    coverUrl: string | null;
-}
-export interface YoutubeEmbedCommonParams extends CommonParamsBase {
-    url: string;
-    coverUrl: string | null;
-}
-interface ComponentCommonParams extends CommonParamsBase {
-    componentId: string;
-    content?: any;
-    parameters?: Record<string, any>;
-}
-export interface MediaLayoutParams {
-    opacity: number;
-    radius: number;
-    strokeWidth: number;
-    strokeFill: FillLayer[];
-    blur: number;
-    isDraggable?: boolean;
-    blendMode?: string;
-}
-interface CustomLayoutParams {
-    isDraggable?: boolean;
-    blendMode?: string;
-}
-interface GroupLayoutParams {
-    opacity: number;
-    blur: number;
-    isDraggable?: boolean;
-    blendMode?: string;
-}
-interface CompoundLayoutParams {
-    opacity: number;
-    isDraggable?: boolean;
-    blendMode?: string;
-}
-interface CodeEmbedLayoutParams {
-    areaAnchor: AreaAnchor;
-    opacity: number;
-    blur: number;
-    isDraggable?: boolean;
-    blendMode?: string;
-}
-export interface VimeoEmbedLayoutParams {
-    play: 'on-hover' | 'on-click' | 'auto';
-    controls: boolean;
-    loop: boolean;
-    muted: boolean;
-    pictureInPicture: boolean;
-    radius: number;
-    blur: number;
-    opacity: number;
-    blendMode?: string;
-}
-export interface YoutubeEmbedLayoutParams {
-    play: 'on-hover' | 'on-click' | 'auto';
-    controls: boolean;
-    loop: boolean;
-    radius: number;
-    blur: number;
-    opacity: number;
-    blendMode?: string;
-}
-interface ImageLayoutParams extends MediaLayoutParams {
-}
-interface VideoLayoutParams extends MediaLayoutParams {
-    play: 'on-hover' | 'on-click' | 'auto';
-    muted: boolean;
-    controls: boolean;
-    scrollPlayback: ScrollPlaybackParams | null;
-}
-interface RichTextLayoutParams {
-    rangeStyles?: RichTextStyle[];
-    textAlign: TextAlign;
-    sizing: string;
-    blur: number;
-    fontSize: number;
-    lineHeight: number;
-    letterSpacing: number;
-    wordSpacing: number;
-    textTransform: TextTransform;
-    verticalAlign: VerticalAlign;
-    color: string;
-    typeFace: string;
-    fontStyle: string;
-    fontWeight: number;
-    fontVariant: string;
-    isDraggable?: boolean;
-    blendMode?: string;
-}
-interface RectangleLayoutParams {
-    radius: number;
-    strokeWidth: number;
-    fill: FillLayer[];
-    strokeFill: FillLayer[];
-    blur: number;
-    backdropBlur: number;
-    blurMode: 'default' | 'backdrop';
-    isDraggable?: boolean;
-    blendMode?: string;
-}
-export type FillLayer = SolidFillLayer | LinearGradientFillLayer | RadialGradientFillLayer | ConicGradientFillLayer | ImageLayer;
-type ColorPoint = {
-    id: string;
-    value: string;
-    position: number;
-};
-export type SolidFillLayer = {
-    id: string;
-    type: 'solid';
-    value: string;
-};
-export type LinearGradientFillLayer = {
-    id: string;
-    type: 'linear-gradient';
-    colors: ColorPoint[];
-    start: [number, number];
-    end: [number, number];
-    angle: number;
-};
-export type RadialGradientFillLayer = {
-    id: string;
-    type: 'radial-gradient';
-    colors: ColorPoint[];
-    diameter: number;
-    center: [number, number];
-    angle: number;
-};
-export type ConicGradientFillLayer = {
-    id: string;
-    type: 'conic-gradient';
-    colors: ColorPoint[];
-    center: [number, number];
-    angle: number;
-};
-export type ImageLayer = {
-    id: string;
-    type: 'image';
-    src: string;
-    behavior: string;
-    backgroundSize: number;
-    opacity: number;
-    rotation?: number;
-};
-export interface ScrollPlaybackParams {
-    from: number;
-    to: number;
-}
-export interface ScrollPlaybackFrameData {
-    status: 'processing' | 'ready' | 'error';
-    batchId?: string;
-    frameCount?: number;
-    frameRate?: number;
-    framesUrl?: string;
-    frameFormat?: string;
-}
-export interface StickyParams {
-    from: number;
-    to?: number;
-}
-export interface Link {
-    url: string;
-    target: string;
-}
-type LayoutIdentifier = string;
-export interface ComponentLayoutParams {
-    parameters?: any;
-    opacity: number;
-    blur: number;
-}
 export type VideoItem = Item<ArticleItemType.Video>;
 export type RectangleItem = Item<ArticleItemType.Rectangle>;
 export type ImageItem = Item<ArticleItemType.Image>;

package/lib/types/article/ItemState.d.ts

@@ -1,5 +1,5 @@
 import { ArticleItemType } from './ArticleItemType';
-import { FillLayer } from './Item';
+import { FillLayer } from './Params.type';
 import { StructuredBlockType } from './StructuredBlockType';
 type StateId = string;
 export type ItemState<T extends ArticleItemType | StructuredBlockType> = Record<StateId, ItemStatesMap[T]>;

package/lib/types/article/Params.type.d.ts

@@ -0,0 +1,211 @@
+import { FXControlAny } from './FX';
+import { AreaAnchor } from './ItemArea';
+import { RichTextBlock, RichTextStyle, TextAlign, TextTransform, VerticalAlign } from './RichText';
+interface CommonParamsBase {
+    pointerEvents?: 'never' | 'when_visible' | 'always';
+}
+export interface MediaCommonParams extends CommonParamsBase {
+    url: string;
+    hasGLEffect?: boolean;
+    fragmentShader: string | null;
+    FXControls?: FXControlAny[];
+    FXTextures?: string[];
+}
+export interface VideoCommonParams extends MediaCommonParams {
+    coverUrl: string | null;
+    scrollPlaybackFrameData?: ScrollPlaybackFrameData | null;
+}
+export interface ImageCommonParams extends MediaCommonParams {
+}
+export interface RichTextCommonParams extends CommonParamsBase {
+    text: string;
+    blocks?: RichTextBlock[];
+}
+export interface RectangleCommonParams extends CommonParamsBase {
+    ratioLock: boolean;
+}
+export interface CustomCommonParams extends CommonParamsBase {
+    name: string;
+}
+export interface GroupCommonParams extends CommonParamsBase {
+}
+export interface CompoundCommonParams extends CommonParamsBase {
+    overflow: 'hidden' | 'visible';
+}
+export interface CodeEmbedCommonParams extends CommonParamsBase {
+    html: string;
+    scale: boolean;
+    iframe: boolean;
+}
+export interface VimeoEmbedCommonParams extends CommonParamsBase {
+    url: string;
+    coverUrl: string | null;
+}
+export interface YoutubeEmbedCommonParams extends CommonParamsBase {
+    url: string;
+    coverUrl: string | null;
+}
+export interface ComponentCommonParams extends CommonParamsBase {
+    componentId: string;
+    content?: any;
+    parameters?: Record<string, any>;
+}
+export interface MediaLayoutParams {
+    opacity: number;
+    radius: number;
+    strokeWidth: number;
+    strokeFill: FillLayer[];
+    blur: number;
+    isDraggable?: boolean;
+    blendMode?: string;
+}
+export interface CustomLayoutParams {
+    isDraggable?: boolean;
+    blendMode?: string;
+}
+export interface GroupLayoutParams {
+    opacity: number;
+    blur: number;
+    isDraggable?: boolean;
+    blendMode?: string;
+}
+export interface CompoundLayoutParams {
+    opacity: number;
+    isDraggable?: boolean;
+    blendMode?: string;
+}
+export interface CodeEmbedLayoutParams {
+    areaAnchor: AreaAnchor;
+    opacity: number;
+    blur: number;
+    isDraggable?: boolean;
+    blendMode?: string;
+}
+export interface VimeoEmbedLayoutParams {
+    play: 'on-hover' | 'on-click' | 'auto';
+    controls: boolean;
+    loop: boolean;
+    muted: boolean;
+    pictureInPicture: boolean;
+    radius: number;
+    blur: number;
+    opacity: number;
+    blendMode?: string;
+}
+export interface YoutubeEmbedLayoutParams {
+    play: 'on-hover' | 'on-click' | 'auto';
+    controls: boolean;
+    loop: boolean;
+    radius: number;
+    blur: number;
+    opacity: number;
+    blendMode?: string;
+}
+export interface ImageLayoutParams extends MediaLayoutParams {
+}
+export interface VideoLayoutParams extends MediaLayoutParams {
+    play: 'on-hover' | 'on-click' | 'auto';
+    muted: boolean;
+    controls: boolean;
+    scrollPlayback: ScrollPlaybackParams | null;
+}
+export interface RichTextLayoutParams {
+    rangeStyles?: RichTextStyle[];
+    textAlign: TextAlign;
+    sizing: string;
+    blur: number;
+    fontSize: number;
+    lineHeight: number;
+    letterSpacing: number;
+    wordSpacing: number;
+    textTransform: TextTransform;
+    verticalAlign: VerticalAlign;
+    color: string;
+    typeFace: string;
+    fontStyle: string;
+    fontWeight: number;
+    fontVariant: string;
+    isDraggable?: boolean;
+    blendMode?: string;
+}
+export interface RectangleLayoutParams {
+    radius: number;
+    strokeWidth: number;
+    fill: FillLayer[];
+    strokeFill: FillLayer[];
+    blur: number;
+    backdropBlur: number;
+    blurMode: 'default' | 'backdrop';
+    isDraggable?: boolean;
+    blendMode?: string;
+}
+export type FillLayer = SolidFillLayer | LinearGradientFillLayer | RadialGradientFillLayer | ConicGradientFillLayer | ImageLayer;
+type ColorPoint = {
+    id: string;
+    value: string;
+    position: number;
+};
+export type SolidFillLayer = {
+    id: string;
+    type: 'solid';
+    value: string;
+};
+export type LinearGradientFillLayer = {
+    id: string;
+    type: 'linear-gradient';
+    colors: ColorPoint[];
+    start: [number, number];
+    end: [number, number];
+    angle: number;
+};
+export type RadialGradientFillLayer = {
+    id: string;
+    type: 'radial-gradient';
+    colors: ColorPoint[];
+    diameter: number;
+    center: [number, number];
+    angle: number;
+};
+export type ConicGradientFillLayer = {
+    id: string;
+    type: 'conic-gradient';
+    colors: ColorPoint[];
+    center: [number, number];
+    angle: number;
+};
+export type ImageLayer = {
+    id: string;
+    type: 'image';
+    src: string;
+    behavior: string;
+    backgroundSize: number;
+    opacity: number;
+    rotation?: number;
+};
+export interface ScrollPlaybackParams {
+    from: number;
+    to: number;
+}
+export interface ScrollPlaybackFrameData {
+    status: 'processing' | 'ready' | 'error';
+    batchId?: string;
+    frameCount?: number;
+    frameRate?: number;
+    framesUrl?: string;
+    frameFormat?: string;
+}
+export interface StickyParams {
+    from: number;
+    to?: number;
+}
+export interface Link {
+    url: string;
+    target: string;
+}
+export interface ComponentLayoutParams {
+    parameters?: any;
+    opacity: number;
+    sizing?: string;
+    blur: number;
+}
+export {};

package/lib/types/article/Params.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/article/StructuredBlock.d.ts

@@ -1,7 +1,7 @@
 import { RichTextBlock, RichTextStyle } from './RichText';
 import { ItemState } from './ItemState';
 import { StructuredBlockType } from './StructuredBlockType';
-import { ComponentLayoutParams, MediaCommonParams, MediaLayoutParams, VimeoEmbedCommonParams, VimeoEmbedLayoutParams, YoutubeEmbedCommonParams, YoutubeEmbedLayoutParams } from './Item';
+import { ComponentLayoutParams, MediaCommonParams, MediaLayoutParams, VimeoEmbedCommonParams, VimeoEmbedLayoutParams, YoutubeEmbedCommonParams, YoutubeEmbedLayoutParams } from './Params.type';
 type LayoutIdentifier = string;
 export interface StructuredBlockArea {
     width?: number;

package/lib/types/keyframe/Keyframe.d.ts

@@ -1,4 +1,4 @@
-import { FillLayer } from "../article/Item";
+import { FillLayer } from "../article/Params.type";
 export type KeyframeAny = Keyframe<KeyframeType>;
 export interface Keyframe<T extends KeyframeType> {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cntrl-site/sdk",
-  "version": "1.28.0-2",
+  "version": "1.28.0-4",
   "description": "Generic SDK for use in public websites.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",