Service - Menu Config

Overview

Manages configuration for site menus created by users and used in different areas of the project.

Repository

https://bitbucket.org/izara-core-shared/izara-core-shared-menu-config

ObjectSchema

MenuConfig

[
  {
    objectType: "menuConfig",
    storageResources: {
      "dynamodb": {
        storageType: "dynamoDB",
        tableName: "MenuConfigMain",
      }
    },
    fieldNames: {
      menuConfigId: {
        type: "string",
        randomOnCreate: true,
        requiredOnCreate: false,
        optionalOnCreate: false,
        canUpdate: false,
        storageResourceTags: ['dynamodb'],
      },
      menuConfig: {
        type: "object", 
        randomOnCreate: false,
        requiredOnCreate: true,
        optionalOnCreate: false,
        canUpdate: true,
        storageResourceTags: ['dynamodb'],
      },
      menuConfigName: {
        type: "string",
        randomOnCreate: false,
        requiredOnCreate: true,
        optionalOnCreate: false,
        canUpdate: true,
        storageResourceTags: ['dynamodb'],
      },
      userId: { // before put check with base-user-id or targetId
        type: "string",
        randomOnCreate: false,
        requiredOnCreate: true,
        optionalOnCreate: false,
        canUpdate: false,
        storageResourceTags: ['dynamodb'],
      },
    },
    identifiers: [
      {
        type: "partitionKey",
        fieldNames: "menuConfigId"
      },
    ],
  },
]

DynamoDB tables

MenuConfigMain

{
	menuConfigId: "xx", // {random uuid}
	menuConfig: "xx", // json encoded object of configuration
	menuConfigName: "yy", // user specified name of the config
	userId: "xx"
}

• partition key: menuConfigId
• sort key: {none}

UsersMenuConfigs

{
	userId: "xx" // user who owns the menuConfig
	menuConfigId: "xx",
}

• partition key: userId
• sort key: menuConfigId

menuConfig Object

{
	menuRows:[
		{
			rowName: "xx", // used when configuring only as a reference
			menuElements: [
				{
					elementType: "menu"
					menuElements: [
						{
							elementType: "staticUrl"
							url: "xxx",
						},
						{
							elementType: "sitePage"
							sitePageId: "xx",
						},
						{
							elementType: "plainText"
							plainText: "xxx",
						},
					],
				},
				{
					elementType: "projectMenu", // used for the main project menu
				}
				// ..
			]
		},
		// ..
	]
}

Working documents

Menu Config