@gxpl/sdk 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +2 -0
  3. package/dist/Client/Client.d.ts +32 -0
  4. package/dist/Client/Client.js +128 -0
  5. package/dist/Client/Client.test.d.ts +1 -0
  6. package/dist/Client/__mock__/articleMock.d.ts +2 -0
  7. package/dist/Client/__mock__/keyframesMock.d.ts +2 -0
  8. package/dist/Client/__mock__/projectMock.d.ts +2 -0
  9. package/dist/Components/ControlSlider/ControlSlider.d.ts +91 -0
  10. package/dist/Components/ControlSlider/ControlSliderComponent.d.ts +519 -0
  11. package/dist/Components/ImageRevealSlider/ControlImageRevealSliderComponent.d.ts +209 -0
  12. package/dist/Components/ImageRevealSlider/ImageRevealSlider.d.ts +39 -0
  13. package/dist/Components/components.d.ts +2 -0
  14. package/dist/Components/helpers/RichTextRenderer/RichTextRenderer.d.ts +6 -0
  15. package/dist/Components/helpers/SvgImage/SvgImage.d.ts +9 -0
  16. package/dist/Components/utils/scalingValue.d.ts +1 -0
  17. package/dist/FontFaceGenerator/FontFaceGenerator.d.ts +6 -0
  18. package/dist/FontFaceGenerator/FontFaceGenerator.test.d.ts +1 -0
  19. package/dist/ScrollPlaybackVideoManager/ScrollPlaybackVideoManager.d.ts +31 -0
  20. package/dist/VideoDecoder/VideoDecoder.d.ts +12 -0
  21. package/dist/cli.d.ts +10 -0
  22. package/dist/cli.js +64 -0
  23. package/dist/index.d.ts +23 -0
  24. package/dist/index.js +2730 -0
  25. package/dist/index.mjs +2713 -0
  26. package/dist/schemas/article/Article.schema.d.ts +328 -0
  27. package/dist/schemas/article/Article.schema.js +11 -0
  28. package/dist/schemas/article/FillLayer.schema.d.ts +186 -0
  29. package/dist/schemas/article/FillLayer.schema.js +53 -0
  30. package/dist/schemas/article/Interaction.schema.d.ts +103 -0
  31. package/dist/schemas/article/Interaction.schema.js +30 -0
  32. package/dist/schemas/article/Item.schema.d.ts +40 -0
  33. package/dist/schemas/article/Item.schema.js +242 -0
  34. package/dist/schemas/article/ItemArea.schema.d.ts +36 -0
  35. package/dist/schemas/article/ItemArea.schema.js +17 -0
  36. package/dist/schemas/article/ItemBase.schema.d.ts +137 -0
  37. package/dist/schemas/article/ItemBase.schema.js +23 -0
  38. package/dist/schemas/article/ItemState.schema.d.ts +15723 -0
  39. package/dist/schemas/article/ItemState.schema.js +75 -0
  40. package/dist/schemas/article/RichTextItem.schema.d.ts +1372 -0
  41. package/dist/schemas/article/RichTextItem.schema.js +60 -0
  42. package/dist/schemas/article/Section.schema.d.ts +176 -0
  43. package/dist/schemas/article/Section.schema.js +38 -0
  44. package/dist/schemas/keyframe/Keyframes.schema.d.ts +2000 -0
  45. package/dist/schemas/keyframe/Keyframes.schema.js +116 -0
  46. package/dist/schemas/project/Layout.schema.d.ts +17 -0
  47. package/dist/schemas/project/Layout.schema.js +10 -0
  48. package/dist/schemas/project/Project.schema.d.ts +253 -0
  49. package/dist/schemas/project/Project.schema.js +48 -0
  50. package/dist/schemas/shared/FillLayer.schema.d.ts +186 -0
  51. package/dist/sdk.css +1 -0
  52. package/dist/types/article/Article.d.ts +7 -0
  53. package/dist/types/article/Article.js +2 -0
  54. package/dist/types/article/ArticleItemType.d.ts +13 -0
  55. package/dist/types/article/ArticleItemType.js +17 -0
  56. package/dist/types/article/CompoundSettings.d.ts +6 -0
  57. package/dist/types/article/CompoundSettings.js +2 -0
  58. package/dist/types/article/FX.d.ts +23 -0
  59. package/dist/types/article/FX.js +2 -0
  60. package/dist/types/article/Interaction.d.ts +28 -0
  61. package/dist/types/article/Interaction.js +2 -0
  62. package/dist/types/article/Item.d.ts +250 -0
  63. package/dist/types/article/Item.js +3 -0
  64. package/dist/types/article/ItemArea.d.ts +36 -0
  65. package/dist/types/article/ItemArea.js +31 -0
  66. package/dist/types/article/ItemState.d.ts +78 -0
  67. package/dist/types/article/ItemState.js +3 -0
  68. package/dist/types/article/RichText.d.ts +40 -0
  69. package/dist/types/article/RichText.js +27 -0
  70. package/dist/types/article/Section.d.ts +37 -0
  71. package/dist/types/article/Section.js +8 -0
  72. package/dist/types/component/Component.d.ts +15 -0
  73. package/dist/types/keyframe/Keyframe.d.ts +86 -0
  74. package/dist/types/keyframe/Keyframe.js +21 -0
  75. package/dist/types/project/Fonts.d.ts +22 -0
  76. package/dist/types/project/Fonts.js +11 -0
  77. package/dist/types/project/Layout.d.ts +6 -0
  78. package/dist/types/project/Layout.js +2 -0
  79. package/dist/types/project/Meta.d.ts +9 -0
  80. package/dist/types/project/Meta.js +2 -0
  81. package/dist/types/project/Page.d.ts +11 -0
  82. package/dist/types/project/Page.js +2 -0
  83. package/dist/types/project/Project.d.ts +17 -0
  84. package/dist/types/project/Project.js +2 -0
  85. package/dist/utils.d.ts +3 -0
  86. package/package.json +84 -0
  87. package/resources/template.scss.ejs +50 -0
