/*
Copyright 2020 Adobe. All rights reserved.
This file is licensed to you under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. You may obtain a copy
of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under
the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
OF ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.
*/
import * as kit from '@adobe/griffon-toolkit';
import schema from '../schemas/cepheusEvent.json';
/**
* Contains constants and functions for a Generic Cepheus Event.
*
* The structure for a Generic Cepheus Event is as follows:
* ```
* {
* type: 'Push Service'
* vendor: 'com.adobe.cepheus'
* annotations: <array>,
* clientId: <string>,
* payload: <object>,
* timestamp: <number>,
* uuid: <string>,
* }
* ```
*
* @namespace cepheusEvent
*/
/**
* Paths for the keys on a Generic Cepheus Event
*
* @enum {string}
*/
const path = {
/** The type of event.<br />Path is `type`. */
rootType: 'type',
/** The vendor of the service that sent the event.<br />Path is `vendor`. */
vendor: 'vendor',
/** Array of Annotation objects.<br />Path is `annotations`. */
annotations: 'annotations',
/** A unique id that differentiates clients from one another.<br />Path is `clientId`. */
clientId: 'clientId',
/** An object with custom data describing the event.<br />Path is `payload`. */
payload: 'payload',
/** When the event occurred.<br />Path is `timestamp`. */
timestamp: 'timestamp',
/** Uniquely identifies each event.<br />Path is `uuid`. */
rootId: 'uuid'
};
/**
* Describes the number of parents this object has based off schema references. When checking for matches for example, we want to
* use a schema that is more specific over a more generic schema
*
* @constant
*/
const parentDepth = 1;
/**
* A label that can be used when describing this object
*/
const label = 'Generic Cepheus Event';
/**
* A grouping for this object
*/
const group = 'event';
/**
* The value for `rootType` for a Generic Cepheus Event.
*
* Path is `type`.
*
* @constant
*/
const ROOT_TYPE = 'Push Service';
/**
* The value for `vendor` for a Generic Cepheus Event.
*
* Path is `vendor`.
*
* @constant
*/
const VENDOR = 'com.adobe.cepheus';
/**
* Retrieves a value from the object. You can provide either a path or an alias.
*
* @function
* @param {string} alias Path or alias
* @param {*} data Data to search
* @returns {*}
*/
const get = (alias, data) => {
const func = (data2) => kit.search(path[alias] || alias, data2);
if (!data) { return func; }
return func(data);
};
/**
* Returns the `vendor` from the Generic Cepheus Event.
* This is the the vendor of the service that sent the event.
*
* Path is `vendor`.
*
* @function
* @param {object} source The Generic Cepheus Event instance
* @returns {string}
*/
const getVendor = kit.search(path.vendor);
/**
* Matcher can be used to find matching Generic Cepheus Event objects.
*
* @see kit.match
* @constant
*/
const matcher = kit.combineAll([
'type==`Push Service`',
'vendor==`com.adobe.cepheus`',
'timestamp'
]);
/**
* Tests the provided source against the matcher to see if it's Generic Cepheus Event event.
*
* @function
* @param {object} source The Generic Cepheus Event instance
* @returns {boolean}
* @see kit.isMatch
*/
const isMatch = (source) => kit.isMatch(matcher, source);
/**
* Generates a Generic Cepheus Event with the const values set.
* Can be useful in testing.
* Can provide additional data by providing a flat object of paths and values.
*
* @function
* @param {...Function} input Overrides
* @returns {object}
*/
const make = (input) => kit.expandWithPaths(path, {
rootType: 'Push Service',
vendor: 'com.adobe.cepheus',
...input
});
/**
* Generates a Generic Cepheus Event with some default values set.
* Can be useful in testing.
* Can override defaults and provide additional data by providing a flat object
* of paths and values.
*
* @function
* @param {...Function} input Overrides
* @returns {object}
*/
const mock = (input) => kit.expandWithPaths(path, {
rootType: 'Push Service',
vendor: 'com.adobe.cepheus',
clientId: 'appleABC',
timestamp: Date.parse('12 Jan 2020 07:23:17 GMT'),
rootId: '123',
...input
});
/* ADD CUSTOM CONTENT BELOW */
// additional exports should be added here:
const customExports = {};
/* END CUSTOM CONTENT */
/* The content below is autogenerated. Do not make any changes */
export default {
path,
mock,
make,
schema,
get,
...customExports,
getVendor,
isMatch,
matcher,
ROOT_TYPE,
VENDOR,
label,
group,
parentDepth
};