Feature/doc

.gitignore

@@ -0,0 +1,6 @@
+src-gen/
+target/
+.settings/
+
+*.zmapp
+*.zmar

README.md

@@ -1,13 +1,15 @@
 # ZetaPush Official Recipes
 
-> This monorepo contains all official recipes
+> This monorepo contains all official recipes 
 
 ## Overview
 
+*High level recipes abstracting the use of Zetapush services*
+
 Core recipes
 
 - Config
-- Conversation
+- Room
 - File
 - Group
 - Notification
@@ -23,4 +25,147 @@ Plugin recipes
 
 ## Documentation
 
-Coming Soon
+Recipes propose API verbs contained in the folder `src/api/`, the one you may call in your macros. Additionally, some recipes contain a folder `src/impl` which you might need if you want to create your own API verbs. 
+
+*No documentation will be provided for these particular macros as using them probably means you're advanced enough with the use of ZetaPush services.*
+
+### Config ###
+
+Config recipe has been created to easily store a global string or object. That's why the api is separated into two parts, `src/api/object` and `src/api/string`. The api verbs are the same for both part, and they consist of :
+
+* get<Type>Config
+* list<Type>Config
+* remove<Type>Config
+* set<Type>Config
+
+Where <Type> is Object or String, depending on the type you want to manipulate. The config recipe will manipulate a Gda table impersonating a global user, and simplify you the use of a shared storage.
+
+
+### Conversation ###
+
+Conversation recipe, as the name suggests it, is designed for creating a conversation (= a list of messages shared between defined users) and adding/modifying messages in an existing conversation.
+
+* addConversationMessage
+* createConversation
+* createOneToOneConversation
+* getConversation
+* getConversationMessageList
+* getUserConversationList
+* purgeConversationMessageList
+* purgeConversationMessage
+
+By using this recipe you will overpass the system of permissions and storage access which will be delegated to the macros listed above.
+
+### File ###
+
+File upload is a specificity of the HDFS storage. When uploading you first need the url where to upload the file. Then the upload is handled by the client, by example with an AJAX request.
+
+* confirmFileUpload
+* deleteFileEntry
+* getFileEntry
+* getFileEntryList
+* requestFileUpload
+
+### Group ###
+
+Group recipe offers high level macros to interact with groups, and implements metadata to them. If you need a global group (global means public in this context), you may need Organization recipe.
+
+* createGroup
+* deleteGroup
+* getGroup
+* getGroupList
+* getUserGroupList
+
+* addGroupMember
+* isMemberOf
+* removeGroupMember
+
+### Notification ###
+
+TODO
+
+### Organization ###
+
+An organization is exactly what you need when you would like to have a "global" group where all users are in by default.
+On their creation, users will be auto-addded to the organization set as default. You can visualize organizations as specific groups, attributed to a global user.
+
+* createOrganization
+* getDefaultOrganization
+* setDefaultOrganization
+* getOrganization
+* getOrganizationList
+* getUserOrganizationList
+
+* addOrganizationMember
+* removeOrganizationMember
+
+* getUserContactList
+
+### Role ###
+
+Three entities : Member, Permission, Role
+
+TODO
+
+### User ###
+
+Users can be managed from the user recipe. This recipe gives an access to several methods allowing creation of new user and modification of user informations such as the password, the avatar, or custom ones.
+
+`> src/api/avatar`
+* updateUserAvatar
+
+`> src/api/password`
+* confirmUserPassword
+* resetUserPassword
+* resetUserPasswordByLogin
+
+`> src/api/user`
+* createUser
+* getUser
+* getUserByLogin
+* getUserList
+* updateUser
+
+*Without the ByLogin suffix, the current user key (matching __userKey) is used. ByLogin permits to chose the user to impersonate.*
+
+### Utils ###
+
+The utils recipe (used by most of the other recipes) include gestion of three entities : metadata, tags, targets. For each entity, get, remove and set are proposed.
+Moreover utils recipe brings common macros and constants you may need such as hashing, mapping, generating uuid, global user, etc...
+
+`> src/api/utils`
+* explode
+* hash
+* implode
+* map
+* pagination
+* reduce
+* string
+* uuid
+
+`> src/api/<Type>`
+* get<Type>
+* remove<Type>
+* set<Type>
+
+Where <Type> is Metadata, Tags or Targets.
+
+### Whiteboard ###
+
+Whiteboard recipe is closely related to conversation recipe. It brings possibility to attribute a whiteboard to a conversation, which is just a set of objects added and linked to the conversation. Then you will be able to modify or remove these objects with the following methods.
+
+* createWhiteboard
+
+* addWhiteboardObject
+* getWhiteboardObjectList
+* purgeWhiteboardObjectList
+* updateWhiteboardObject
+
+
+
+
+
+
+
+
+

com.zetapush.core.config/README.md

@@ -0,0 +1,10 @@
+### Config Recipe ###
+
+Config recipe has been created to easily store a global string or object. That's why the api is separated into two parts, `src/api/object` and `src/api/string`. The api verbs are the same for both part, and they consist of :
+
+* get<Type>Config
+* list<Type>Config
+* remove<Type>Config
+* set<Type>Config
+
+Where <Type> is Object or String, depending on the type you want to manipulate. The config recipe will manipulate a Gda table impersonating a global user, and simplify you the use of a shared storage.