@@ -0,0 +1,209 @@
1
+ import { ImageRevealSlider } from './ImageRevealSlider';
2
+ export declare const ControlImageRevealSliderComponent: {
3
+ element: typeof ImageRevealSlider;
4
+ id: string;
5
+ name: string;
6
+ preview: {
7
+ type: "video";
8
+ url: string;
9
+ };
10
+ defaultSize: {
11
+ width: number;
12
+ height: number;
13
+ };
14
+ schema: {
15
+ type: string;
16
+ properties: {
17
+ settings: {
18
+ layoutBased: boolean;
19
+ type: string;
20
+ properties: {
21
+ imageSize: {
22
+ name: string;
23
+ icon: string;
24
+ tooltip: string;
25
+ type: string;
26
+ properties: {
27
+ sizeType: {
28
+ name: string;
29
+ type: string;
30
+ display: {
31
+ type: string;
32
+ };
33
+ enum: string[];
34
+ };
35
+ imageWidth: {
36
+ type: string;
37
+ label: string;
38
+ display: {
39
+ type: string;
40
+ visible: boolean;
41
+ };
42
+ };
43
+ randomRangeImageWidth: {
44
+ type: string;
45
+ display: {
46
+ type: string;
47
+ visible: boolean;
48
+ };
49
+ properties: {
50
+ min: {
51
+ type: string;
52
+ };
53
+ max: {
54
+ type: string;
55
+ };
56
+ };
57
+ };
58
+ };
59
+ };
60
+ cursor: {
61
+ name: string;
62
+ icon: string;
63
+ tooltip: string;
64
+ type: string;
65
+ properties: {
66
+ cursorType: {
67
+ name: string;
68
+ type: string;
69
+ display: {
70
+ type: string;
71
+ };
72
+ enum: string[];
73
+ };
74
+ defaultCursor: {
75
+ type: string[];
76
+ display: {
77
+ type: string;
78
+ title: string;
79
+ visible: boolean;
80
+ };
81
+ };
82
+ hoverCursor: {
83
+ type: string[];
84
+ display: {
85
+ type: string;
86
+ title: string;
87
+ visible: boolean;
88
+ };
89
+ };
90
+ };
91
+ };
92
+ position: {
93
+ name: string;
94
+ icon: string;
95
+ tooltip: string;
96
+ type: string;
97
+ properties: {
98
+ revealPosition: {
99
+ type: string;
100
+ display: {
101
+ type: string;
102
+ };
103
+ enum: string[];
104
+ };
105
+ visible: {
106
+ type: string;
107
+ display: {
108
+ type: string;
109
+ };
110
+ enum: string[];
111
+ };
112
+ target: {
113
+ type: string;
114
+ display: {
115
+ type: string;
116
+ };
117
+ enum: string[];
118
+ };
119
+ };
120
+ };
121
+ };
122
+ default: {
123
+ imageSize: {
124
+ sizeType: string;
125
+ imageWidth: number;
126
+ randomRangeImageWidth: {
127
+ min: number;
128
+ max: number;
129
+ };
130
+ };
131
+ cursor: {
132
+ cursorType: string;
133
+ defaultCursor: null;
134
+ hoverCursor: null;
135
+ };
136
+ position: {
137
+ revealPosition: string;
138
+ visible: string;
139
+ target: string;
140
+ };
141
+ };
142
+ displayRules: ({
143
+ if: {
144
+ name: string;
145
+ value: string;
146
+ };
147
+ then: {
148
+ name: string;
149
+ value: boolean;
150
+ };
151
+ } | {
152
+ if: {
153
+ name: string;
154
+ value: string;
155
+ }[];
156
+ then: {
157
+ name: string;
158
+ value: boolean;
159
+ };
160
+ })[];
161
+ };
162
+ content: {
163
+ layoutBased: boolean;
164
+ type: string;
165
+ items: {
166
+ type: string;
167
+ properties: {
168
+ image: {
169
+ type: string;
170
+ display: {
171
+ type: string;
172
+ isObjectFitEditable: boolean;
173
+ };
174
+ properties: {
175
+ url: {
176
+ type: string;
177
+ };
178
+ name: {
179
+ type: string;
180
+ };
181
+ objectFit: {
182
+ type: string;
183
+ enum: string[];
184
+ };
185
+ };
186
+ required: string[];
187
+ };
188
+ link: {
189
+ type: string;
190
+ display: {
191
+ type: string;
192
+ placeholder: string;
193
+ };
194
+ };
195
+ };
196
+ required: string[];
197
+ };
198
+ default: {
199
+ image: {
200
+ objectFit: string;
201
+ url: string;
202
+ name: string;
203
+ };
204
+ link: string;
205
+ }[];
206
+ };
207
+ };
208
+ };
209
+ };
@@ -0,0 +1,39 @@
1
+ import { default as React } from 'react';
2
+ interface ImageRevealSliderProps {
3
+ settings: ImageRevealSliderSettings;
4
+ content: ImageRevealSliderItem[];
5
+ isEditor?: boolean;
6
+ }
7
+ type RandomRange = {
8
+ min: number;
9
+ max: number;
10
+ };
11
+ type ImageRevealSliderImageSize = {
12
+ sizeType: 'as Is' | 'custom' | 'random';
13
+ imageWidth: number;
14
+ randomRangeImageWidth: RandomRange;
15
+ };
16
+ type ImageRevealSliderCursor = {
17
+ cursorType: 'system' | 'custom';
18
+ defaultCursor: string | null;
19
+ hoverCursor: string | null;
20
+ };
21
+ type ImageRevealSliderPosition = {
22
+ revealPosition: 'random' | 'same' | 'on Click';
23
+ visible: 'all' | 'last One';
24
+ target: 'area' | 'image';
25
+ };
26
+ type ImageRevealSliderSettings = {
27
+ imageSize: ImageRevealSliderImageSize;
28
+ cursor: ImageRevealSliderCursor;
29
+ position: ImageRevealSliderPosition;
30
+ };
31
+ type ImageRevealSliderItem = {
32
+ image: {
33
+ url: string;
34
+ name: string;
35
+ };
36
+ link: string;
37
+ };
38
+ export declare function ImageRevealSlider({ settings, content, isEditor }: ImageRevealSliderProps): React.JSX.Element;
39
+ export {};
@@ -0,0 +1,2 @@
1
+ import { Component } from '../types/component/Component';
2
+ export declare const components: Component[];
@@ -0,0 +1,6 @@
1
+ import { FC } from 'react';
2
+ interface Props {
3
+ content: any[];
4
+ }
5
+ export declare const RichTextRenderer: FC<Props>;
6
+ export {};
@@ -0,0 +1,9 @@
1
+ import { FC } from 'react';
2
+ interface SvgImageProps {
3
+ url: string;
4
+ fill?: string;
5
+ hoverFill?: string;
6
+ className?: string;
7
+ }
8
+ export declare const SvgImage: FC<SvgImageProps>;
9
+ export {};
@@ -0,0 +1 @@
1
+ export declare function scalingValue(value: number, isEditor?: boolean): string;
@@ -0,0 +1,6 @@
1
+ import { CustomFont } from '../types/project/Fonts';
2
+ export declare class FontFaceGenerator {
3
+ private fonts;
4
+ constructor(fonts: CustomFont[]);
5
+ generate(): string;
6
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,31 @@
1
+ interface ScrollVideoOptions {
2
+ src: string;
3
+ videoContainer: HTMLElement | string;
4
+ }
5
+ export declare class ScrollPlaybackVideoManager {
6
+ private container?;
7
+ private video?;
8
+ private isSafari?;
9
+ private currentTime;
10
+ private targetTime;
11
+ private canvas;
12
+ private context;
13
+ private frames;
14
+ private frameRate;
15
+ private transitioning;
16
+ private debug;
17
+ private frameThreshold;
18
+ private transitionSpeed;
19
+ private useWebCodecs;
20
+ private resizeObserver;
21
+ constructor(options: ScrollVideoOptions);
22
+ private setCoverStyle;
23
+ private resize;
24
+ private decodeVideo;
25
+ private paintCanvasFrame;
26
+ private transitionToTargetTime;
27
+ private resetCanvasDimensions;
28
+ setTargetTimePercent(setPercentage: number, jump?: boolean): void;
29
+ destroy(): void;
30
+ }
31
+ export {};
@@ -0,0 +1,12 @@
1
+ export declare class Writer {
2
+ private data;
3
+ private idx;
4
+ private size;
5
+ constructor(size: number);
6
+ getData(): Uint8Array<ArrayBuffer>;
7
+ writeUint8(value: number): void;
8
+ writeUint16(value: number): void;
9
+ writeUint8Array(value: Uint8Array): void;
10
+ }
11
+ declare const _default: (src: string, emitFrame: (bitmap: ImageBitmap) => void, debug: boolean) => Promise<void>;
12
+ export default _default;
package/dist/cli.d.ts ADDED
@@ -0,0 +1,10 @@
1
+ #!/usr/bin/env node
2
+ export interface LayoutRange {
3
+ /** closed range [start, end] */
4
+ start: number;
5
+ end: number;
6
+ exemplary: number;
7
+ name: string;
8
+ isFirst: boolean;
9
+ isLast: boolean;
10
+ }
package/dist/cli.js ADDED
@@ -0,0 +1,64 @@
1
+ #!/usr/bin/env node
2
+ "use strict";
3
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
4
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
5
+ return new (P || (P = Promise))(function (resolve, reject) {
6
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
7
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
8
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
9
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
10
+ });
11
+ };
12
+ var __importDefault = (this && this.__importDefault) || function (mod) {
13
+ return (mod && mod.__esModule) ? mod : { "default": mod };
14
+ };
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ const fs_1 = __importDefault(require("fs"));
17
+ const path_1 = __importDefault(require("path"));
18
+ const ejs_1 = __importDefault(require("ejs"));
19
+ const dotenv_1 = require("dotenv");
20
+ const commander_1 = require("commander");
21
+ const Client_1 = require("./Client/Client");
22
+ commander_1.program
23
+ .command('generate-layouts')
24
+ .option('-o, --output <outputFilePath>', 'Output file path', 'cntrl.scss')
25
+ .option('-e, --env <envFilename>', 'Name of the .env file', '.env.local')
26
+ .action((options) => __awaiter(void 0, void 0, void 0, function* () {
27
+ try {
28
+ (0, dotenv_1.config)({ path: options.env });
29
+ const templateFilePath = path_1.default.resolve(__dirname, '../resources/template.scss.ejs');
30
+ const scssTemplate = fs_1.default.readFileSync(templateFilePath, 'utf-8');
31
+ const apiUrl = process.env.CNTRL_API_URL;
32
+ if (!apiUrl) {
33
+ throw new Error('Environment variable "CNTRL_API_URL" must be set.');
34
+ }
35
+ const client = new Client_1.Client(apiUrl);
36
+ const layouts = yield client.getLayouts();
37
+ const ranges = convertLayouts(layouts);
38
+ const compiledTemplate = ejs_1.default.compile(scssTemplate);
39
+ const renderedTemplate = compiledTemplate({ ranges });
40
+ const outputFilePath = path_1.default.resolve(process.cwd(), options.output);
41
+ fs_1.default.writeFileSync(outputFilePath, renderedTemplate);
42
+ console.log(`Generated .scss file at ${outputFilePath}`);
43
+ }
44
+ catch (error) {
45
+ console.error('An error occurred:', error);
46
+ process.exit(1);
47
+ }
48
+ }));
49
+ function convertLayouts(layouts, maxLayoutWidth = Number.MAX_SAFE_INTEGER) {
50
+ const sorted = layouts.slice().sort((la, lb) => la.startsWith - lb.startsWith);
51
+ const mapped = sorted.map((layout, i, ls) => {
52
+ const next = ls[i + 1];
53
+ return {
54
+ start: layout.startsWith,
55
+ end: next ? next.startsWith - 1 : maxLayoutWidth,
56
+ exemplary: layout.exemplary,
57
+ name: layout.title,
58
+ isFirst: i === 0,
59
+ isLast: !next
60
+ };
61
+ });
62
+ return mapped;
63
+ }
64
+ commander_1.program.parse(process.argv);
@@ -0,0 +1,23 @@
1
+ export { Client as CntrlClient } from './Client/Client';
2
+ export { FontFaceGenerator } from './FontFaceGenerator/FontFaceGenerator';
3
+ export { getLayoutStyles, getLayoutMediaQuery } from './utils';
4
+ export { ScrollPlaybackVideoManager } from './ScrollPlaybackVideoManager/ScrollPlaybackVideoManager';
5
+ export { SectionHeightMode } from './types/article/Section';
6
+ export { TextAlign, TextDecoration, TextTransform, VerticalAlign } from './types/article/RichText';
7
+ export { ArticleItemType } from './types/article/ArticleItemType';
8
+ export { AreaAnchor, AnchorSide, DimensionMode, PositionType } from './types/article/ItemArea';
9
+ export { KeyframeType } from './types/keyframe/Keyframe';
10
+ export type { Article } from './types/article/Article';
11
+ export type { Section, SectionHeight } from './types/article/Section';
12
+ export type { Item, ImageItem, ItemAny, CustomItem, ItemCommonParamsMap, ItemLayoutParamsMap, RectangleItem, StickyParams, VideoItem, RichTextItem, Link, VimeoEmbedItem, YoutubeEmbedItem, GroupItem, CodeEmbedItem, CompoundItem, ComponentItem, FillLayer } from './types/article/Item';
13
+ export type { RichTextBlock, RichTextEntity, RichTextStyle } from './types/article/RichText';
14
+ export type { ItemArea } from './types/article/ItemArea';
15
+ export type { ItemState, ItemStateParams, StateParams, ItemStatesMap } from './types/article/ItemState';
16
+ export type { Interaction, InteractionItemTrigger, InteractionScrollTrigger, InteractionState } from './types/article/Interaction';
17
+ export type { Layout } from './types/project/Layout';
18
+ export type { Project } from './types/project/Project';
19
+ export type { Meta } from './types/project/Meta';
20
+ export type { KeyframeValueMap, KeyframeAny } from './types/keyframe/Keyframe';
21
+ export type { CompoundSettings } from './types/article/CompoundSettings';
22
+ export type { Component } from './types/component/Component';
23
+ export { components } from './Components/components';