');
86 | applyStyles($grid.find('.scs-container-styles'), this.data);
87 |
88 | // Provide a viewModel to handle show/hide page actions from other components
89 | var isMobile = false; // renderAPI.getDeviceInfo().isMobile;
90 | var visibleIsFalse = (this.data.visible === false);
91 | var isVisible = (isMobile && (typeof this.data.visibleOnMobile === 'boolean')) ?
92 | this.data.visibleOnMobile :
93 | !visibleIsFalse;
94 | if (!isVisible) {
95 | $grid.find('.scs-container-styles').css('display', 'none');
96 | }
97 |
98 | $grid.find('.scs-component-content').append($(this.grid));
99 | content = $grid.html();
100 | }
101 |
102 | return Promise.resolve({
103 | hydrate: false,
104 | componentIds: this.components,
105 | parentClasses: parentClasses,
106 | omitBoundingBox: true,
107 | content: content
108 | });
109 | }
110 | };
111 |
112 | module.exports = ComponentGroup;
113 |
--------------------------------------------------------------------------------
/sites/bin/compiler/components/contentitem/contentcompiler.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2022 Oracle and/or its affiliates. All rights reserved.
3 | * Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
4 | */
5 |
6 | var fs = require('fs'),
7 | path = require('path'),
8 | url = require('url'),
9 | compilationReporter = require('../../reporter.js');
10 |
11 |
12 | const ContentCompiler = class {
13 | constructor(SCSCompileAPI) {
14 | this.SCSCompileAPI = SCSCompileAPI;
15 | }
16 |
17 | async getLayoutCompiler(component) {
18 | var CustomLayoutCompiler;
19 | if (component.moduleFile) {
20 | // JavaScript Module
21 | const { default: importModule } = await import(url.pathToFileURL(component.moduleFile));
22 | CustomLayoutCompiler = importModule;
23 | } else {
24 | // CommonJS Module
25 | CustomLayoutCompiler = require(component.compileFile);
26 | }
27 |
28 | return CustomLayoutCompiler;
29 | }
30 |
31 | customCompile(args) {
32 | const CustomLayoutCompiler = args.CustomLayoutCompiler,
33 | content = args.content,
34 | createDetailPage = args.createDetailPage,
35 | detailPageId = args.detailPageId,
36 | compileArgs = args.compileArgs || {};
37 |
38 | const custComp = new CustomLayoutCompiler(compileArgs);
39 |
40 | return custComp.compile().then((compiledComp) => {
41 | // add in the detail page to compile as well
42 | if (createDetailPage) {
43 | this.SCSCompileAPI.compileDetailPage(detailPageId, content);
44 | }
45 |
46 | // we're done
47 | return Promise.resolve({
48 | content: compiledComp && compiledComp.content,
49 | hydrate: compiledComp && compiledComp.hydrate,
50 | contentId: content && content.id, // If we compiled a different variant of the asset, inform the caller
51 | contentType: content.type
52 | });
53 | }).catch(function (e) {
54 | compilationReporter.error({
55 | message: 'failed to compile content layout for: ' + (args && args.content && args.content.id),
56 | error: e
57 | });
58 | return Promise.resolve({
59 | content: ''
60 | });
61 | });
62 | }
63 |
64 | async compileContentItem(args) {
65 | const componentID = (args && args.content && args.content.id);
66 |
67 | try {
68 | // find the layout
69 | var compileFile = path.normalize(this.SCSCompileAPI.componentsFolder + '/' + args.layout + '/assets/compile');
70 | var customCompilerArgs = {
71 | compileFile: compileFile
72 | };
73 |
74 | // check if the module version of the layout exists
75 | var moduleFile = compileFile + '.mjs';
76 | if (fs.existsSync(moduleFile)) {
77 | customCompilerArgs.moduleFile = moduleFile;
78 | } else {
79 | // otherwise verify if we can load the .js file with require()
80 | require.resolve(compileFile);
81 | }
82 |
83 | // load the custom content layout compiler
84 | var CustomLayoutCompiler = await this.getLayoutCompiler(customCompilerArgs);
85 |
86 |
87 | // compile the content item
88 | var contentClient = await this.SCSCompileAPI.getContentClient();
89 | var compileArgs = {
90 | contentItemData: args.content,
91 | contentClient: contentClient,
92 | scsData: {
93 | SCSCompileAPI: this.SCSCompileAPI,
94 | contentClient: contentClient,
95 | showPublishedContent: contentClient.getInfo().contentType === 'published'
96 | }
97 | };
98 |
99 | var compiledContent = await this.customCompile({
100 | CustomLayoutCompiler: CustomLayoutCompiler,
101 | content: args.content,
102 | createDetailPage: false, // don't create detail pages for content item if this API called directly
103 | compileArgs: compileArgs
104 | });
105 |
106 | return compiledContent;
107 | } catch (e) {
108 | compilationReporter.error({
109 | message: 'failed to load embedded content item: ' + componentID,
110 | error: e
111 | });
112 | return {
113 | content: ''
114 | };
115 | }
116 | }
117 | };
118 |
119 | module.exports = ContentCompiler;
--------------------------------------------------------------------------------
/sites/data/test/components/componentsSpec.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.
3 | * Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
4 | */
5 | /* globals serverConfig,browser,testConfig */
6 |
7 | var chai = require('chai'),
8 | expect = chai.expect,
9 | should = chai.should,
10 | fs = require('fs'),
11 | path = require('path');
12 |
13 |
14 | // utilty function to get all folders in a directory
15 | var getFolders = function (dir) {
16 | return fs.readdirSync(dir)
17 | .filter(function (file) {
18 | return fs.statSync(path.join(dir, file)).isDirectory();
19 | });
20 | };
21 |
22 | describe('Components Tests', function () {
23 | it('components test setup', async function () {
24 | var page,
25 | components = getFolders(serverConfig.componentsFolder);
26 |
27 | describe('Validate components render', function () {
28 | before(async function () {
29 | // create a new tab for all of these tests
30 | page = await browser.newPage();
31 | });
32 | after(async function () {
33 | // close the tab after all tests complete
34 | await page.close();
35 | });
36 |
37 | if (testConfig.remote) {
38 | // run remote server tests
39 | it('ToDo: implement remote server tests', async function () {
40 | throw new Error('No remote server component tests implemented');
41 | });
42 | } else {
43 | // run local server tests
44 |
45 | // run generic validation against all the components
46 | components.forEach(function (componentName) {
47 | // if it's the NavMenu component, it requires bootstrap, which isn't included by default so ignore it
48 | if (componentName !== 'NavMenu') {
49 | it('basic component render test for: ' + componentName, async function () {
50 | this.timeout(180000);
51 |
52 | // get the type of component
53 | var appInfoJSON = fs.readFileSync(serverConfig.componentsFolder + '/' + componentName + '/appinfo.json', 'utf8'),
54 | appInfo;
55 | try {
56 | appInfo = JSON.parse(appInfoJSON);
57 | } catch (e) {
58 | console.log(e);
59 | throw new Error('Failed to determine component type for: ' + componentName);
60 | }
61 |
62 | // run generic tests by type
63 | switch (appInfo.type) {
64 | case 'contentlayout':
65 | console.log('\x1b[33m - No tests implemented for: ' + componentName + '\x1b[0m');
66 | break;
67 | case 'sandboxed':
68 | console.log('\x1b[33m - No tests implemented for: ' + componentName + '\x1b[0m');
69 | break;
70 | case 'sectionlayout':
71 | console.log('\x1b[33m - No tests implemented for: ' + componentName + '\x1b[0m');
72 | break;
73 | case 'componentgroup':
74 | console.log('\x1b[33m - No tests implemented for: ' + componentName + '\x1b[0m');
75 | break;
76 | default:
77 | // render local component onto the page
78 | var pageURL = serverConfig.url + '/components/' + componentName;
79 | await page.goto(pageURL);
80 |
81 | try {
82 | // get the custom component container ID
83 | await page.waitForSelector('.scs-component-container');
84 | const componentId = await page.evaluate(() => document.querySelector('.scs-component-container').id);
85 |
86 | // wait until something has rendered into the customComponentDiv
87 | var custCompSelector = '#' + componentId + 'customComponentDiv';
88 | await page.waitForSelector(custCompSelector);
89 | await page.waitForFunction('document.querySelector("' + custCompSelector + '").innerText.length > 0');
90 | } catch (e) {
91 | console.log(e);
92 | throw new Error('Failed to validate custom component code has rendered into the page: ' + componentName);
93 | }
94 | }
95 |
96 | // do any other tests
97 | });
98 | }
99 | });
100 | }
101 | });
102 | });
103 | });
--------------------------------------------------------------------------------
/sites/bin/compiler/components/document/document.html:
--------------------------------------------------------------------------------
1 |
5 | <{{componentWrapperTag}} {{{nestedId}}}>
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 | {{#computedImages}}
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 | {{#showCaption}}
24 |
25 | {{#title}}
26 | {{title}}
27 | {{/title}}
28 | {{#showPages}}
29 | {{pageDescription}}
30 | {{/showPages}}
31 |
32 | {{/showCaption}}
33 |
34 | {{/computedImages}}
35 |
36 |
37 | {{#hasIndexer}}
38 |
39 | {{/hasIndexer}}
40 |
41 | {{#hasPrevNext}}
42 |
43 |
44 | {{/hasPrevNext}}
45 |
46 |
47 |
48 |
49 | {{#hasThumbnails}}
50 |
51 |
52 |
53 | {{#computedImages}}
54 |
55 |
56 |
57 |
58 |
59 |
60 | {{/computedImages}}
61 |
62 |
63 |
64 | {{/hasThumbnails}}
65 |
66 |
67 |
68 |
121 |
--------------------------------------------------------------------------------
/sites/test/sitescloud/renderer/app/sdk/js/sites.mock.min.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2019 Oracle and/or its affiliates. All rights reserved.
3 | * Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
4 | */
5 | // mockup the SDK for testing
6 | var SitesSDK = function () {
7 |
8 | var getPropertyEvent = 'scsMockGetProperty',
9 | setPropertyEvent = 'scsMockSetProperty',
10 | getPropertyResponseEvent = 'scsMockGetPropertyResponse',
11 | settingsUpdatedResponseEvent = 'scsMockSettingsUpdatedResponse',
12 | callbacks = {
13 | 'getProperty': {},
14 | 'setProperty': {}
15 | },
16 | SDK = {
17 | 'getProperty': function (property, callback) {
18 | // record the callback
19 | callbacks.getProperty[property] = callback;
20 |
21 | // encode the event data
22 | var eventData = JSON.stringify({
23 | 'eventName': getPropertyEvent,
24 | 'eventPayload': {
25 | 'propertyName': property
26 | }
27 | });
28 |
29 | // send the event asking for the property
30 | console.log('Component sent event: ' + eventData);
31 | parent.postMessage(eventData, '*');
32 | },
33 | 'setProperty': function (property, value) {
34 | // encode the event data
35 | var eventData = JSON.stringify({
36 | 'eventName': setPropertyEvent,
37 | 'eventPayload': {
38 | 'propertyName': property,
39 | 'propertyValue': value
40 | }
41 | });
42 |
43 | // send setProperty message to the page
44 | console.log('Component sent event: ' + eventData);
45 |
46 | parent.postMessage(eventData, '*');
47 | },
48 | 'getSiteProperty': function (property, callback) {
49 | callbacks.getProperty[property] = callback;
50 |
51 | // encode the event data
52 | var eventData = JSON.stringify({
53 | 'eventName': getPropertyEvent,
54 | 'eventPayload': {
55 | 'propertyName': property
56 | }
57 | });
58 |
59 | // send the event asking for the property
60 | console.log('Component sent event: ' + eventData);
61 | parent.postMessage(eventData, '*');
62 | },
63 | 'setHeight': function (value) {
64 | // don't do anything
65 | },
66 | 'subscribe:': function (messageType, callback) {
67 | console.log('subscribe: messageType=' + messageType);
68 | callbacks[messageType] = {
69 | 'callback': callback
70 | };
71 | },
72 | 'MESSAGE_TYPES': {
73 | 'SETTINGS_UPDATED': 'SETTINGS_UPDATED',
74 | 'TRIGGER_ACTIONS': 'TRIGGER_ACTIONS',
75 | 'COPY_CUSTOM_DATA': 'COPY_CUSTOM_DATA',
76 | 'PASTE_CUSTOM_DATA': 'PASTE_CUSTOM_DATA',
77 | 'EXECUTE_ACTION': 'EXECUTE_ACTION',
78 | 'GET_ACTIONS': 'GET_ACTIONS',
79 | 'GET_TRIGGERS': 'GET_TRIGGERS'
80 | }
81 | };
82 |
83 | // mock the Sites SDK messages
84 | var receiveMessage = function (event) {
85 | try {
86 | var data = JSON.parse(event.data);
87 |
88 | if (data && data.eventName === getPropertyResponseEvent) {
89 | console.log('Component received event: ' + event.data);
90 |
91 | if (callbacks.getProperty[data.eventPayload.propertyName]) {
92 | callbacks.getProperty[data.eventPayload.propertyName](data.eventPayload.propertyValue);
93 | }
94 | } else if (data && data.eventName === settingsUpdatedResponseEvent &&
95 | data.eventPayload && data.eventPayload.propertyName === 'customSettingsData') {
96 | console.log('Component received settingsUpdated event: ' + JSON.stringify(data.eventPayload));
97 | if (callbacks['SETTINGS_UPDATED']) {
98 | var payload = {
99 | 'detail': {'message':
100 | {
101 | 'property': data.eventPayload.propertyName,
102 | 'value': data.eventPayload.propertyValue
103 | }
104 | }
105 | };
106 | callbacks['SETTINGS_UPDATED'].callback(payload);
107 | } else {
108 | console.log(' No callback for SETTINGS_UPDATED');
109 | }
110 | } else {
111 | console.log('component ignored event: ' + (data ? JSON.stringify(data) : ''));
112 | }
113 | } catch (e) {
114 | console.log('component ignored event: ' + e);
115 | console.log(event);
116 | }
117 | };
118 | window.addEventListener("message", receiveMessage, false);
119 |
120 |
121 |
122 | return SDK;
123 | }();
124 |
--------------------------------------------------------------------------------
/sites/README.md:
--------------------------------------------------------------------------------
1 | # Content Management - Component, Template, Theme and Content Layout Development
2 |
3 | To learn about developing components for Content Management, see the links below:
4 |
5 | [Developing for Oracle Content Management](
6 | https://docs.oracle.com/en/cloud/paas/content-cloud/developer/develop-oracle-content-and-experience-toolkit.html )
7 |
8 | [Test to Production](doc/T2P.md) – Use the Content Toolkit for Test to Production
9 |
10 | [Headless CLI using IAM](doc/IAM-App.md) - Setup IAM Application for headless CLI (No popup Chromium for authentication)
11 |
12 | [Headless CLI using IDCS](doc/IDCS-App.md) - Setup IDCS Application for headless CLI (No popup Chromium for authentication)
13 |
14 | [Build Test](doc/Build-Test.md) - Build, optimize and test updates for OCM source
15 |
16 | [Asset Sync](doc/AssetSync.md) - Synchronize asset create, update, delete, publish across OCM servers
17 |
18 | [Site Pre-Compilation](doc/compiler.md) - Pre-Compile a site for faster rendition in the browser
19 |
20 | ## Installation
21 |
22 | * Make sure `node` and `npm` are in your `PATH`. Use NodeJS version 16.18.1+.
23 | * Download the Content Toolkit - e.g. from GitHub - [link](https://github.com/oracle/content-and-experience-toolkit/archive/master.zip)
24 | * Install the dependencies
25 |
26 | ```
27 | cd
/content-and-experience-toolkit/sites
28 | npm install
29 | ```
30 |
31 | * Put `cec` on your path:
32 |
33 | > **Mac**:
34 |
35 | ```
36 | sudo ln -s $PWD/node_modules/.bin/cec /usr/local/bin/cec
37 | ```
38 |
39 | > **Windows**:
40 |
41 | Run `SystemPropertiesAdvanced.exe`, edit Environment Variables and add `\content-and-experience-toolkit\sites\node_modules\.bin` to the `PATH` variable, replacing `` as appropriate.
42 |
43 | * Run the command line utility `cec` to get help about the commands.
44 |
45 | ```
46 | cec
47 | ```
48 | ## Create an initial `src` directory
49 | Create an initial src directory in any location on your local file system to contain your CEC source.
50 | A `package.json` some dependencies, and src will be created. You can use this a your starting point for CEC source and dependency inclusion.
51 |
52 | ```
53 | mkdir cec-src
54 | cd cec-src
55 | cec install
56 | ```
57 |
58 | * Start the local test harness to allow disconnected development of components, themes, templates, and content layouts:
59 |
60 | ```
61 | cec develop
62 | ```
63 |
64 | * the runtime test harness can be accessed from the browser using address: [http://localhost:8085](http://localhost:8085)
65 |
66 | * Your components, themes, templates, layouts can all be found in `src/`
67 |
68 | ## Using a Content Management instance for local testing
69 |
70 | The CEC instance can be used for the following things:
71 |
72 | * Testing components like Sample-File-List which access content
73 | * Generating Content Layouts from content types stored in CEC
74 | * Rendering Content Layouts using content from CEC
75 | * Exporting and Importing templates, and components from / to CEC into local file system
76 |
77 | You can register one, two, or more OCM servers.
78 |
79 | ```
80 | cec register-server DEV -e https://your-dev-instance.com -u user -p password
81 | cec register-server DEV2 -e https://your-dev-instance.com -u user2 -p password
82 | cec register-server UAT -e https://your-test-instance.com -u user -p password
83 | cec register-server PROD -e https://your-production-instance.com -u user -p password
84 | ```
85 |
86 | If you want the password to be encrypted, create an encryption key first and register the server with the key
87 |
88 | ```
89 | cec create-encryption-key ~/.ceckey
90 | cec register-server DEV -e https://your-dev-instance.com -u user -p password -k ~/.ceckey
91 | ```
92 |
93 | Test your registered server
94 |
95 | ```
96 | cec list --server DEV
97 | ```
98 |
99 | ## Using an IAM Application to access CEC Instance to have a CLI without Chromium popup for Authentication
100 | Instructions on how to setup the IAM application for headless CLI are [here](doc/IAM-App.md)
101 |
102 | ## Using an IDCS Application to access CEC Instance to have a CLI without Chromium popup for Authentication
103 | Instructions on how to setup the IDCS application for headless CLI are [here](doc/IDCS-App.md)
104 |
--------------------------------------------------------------------------------
/sites/bin/exportserviceutils.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2023 Oracle and/or its affiliates. All rights reserved.
3 | * Licensed under the Universal Permissive License v 1.0 as shown at http://oss.oracle.com/licenses/upl.
4 | */
5 |
6 | var serverRest = require('../test/server/serverRest.js'),
7 | fs = require('fs'),
8 | path = require('path'),
9 | fileUtils = require('../test/server/fileUtils.js');
10 |
11 |
12 | var _executeGetExportService = function (args) {
13 | var server = args.server,
14 | url = args.endpoint,
15 | noMsg = args.noMsg;
16 |
17 | // Note: Export service on dev instances requires additional header
18 | var addheaders;
19 | if (server.env === 'dev_ec') {
20 | addheaders = { 'IDCS_REMOTE_USER': server.username };
21 | }
22 |
23 | return serverRest.executeGet({
24 | server: server,
25 | endpoint: url,
26 | noMsg: noMsg,
27 | headers: addheaders
28 | });
29 | };
30 |
31 | var _downloadReport = function (url, name, server, projectDir, type) {
32 | return new Promise(function (resolve, reject) {
33 | console.info(' - Download reports from ' + url);
34 | var targetStem,
35 | namePrefix;
36 |
37 | if (url.indexOf('/system/export/api/v1/exports/') !== -1) {
38 | targetStem = type + 'Export';
39 | namePrefix = 'Export_';
40 | } else if (url.indexOf('/system/export/api/v1/imports/') !== -1) {
41 | targetStem = type + 'Import';
42 | namePrefix = 'Import_';
43 | }
44 |
45 | var targetPath = path.join(projectDir, 'src', targetStem);
46 | // Create target path
47 | fs.mkdirSync(targetPath, {
48 | recursive: true
49 | });
50 |
51 | targetPath = path.join(targetPath, namePrefix + name + '_Report.zip');
52 | console.info(' - Save reports to ' + targetPath);
53 | // Note: Export service on dev instances requires additional header
54 | var addheaders;
55 | if (server.env === 'dev_ec') {
56 | addheaders = { 'IDCS_REMOTE_USER': server.username };
57 | }
58 |
59 | var downloadArgs = {
60 | server: server,
61 | url: url,
62 | saveTo: targetPath,
63 | headers: addheaders
64 | }
65 | serverRest.downloadByURLSave(downloadArgs).then(function () {
66 | resolve(targetPath);
67 | }).catch((error) => {
68 | console.error('Failed to download reports');
69 | resolve();
70 | });
71 | });
72 | };
73 |
74 | var _downloadReports = function (args) {
75 | var reports = args.reports,
76 | type = args.type,
77 | name = args.name,
78 | server = args.server,
79 | projectDir = args.projectDir;
80 |
81 | var downloadPromises = [];
82 | (reports || []).forEach(function (report) {
83 | downloadPromises.push(_downloadReport(report, name, server, projectDir, type));
84 | });
85 |
86 | return Promise.all(downloadPromises);
87 | };
88 |
89 | // For backward compatibility of usage in site.js
90 | var _downloadSiteReports = function (reports, name, server, projectDir) {
91 | return _downloadReports({
92 | reports: reports,
93 | type: 'site',
94 | name: name,
95 | server: server,
96 | projectDir: projectDir
97 | });
98 | }
99 |
100 | var _writeErrorDetail = function(args) {
101 | var reportPath = args.reportPath;
102 |
103 | return new Promise(function (resolve, reject) {
104 | // Just trim the '.zip' from reportPath
105 | var extractPath = reportPath.substring(0, reportPath.lastIndexOf('.zip'));
106 |
107 | // Remove target path if exists.
108 | if (fs.existsSync(extractPath)) {
109 | fileUtils.remove(extractPath);
110 | }
111 |
112 | // Create extraction directory
113 | fs.mkdirSync(extractPath);
114 |
115 | fileUtils.extractZip(reportPath, extractPath).then(function() {
116 | console.info(' - Extracted report to ' + extractPath);
117 | var reportFilePath = path.join(extractPath, 'Report.json');
118 | if (fs.existsSync(reportFilePath)) {
119 | var reportStr = fs.readFileSync(reportFilePath);
120 | var reportJson = JSON.parse(reportStr);
121 | console.info('ERROR Detail: ' + reportJson.errorDetail);
122 | }
123 | resolve();
124 | });
125 | });
126 | };
127 |
128 | module.exports.utils = {
129 | executeGetExportService: _executeGetExportService,
130 | downloadReport: _downloadReport,
131 | downloadReports: _downloadReports,
132 | downloadSiteReports: _downloadSiteReports,
133 | writeErrorDetail: _writeErrorDetail
134 | }
--------------------------------------------------------------------------------
14 | {{#link}}
15 |
16 | {{/link}}
17 | {{/computedImages}}
18 | 
25 | Content Management
26 | 
16 |
17 |