com.zetapush.core.config/recipe.zms

@@ -1,10 +1,13 @@
 /**
  * ZetaPush Official Core Recipe
  * Provide config APIs
+ *
+ * Licence MIT
+ * Copyright ZetaPush SAS © 2016-2017
  */
-recipe com.zetapush.core.config 2.0.0;
+recipe com.zetapush.core.config 1.0.0;
 
-import recipe com.zetapush.core.utils 2.0.0 in zpRecipeUtils;
+import recipe com.zetapush.core.utils 1.0.0 in zpRecipeUtils;
 
 // Constants
 

com.zetapush.core.config/src/api/object/__types__.zms

@@ -0,0 +1,7 @@
+class ObjectConfigPaginatedList extends zpRecipeUtils::PaginatedList {
+	ObjectConfig[] content;
+}
+
+class ObjectConfig extends zpRecipeUtils::Storable {
+	/** Value */ map value;
+}

com.zetapush.core.config/src/api/object/getObjectConfig.zms

@@ -2,7 +2,7 @@ macroscript getObjectConfig(
 	/** Config id */ @NotNull string id
 ) {
 	/** Get stored config entry */
-	var { result: { revision, update, value: { value } } } = sudo zpRecipeUtils::GLOBAL_OWNER call zpRecipeUtils::core_utils__getStoredObject({
+	const stored = sudo zpRecipeUtils::GLOBAL_OWNER await zpRecipeUtils::core_utils__getStoredObject({
 		id, table: TABLE_OBJECT_CONFIG, zpService: zpServiceGda
-	}) hardFail;
-} broadcast { id, value, revision, update } on channel __selfName
+	});
+} broadcast new ObjectConfig(stored.id, stored.revision, stored.update, stored.value.wrapper) on channel __selfName

com.zetapush.core.config/src/api/object/listObjectConfig.zms

@@ -1,11 +1,8 @@
 macroscript listObjectConfig(
-	/** Pagination query */ map page
+	class zpRecipeUtils::Pagination page
 ) {
 	/** List stored objects */
-	var { result } = sudo zpRecipeUtils::GLOBAL_OWNER call zpRecipeUtils::core_utils__listStoredObject({
+	const list = sudo zpRecipeUtils::GLOBAL_OWNER await zpRecipeUtils::core_utils__listStoredObject({
 		table: TABLE_OBJECT_CONFIG, page, zpService: zpServiceGda
-	}) hardFail;
-	/** Destructure result properties */
-	var content = coll:map(result.content, entry -> zpRecipeUtils::map_entry_key_value(entry));	
-	page = result.page;
-} broadcast { content, page } on channel __selfName
+	});	
+} broadcast new ObjectConfigPaginatedList(list.page, list.content) on channel __selfName

com.zetapush.core.config/src/api/object/removeObjectConfig.zms

@@ -1,7 +1,8 @@
 macroscript removeObjectConfig(
 	/** Config id */ @NotNull string id
 ) {
-	sudo zpRecipeUtils::GLOBAL_OWNER call zpRecipeUtils::core_utils__removeStoredObject({
+	/** Remove stored object */
+	sudo zpRecipeUtils::GLOBAL_OWNER await zpRecipeUtils::core_utils__removeStoredObject({
 		id, table: TABLE_OBJECT_CONFIG, zpService: zpServiceGda
-	}) hardFail;
-} broadcast { id } on channel __selfName
+	});
+} broadcast { string id } on channel __selfName

com.zetapush.core.config/src/api/object/setObjectConfig.zms

@@ -2,7 +2,7 @@ macroscript setObjectConfig(
 	/** Config Id */ @NotNull string id,
 	/** Config Value */ @NotNull value
 ) {
-	var { result: { revision, update } } = sudo zpRecipeUtils::GLOBAL_OWNER call zpRecipeUtils::core_utils__setStoredObject({
-		id, value: { value }, table: TABLE_OBJECT_CONFIG, zpService: zpServiceGda
-	}) hardFail;
-} broadcast { id, value, revision, update } on channel __selfName
+	const stored = sudo zpRecipeUtils::GLOBAL_OWNER await zpRecipeUtils::core_utils__setStoredObject({
+		id, value: { wrapper: value }, table: TABLE_OBJECT_CONFIG, zpService: zpServiceGda
+	});
+} broadcast new ObjectConfig(stored.id, stored.revision, stored.update, stored.value.wrapper) on channel __selfName

com.zetapush.core.config/src/api/string/__types__.zms

@@ -0,0 +1,7 @@
+class StringConfigPaginatedList extends zpRecipeUtils::PaginatedList {
+	StringConfig[] content;
+}
+
+class StringConfig extends zpRecipeUtils::Storable {
+	/** Value */ string value;
+}

com.zetapush.core.config/src/api/string/getStringConfig.zms

