@salesforce/lds-adapters-community-navigation-menu 0.131.0

package/sfdc/index.js

@@ -0,0 +1,479 @@
+/**
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+
+/*  *******************************************************************************************
+ *  ATTENTION!
+ *  THIS IS A GENERATED FILE FROM https://github.com/salesforce-experience-platform-emu/lds-lightning-platform
+ *  If you would like to contribute to LDS, please follow the steps outlined in the git repo.
+ *  Any changes made to this file in p4 will be automatically overwritten.
+ *  *******************************************************************************************
+ */
+/* proxy-compat-disable */
+import { createInstrumentedAdapter, createLDSAdapter, createWireAdapterConstructor, createImperativeAdapter } from 'force/ldsBindings';
+import { withDefaultLuvio } from 'force/ldsEngine';
+import { serializeStructuredKey, StoreKeyMap } from 'force/luvioEngine';
+
+const { hasOwnProperty: ObjectPrototypeHasOwnProperty } = Object.prototype;
+const { keys: ObjectKeys$1, freeze: ObjectFreeze$1, create: ObjectCreate$1 } = Object;
+const { isArray: ArrayIsArray$1 } = Array;
+/**
+ * Validates an adapter config is well-formed.
+ * @param config The config to validate.
+ * @param adapter The adapter validation configuration.
+ * @param oneOf The keys the config must contain at least one of.
+ * @throws A TypeError if config doesn't satisfy the adapter's config validation.
+ */
+function validateConfig(config, adapter, oneOf) {
+    const { displayName } = adapter;
+    const { required, optional, unsupported } = adapter.parameters;
+    if (config === undefined ||
+        required.every(req => ObjectPrototypeHasOwnProperty.call(config, req)) === false) {
+        throw new TypeError(`adapter ${displayName} configuration must specify ${required.sort().join(', ')}`);
+    }
+    if (oneOf && oneOf.some(req => ObjectPrototypeHasOwnProperty.call(config, req)) === false) {
+        throw new TypeError(`adapter ${displayName} configuration must specify one of ${oneOf.sort().join(', ')}`);
+    }
+    if (unsupported !== undefined &&
+        unsupported.some(req => ObjectPrototypeHasOwnProperty.call(config, req))) {
+        throw new TypeError(`adapter ${displayName} does not yet support ${unsupported.sort().join(', ')}`);
+    }
+    const supported = required.concat(optional);
+    if (ObjectKeys$1(config).some(key => !supported.includes(key))) {
+        throw new TypeError(`adapter ${displayName} configuration supports only ${supported.sort().join(', ')}`);
+    }
+}
+function untrustedIsObject(untrusted) {
+    return typeof untrusted === 'object' && untrusted !== null && ArrayIsArray$1(untrusted) === false;
+}
+function areRequiredParametersPresent(config, configPropertyNames) {
+    return configPropertyNames.parameters.required.every(req => req in config);
+}
+const snapshotRefreshOptions = {
+    overrides: {
+        headers: {
+            'Cache-Control': 'no-cache',
+        },
+    }
+};
+const keyPrefix = 'CommunityNavigation';
+
+const { freeze: ObjectFreeze, keys: ObjectKeys, create: ObjectCreate, assign: ObjectAssign } = Object;
+const { isArray: ArrayIsArray } = Array;
+const { stringify: JSONStringify } = JSON;
+function createLink(ref) {
+    return {
+        __ref: serializeStructuredKey(ref),
+    };
+}
+
+function validate$1(obj, path = 'NavigationMenuItemRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_actionType = obj.actionType;
+        const path_actionType = path + '.actionType';
+        if (typeof obj_actionType !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_actionType + '" (at "' + path_actionType + '")');
+        }
+        const obj_actionValue = obj.actionValue;
+        const path_actionValue = path + '.actionValue';
+        let obj_actionValue_union0 = null;
+        const obj_actionValue_union0_error = (() => {
+            if (typeof obj_actionValue !== 'string') {
+                return new TypeError('Expected "string" but received "' + typeof obj_actionValue + '" (at "' + path_actionValue + '")');
+            }
+        })();
+        if (obj_actionValue_union0_error != null) {
+            obj_actionValue_union0 = obj_actionValue_union0_error.message;
+        }
+        let obj_actionValue_union1 = null;
+        const obj_actionValue_union1_error = (() => {
+            if (obj_actionValue !== null) {
+                return new TypeError('Expected "null" but received "' + typeof obj_actionValue + '" (at "' + path_actionValue + '")');
+            }
+        })();
+        if (obj_actionValue_union1_error != null) {
+            obj_actionValue_union1 = obj_actionValue_union1_error.message;
+        }
+        if (obj_actionValue_union0 && obj_actionValue_union1) {
+            let message = 'Object doesn\'t match union (at "' + path_actionValue + '")';
+            message += '\n' + obj_actionValue_union0.split('\n').map((line) => '\t' + line).join('\n');
+            message += '\n' + obj_actionValue_union1.split('\n').map((line) => '\t' + line).join('\n');
+            return new TypeError(message);
+        }
+        const obj_imageUrl = obj.imageUrl;
+        const path_imageUrl = path + '.imageUrl';
+        let obj_imageUrl_union0 = null;
+        const obj_imageUrl_union0_error = (() => {
+            if (typeof obj_imageUrl !== 'string') {
+                return new TypeError('Expected "string" but received "' + typeof obj_imageUrl + '" (at "' + path_imageUrl + '")');
+            }
+        })();
+        if (obj_imageUrl_union0_error != null) {
+            obj_imageUrl_union0 = obj_imageUrl_union0_error.message;
+        }
+        let obj_imageUrl_union1 = null;
+        const obj_imageUrl_union1_error = (() => {
+            if (obj_imageUrl !== null) {
+                return new TypeError('Expected "null" but received "' + typeof obj_imageUrl + '" (at "' + path_imageUrl + '")');
+            }
+        })();
+        if (obj_imageUrl_union1_error != null) {
+            obj_imageUrl_union1 = obj_imageUrl_union1_error.message;
+        }
+        if (obj_imageUrl_union0 && obj_imageUrl_union1) {
+            let message = 'Object doesn\'t match union (at "' + path_imageUrl + '")';
+            message += '\n' + obj_imageUrl_union0.split('\n').map((line) => '\t' + line).join('\n');
+            message += '\n' + obj_imageUrl_union1.split('\n').map((line) => '\t' + line).join('\n');
+            return new TypeError(message);
+        }
+        const obj_label = obj.label;
+        const path_label = path + '.label';
+        if (typeof obj_label !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_label + '" (at "' + path_label + '")');
+        }
+        const obj_subMenu = obj.subMenu;
+        const path_subMenu = path + '.subMenu';
+        if (!ArrayIsArray(obj_subMenu)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_subMenu + '" (at "' + path_subMenu + '")');
+        }
+        for (let i = 0; i < obj_subMenu.length; i++) {
+            const obj_subMenu_item = obj_subMenu[i];
+            const path_subMenu_item = path_subMenu + '[' + i + ']';
+            const referencepath_subMenu_itemValidationError = validate$1(obj_subMenu_item, path_subMenu_item);
+            if (referencepath_subMenu_itemValidationError !== null) {
+                let message = 'Object doesn\'t match NavigationMenuItemRepresentation (at "' + path_subMenu_item + '")\n';
+                message += referencepath_subMenu_itemValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+        const obj_target = obj.target;
+        const path_target = path + '.target';
+        if (typeof obj_target !== 'string') {
+            return new TypeError('Expected "string" but received "' + typeof obj_target + '" (at "' + path_target + '")');
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+function deepFreeze$1(input) {
+    const input_subMenu = input.subMenu;
+    for (let i = 0; i < input_subMenu.length; i++) {
+        const input_subMenu_item = input_subMenu[i];
+        deepFreeze$1(input_subMenu_item);
+    }
+    ObjectFreeze(input_subMenu);
+    ObjectFreeze(input);
+}
+
+const VERSION = "2c44fa1cf5686d4e00960baa7b9e6a1f";
+function validate(obj, path = 'NavigationMenuItemCollectionRepresentation') {
+    const v_error = (() => {
+        if (typeof obj !== 'object' || ArrayIsArray(obj) || obj === null) {
+            return new TypeError('Expected "object" but received "' + typeof obj + '" (at "' + path + '")');
+        }
+        const obj_menuItems = obj.menuItems;
+        const path_menuItems = path + '.menuItems';
+        if (!ArrayIsArray(obj_menuItems)) {
+            return new TypeError('Expected "array" but received "' + typeof obj_menuItems + '" (at "' + path_menuItems + '")');
+        }
+        for (let i = 0; i < obj_menuItems.length; i++) {
+            const obj_menuItems_item = obj_menuItems[i];
+            const path_menuItems_item = path_menuItems + '[' + i + ']';
+            const referencepath_menuItems_itemValidationError = validate$1(obj_menuItems_item, path_menuItems_item);
+            if (referencepath_menuItems_itemValidationError !== null) {
+                let message = 'Object doesn\'t match NavigationMenuItemRepresentation (at "' + path_menuItems_item + '")\n';
+                message += referencepath_menuItems_itemValidationError.message.split('\n').map((line) => '\t' + line).join('\n');
+                return new TypeError(message);
+            }
+        }
+    })();
+    return v_error === undefined ? null : v_error;
+}
+const RepresentationType = 'NavigationMenuItemCollectionRepresentation';
+function normalize(input, existing, path, luvio, store, timestamp) {
+    return input;
+}
+const select$1 = function NavigationMenuItemCollectionRepresentationSelect() {
+    return {
+        kind: 'Fragment',
+        version: VERSION,
+        private: [],
+        opaque: true
+    };
+};
+function equals(existing, incoming) {
+    if (JSONStringify(incoming) !== JSONStringify(existing)) {
+        return false;
+    }
+    return true;
+}
+function deepFreeze(input) {
+    const input_menuItems = input.menuItems;
+    for (let i = 0; i < input_menuItems.length; i++) {
+        const input_menuItems_item = input_menuItems[i];
+        deepFreeze$1(input_menuItems_item);
+    }
+    ObjectFreeze(input_menuItems);
+    ObjectFreeze(input);
+}
+const ingest = function NavigationMenuItemCollectionRepresentationIngest(input, path, luvio, store, timestamp) {
+    if (process.env.NODE_ENV !== 'production') {
+        const validateError = validate(input);
+        if (validateError !== null) {
+            throw validateError;
+        }
+    }
+    const key = path.fullPath;
+    const existingRecord = store.readEntry(key);
+    const ttlToUse = path.ttl !== undefined ? path.ttl : 2592000000;
+    let incomingRecord = normalize(input, store.readEntry(key), {
+        fullPath: key,
+        parent: path.parent,
+        propertyName: path.propertyName,
+        ttl: ttlToUse
+    });
+    deepFreeze(input);
+    if (existingRecord === undefined || equals(existingRecord, incomingRecord) === false) {
+        luvio.storePublish(key, incomingRecord);
+    }
+    if (ttlToUse !== undefined) {
+        const storeMetadataParams = {
+            ttl: ttlToUse,
+            namespace: "CommunityNavigation",
+            version: VERSION,
+            representationName: RepresentationType,
+        };
+        luvio.publishStoreMetadata(key, storeMetadataParams);
+    }
+    return createLink(key);
+};
+function getTypeCacheKeys(luvio, input, fullPathFactory) {
+    const rootKeySet = new StoreKeyMap();
+    // root cache key (uses fullPathFactory if keyBuilderFromType isn't defined)
+    const rootKey = fullPathFactory();
+    rootKeySet.set(rootKey, {
+        namespace: keyPrefix,
+        representationName: RepresentationType,
+        mergeable: false
+    });
+    return rootKeySet;
+}
+
+function select(luvio, params) {
+    return select$1();
+}
+function keyBuilder$1(luvio, params) {
+    return keyPrefix + '::NavigationMenuItemCollectionRepresentation:(' + 'addHomeMenuItem:' + params.queryParams.addHomeMenuItem + ',' + 'effectiveAccountId:' + params.queryParams.effectiveAccountId + ',' + 'includeImageUrl:' + params.queryParams.includeImageUrl + ',' + 'menuItemTypesToSkip:' + params.queryParams.menuItemTypesToSkip + ',' + 'navigationLinkSetDeveloperName:' + params.queryParams.navigationLinkSetDeveloperName + ',' + 'navigationLinkSetId:' + params.queryParams.navigationLinkSetId + ',' + 'publishStatus:' + params.queryParams.publishStatus + ',' + 'communityId:' + params.urlParams.communityId + ')';
+}
+function getResponseCacheKeys(luvio, resourceParams, response) {
+    return getTypeCacheKeys(luvio, response, () => keyBuilder$1(luvio, resourceParams));
+}
+function ingestSuccess(luvio, resourceParams, response, snapshotRefresh) {
+    const { body } = response;
+    const key = keyBuilder$1(luvio, resourceParams);
+    luvio.storeIngest(key, ingest, body);
+    const snapshot = luvio.storeLookup({
+        recordId: key,
+        node: select(),
+        variables: {},
+    }, snapshotRefresh);
+    if (process.env.NODE_ENV !== 'production') {
+        if (snapshot.state !== 'Fulfilled') {
+            throw new Error('Invalid network response. Expected resource response to result in Fulfilled snapshot');
+        }
+    }
+    return snapshot;
+}
+function ingestError(luvio, params, error, snapshotRefresh) {
+    const key = keyBuilder$1(luvio, params);
+    const errorSnapshot = luvio.errorSnapshot(error, snapshotRefresh);
+    luvio.storeIngestError(key, errorSnapshot);
+    return errorSnapshot;
+}
+function createResourceRequest(config) {
+    const headers = {};
+    return {
+        baseUri: '/services/data/v58.0',
+        basePath: '/connect/communities/' + config.urlParams.communityId + '/navigation-menu/navigation-menu-items',
+        method: 'get',
+        body: null,
+        urlParams: config.urlParams,
+        queryParams: config.queryParams,
+        headers,
+        priority: 'normal',
+    };
+}
+
+const getCommunityNavigationMenu_ConfigPropertyNames = {
+    displayName: 'getCommunityNavigationMenu',
+    parameters: {
+        required: ['communityId'],
+        optional: ['addHomeMenuItem', 'effectiveAccountId', 'includeImageUrl', 'menuItemTypesToSkip', 'navigationLinkSetDeveloperName', 'navigationLinkSetId', 'publishStatus']
+    }
+};
+function createResourceParams(config) {
+    const resourceParams = {
+        urlParams: {
+            communityId: config.communityId
+        },
+        queryParams: {
+            addHomeMenuItem: config.addHomeMenuItem, effectiveAccountId: config.effectiveAccountId, includeImageUrl: config.includeImageUrl, menuItemTypesToSkip: config.menuItemTypesToSkip, navigationLinkSetDeveloperName: config.navigationLinkSetDeveloperName, navigationLinkSetId: config.navigationLinkSetId, publishStatus: config.publishStatus
+        }
+    };
+    return resourceParams;
+}
+function keyBuilder(luvio, config) {
+    const resourceParams = createResourceParams(config);
+    return keyBuilder$1(luvio, resourceParams);
+}
+function typeCheckConfig(untrustedConfig) {
+    const config = {};
+    const untrustedConfig_communityId = untrustedConfig.communityId;
+    if (typeof untrustedConfig_communityId === 'string') {
+        config.communityId = untrustedConfig_communityId;
+    }
+    const untrustedConfig_addHomeMenuItem = untrustedConfig.addHomeMenuItem;
+    if (typeof untrustedConfig_addHomeMenuItem === 'boolean') {
+        config.addHomeMenuItem = untrustedConfig_addHomeMenuItem;
+    }
+    const untrustedConfig_effectiveAccountId = untrustedConfig.effectiveAccountId;
+    if (typeof untrustedConfig_effectiveAccountId === 'string') {
+        config.effectiveAccountId = untrustedConfig_effectiveAccountId;
+    }
+    const untrustedConfig_includeImageUrl = untrustedConfig.includeImageUrl;
+    if (typeof untrustedConfig_includeImageUrl === 'boolean') {
+        config.includeImageUrl = untrustedConfig_includeImageUrl;
+    }
+    const untrustedConfig_menuItemTypesToSkip = untrustedConfig.menuItemTypesToSkip;
+    if (ArrayIsArray$1(untrustedConfig_menuItemTypesToSkip)) {
+        const untrustedConfig_menuItemTypesToSkip_array = [];
+        for (let i = 0, arrayLength = untrustedConfig_menuItemTypesToSkip.length; i < arrayLength; i++) {
+            const untrustedConfig_menuItemTypesToSkip_item = untrustedConfig_menuItemTypesToSkip[i];
+            if (typeof untrustedConfig_menuItemTypesToSkip_item === 'string') {
+                untrustedConfig_menuItemTypesToSkip_array.push(untrustedConfig_menuItemTypesToSkip_item);
+            }
+        }
+        config.menuItemTypesToSkip = untrustedConfig_menuItemTypesToSkip_array;
+    }
+    const untrustedConfig_navigationLinkSetDeveloperName = untrustedConfig.navigationLinkSetDeveloperName;
+    if (typeof untrustedConfig_navigationLinkSetDeveloperName === 'string') {
+        config.navigationLinkSetDeveloperName = untrustedConfig_navigationLinkSetDeveloperName;
+    }
+    const untrustedConfig_navigationLinkSetId = untrustedConfig.navigationLinkSetId;
+    if (typeof untrustedConfig_navigationLinkSetId === 'string') {
+        config.navigationLinkSetId = untrustedConfig_navigationLinkSetId;
+    }
+    const untrustedConfig_publishStatus = untrustedConfig.publishStatus;
+    if (typeof untrustedConfig_publishStatus === 'string') {
+        config.publishStatus = untrustedConfig_publishStatus;
+    }
+    return config;
+}
+function validateAdapterConfig(untrustedConfig, configPropertyNames) {
+    if (!untrustedIsObject(untrustedConfig)) {
+        return null;
+    }
+    if (process.env.NODE_ENV !== 'production') {
+        validateConfig(untrustedConfig, configPropertyNames);
+    }
+    const config = typeCheckConfig(untrustedConfig);
+    if (!areRequiredParametersPresent(config, configPropertyNames)) {
+        return null;
+    }
+    return config;
+}
+function adapterFragment(luvio, config) {
+    createResourceParams(config);
+    return select();
+}
+function onFetchResponseSuccess(luvio, config, resourceParams, response) {
+    const snapshot = ingestSuccess(luvio, resourceParams, response, {
+        config,
+        resolve: () => buildNetworkSnapshot(luvio, config, snapshotRefreshOptions)
+    });
+    return luvio.storeBroadcast().then(() => snapshot);
+}
+function onFetchResponseError(luvio, config, resourceParams, response) {
+    const snapshot = ingestError(luvio, resourceParams, response, {
+        config,
+        resolve: () => buildNetworkSnapshot(luvio, config, snapshotRefreshOptions)
+    });
+    return luvio.storeBroadcast().then(() => snapshot);
+}
+function buildNetworkSnapshot(luvio, config, options) {
+    const resourceParams = createResourceParams(config);
+    const request = createResourceRequest(resourceParams);
+    return luvio.dispatchResourceRequest(request, options)
+        .then((response) => {
+        return luvio.handleSuccessResponse(() => onFetchResponseSuccess(luvio, config, resourceParams, response), () => getResponseCacheKeys(luvio, resourceParams, response.body));
+    }, (response) => {
+        return luvio.handleErrorResponse(() => onFetchResponseError(luvio, config, resourceParams, response));
+    });
+}
+function buildNetworkSnapshotCachePolicy(context, coercedAdapterRequestContext) {
+    const { luvio, config } = context;
+    const { networkPriority, requestCorrelator, eventObservers } = coercedAdapterRequestContext;
+    const dispatchOptions = {
+        resourceRequestContext: {
+            requestCorrelator,
+            luvioRequestMethod: undefined,
+        },
+        eventObservers
+    };
+    if (networkPriority !== 'normal') {
+        dispatchOptions.overrides = {
+            priority: networkPriority
+        };
+    }
+    return buildNetworkSnapshot(luvio, config, dispatchOptions);
+}
+function buildCachedSnapshotCachePolicy(context, storeLookup) {
+    const { luvio, config } = context;
+    const selector = {
+        recordId: keyBuilder(luvio, config),
+        node: adapterFragment(luvio, config),
+        variables: {},
+    };
+    const cacheSnapshot = storeLookup(selector, {
+        config,
+        resolve: () => buildNetworkSnapshot(luvio, config, snapshotRefreshOptions)
+    });
+    return cacheSnapshot;
+}
+const getCommunityNavigationMenuAdapterFactory = (luvio) => function CommunityNavigation__getCommunityNavigationMenu(untrustedConfig, requestContext) {
+    const config = validateAdapterConfig(untrustedConfig, getCommunityNavigationMenu_ConfigPropertyNames);
+    // Invalid or incomplete config
+    if (config === null) {
+        return null;
+    }
+    return luvio.applyCachePolicy((requestContext || {}), { config, luvio }, // BuildSnapshotContext
+    buildCachedSnapshotCachePolicy, buildNetworkSnapshotCachePolicy);
+};
+
+let getCommunityNavigationMenu;
+// Imperative GET Adapters
+let getCommunityNavigationMenu_imperative;
+// Adapter Metadata
+const getCommunityNavigationMenuMetadata = { apiFamily: 'CommunityNavigation', name: 'getCommunityNavigationMenu' };
+function bindExportsTo(luvio) {
+    // LDS Adapters
+    const getCommunityNavigationMenu_ldsAdapter = createInstrumentedAdapter(createLDSAdapter(luvio, 'getCommunityNavigationMenu', getCommunityNavigationMenuAdapterFactory), getCommunityNavigationMenuMetadata);
+    return {
+        getCommunityNavigationMenu: createWireAdapterConstructor(luvio, getCommunityNavigationMenu_ldsAdapter, getCommunityNavigationMenuMetadata),
+        // Imperative GET Adapters
+        getCommunityNavigationMenu_imperative: createImperativeAdapter(luvio, getCommunityNavigationMenu_ldsAdapter, getCommunityNavigationMenuMetadata)
+    };
+}
+withDefaultLuvio((luvio) => {
+    ({
+        getCommunityNavigationMenu,
+        getCommunityNavigationMenu_imperative
+    } = bindExportsTo(luvio));
+});
+
+export { getCommunityNavigationMenu, getCommunityNavigationMenu_imperative };
+// version: 0.131.0-c1ec5b7de

package/src/raml/api.raml

@@ -0,0 +1,114 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '54.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v58.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  NavigationMenuItemCollectionRepresentation:
+    description: Navigation Menu Item Collection
+    type: object
+    properties:
+      menuItems:
+        description: Returns list of Navigation menu Items
+        type: array
+        items:
+          type: NavigationMenuItemRepresentation
+  NavigationMenuItemRepresentation:
+    description: Navigation Menu Item Representation
+    type: object
+    properties:
+      actionType:
+        description: Returns the url type or Event of Navigation Menu Item
+        type: string
+        enum:
+          - Event
+          - ExternalLink
+          - InternalLink
+      actionValue:
+        description: Returns the route url or event fqn for Navigation Menu item
+        type: string | nil
+      imageUrl:
+        description: Returns the image url for Navigation Menu item
+        type: string | nil
+      label:
+        description: Returns the label for Navigation Menu item
+        type: string
+      subMenu:
+        description: Returns the sub-menu for Navigation Menu Item
+        type: array
+        items:
+          type: NavigationMenuItemRepresentation
+      target:
+        description: Returns the target SameWindow/NewWindow for Navigation Menu item
+        type: string
+        enum:
+          - CurrentWindow
+          - NewWindow
+/connect/communities/{communityId}/navigation-menu/navigation-menu-items:
+  get:
+    description: Get all the navigation menu items
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: NavigationMenuItemCollectionRepresentation
+    queryParameters:
+      addHomeMenuItem:
+        type: boolean
+        required: false
+      effectiveAccountId:
+        type: string
+        required: false
+      includeImageUrl:
+        type: boolean
+        required: false
+      menuItemTypesToSkip:
+        type: array
+        required: false
+        items:
+          type: string
+          enum:
+            - Event
+            - ExternalLink
+            - GlobalAction
+            - InternalLink
+            - MenuLabel
+            - NavigationalTopic
+            - SalesforceObject
+            - SystemLink
+          (oas-collectionFormat): csv
+      navigationLinkSetDeveloperName:
+        type: string
+        required: false
+      navigationLinkSetId:
+        type: string
+        required: false
+      publishStatus:
+        type: string
+        required: false
+  uriParameters:
+    communityId:
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,17 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'CommunityNavigation'
+(luvio.ttl): 2592000000
+
+types:
+  NavigationMenuItemCollectionRepresentation:
+    (luvio.opaque): true
+
+/connect/communities/{communityId}/navigation-menu/navigation-menu-items:
+  get:
+    (luvio.adapter):
+      name: getCommunityNavigationMenu