@@ -2,9 +2,7 @@ macroscript getStringConfig(
 	/** String Config Id */ @NotNull string id
 ) {
 	/** Get stored config entry */
-	var { result: { revision, update, value } } = sudo zpRecipeUtils::GLOBAL_OWNER call zpRecipeUtils::core_utils__getStoredObject({
+	const stored = sudo zpRecipeUtils::GLOBAL_OWNER await zpRecipeUtils::core_utils__getStoredObject({
 		id, table: TABLE_STRING_CONFIG, zpService: zpServiceGda
-	}) hardFail;
-	/** Implode stored value */
-	value = zpRecipeUtils::implode(value);
-} broadcast { id, value, revision, update } on channel __selfName
+	});
+} broadcast new StringConfig(stored.id, stored.revision, stored.update, zpRecipeUtils::implode(stored.value)) on channel __selfName

com.zetapush.core.config/src/api/string/listStringConfig.zms

@@ -1,11 +1,8 @@
 macroscript listStringConfig(
-	/** Pagination query */ map page
+	class zpRecipeUtils::Pagination page
 ) {
 	/** List stored objects */
-	var { result } = sudo zpRecipeUtils::GLOBAL_OWNER call zpRecipeUtils::core_utils__listStoredObject({
+	const list = sudo zpRecipeUtils::GLOBAL_OWNER await zpRecipeUtils::core_utils__listStoredObject({
 		table: TABLE_STRING_CONFIG, page, zpService: zpServiceGda
-	}) hardFail;
-	/** Destructure result properties */
-	var content = coll:map(result.content, entry -> zpRecipeUtils::map_entry_key_value(entry));	
-	page = result.page;
-} broadcast { content, page } on channel __selfName
+	});
+} broadcast new StringConfigPaginatedList(list.page, list.content) on channel __selfName

com.zetapush.core.config/src/api/string/removeStringConfig.zms

@@ -1,7 +1,7 @@
 macroscript removeStringConfig(
 	/** Config id */ @NotNull string id
 ) {
-	sudo zpRecipeUtils::GLOBAL_OWNER call zpRecipeUtils::core_utils__removeStoredObject({
+	sudo zpRecipeUtils::GLOBAL_OWNER await zpRecipeUtils::core_utils__removeStoredObject({
 		id, table: TABLE_STRING_CONFIG, zpService: zpServiceGda
-	}) hardFail;
-} broadcast { id } on channel __selfName
+	});
+} broadcast { string id } on channel __selfName

com.zetapush.core.config/src/api/string/setStringConfig.zms

@@ -2,7 +2,8 @@ macroscript setStringConfig(
 	/** Config Id */ @NotNull string id,
 	/** Config Value */ @NotNull string value
 ) {
-	var { result: { revision, update } } = sudo zpRecipeUtils::GLOBAL_OWNER call zpRecipeUtils::core_utils__setStoredObject({
+	/** Set stored config entry */
+	const stored = sudo zpRecipeUtils::GLOBAL_OWNER await zpRecipeUtils::core_utils__setStoredObject({
 		id, value: zpRecipeUtils::explode(value, CONFIG_VALUE_CELL_LIMIT), table: TABLE_STRING_CONFIG, zpService: zpServiceGda
-	}) hardFail;
-} broadcast { id, value, revision, update } on channel __selfName
+	});
+} broadcast new StringConfig(stored.id, stored.revision, stored.update, zpRecipeUtils::implode(stored.value)) on channel __selfName

com.zetapush.core.context.tests/.gitignore

@@ -0,0 +1,4 @@
+# generated by the ZMS compilation process
+target/
+
+zms.user.properties

com.zetapush.core.context.tests/.project

@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>com.zetapush.core.context.tests</name>
+	<comment></comment>
+	<projects>
+		<project>com.zetapush.core.context</project>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.xtext.ui.shared.xtextBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.xtext.ui.shared.xtextNature</nature>
+	</natures>
+	<filteredResources>
+		<filter>
+			<id>1490884040025</id>
+			<name></name>
+			<type>10</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-true-false-target</arguments>
+			</matcher>
+		</filter>
+		<filter>
+			<id>1490884040026</id>
+			<name></name>
+			<type>6</type>
+			<matcher>
+				<id>org.eclipse.ui.ide.multiFilter</id>
+				<arguments>1.0-name-matches-true-false-com.zetapush.core.context.tests-*.zmapp</arguments>
+			</matcher>
+		</filter>
+	</filteredResources>
+</projectDescription>

com.zetapush.core.context.tests/README.md

@@ -0,0 +1,3 @@
+### README for com.zetapush.core.context.tests
+
+Documentation in markdown format for a comprehensive description

com.zetapush.core.context.tests/init.zms

@@ -0,0 +1,8 @@
+sudo contexts::CONTEXT_TEMPLATES_VIRTUAL_USER call contexts::createContextTemplate({
+	contextTemplateId : TEMPLATE_CTX_VENTES,
+	contextTemplateName : 'Ventes immobilières',
+	workflowTemplateName : TEMPLATE_WF_VENTES,
+	fields : [],
+	groups : [contexts::CONTEXT_MANAGERS_GROUP_FQN],
+	defaultWorkflowState : VENTES_STATE_CREATED
+});