Feature/v4 schema

.eslintrc

@@ -10,6 +10,12 @@
     "@typescript-eslint/ban-ts-comment": 1,
     "@typescript-eslint/ban-types": 1,
     "@typescript-eslint/interface-name-prefix": 0,
-    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }]
+    "@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
+    "@typescript-eslint/explicit-member-accessibility": 1,
+    "no-underscore-dangle": 1,
+    "prefer-spread": 0
+  },
+  "parserOptions": {
+    "project": ["./packages/datx/tsconfig.json"]
   }
 }

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,65 @@
+name: Bug report
+description: Report a bug with the library
+labels: bug
+assignees: DarkoKukovec
+body:
+  - type: input
+    id: libs
+    validations:
+      required: true
+    attributes:
+      label: Used libraries
+      description: Which `@datx` libraries are you using
+      placeholder: core, jsonapi, ...
+  - type: input
+    id: versions
+    validations:
+      required: true
+    attributes:
+      label: Library version(s)
+      description: Version of the `@datx` libraries you're using
+      placeholder: "@datx/core 2.3.1, @datx/jsonapi 2.3.0"
+  - type: textarea
+    id: api
+    attributes:
+      label: Sample API response (if relevant)
+      description: If the issue is network related, please provide a sample API response for the issue
+  - type: input
+    id: issue-envs
+    validations:
+      required: true
+    attributes:
+      label: Environments with the issue
+      description: Where does the issue happen
+      placeholder: iOS Safari 15, Node.js 14
+  - type: input
+    id: ok-envs
+    attributes:
+      label: Environments without the issue
+      description: Environments that you've checked and work fine
+      placeholder: Chrome 99, Firefox 96, Node.js 16
+  - type: textarea
+    id: current
+    attributes:
+      label: Current behavior
+      description: What is the issue - the behavior that you think doesn't work as expected
+    validations:
+      required: true
+  - type: textarea
+    id: ecpected
+    attributes:
+      label: Expected behavior
+      description: What do you expect to happen instead - the correct behavior
+    validations:
+      required: true
+  - type: textarea
+    id: steps
+    attributes:
+      label: Reproduction steps
+      description: "How do you trigger this bug? Please walk us through it step by step."
+      value: |
+        1.
+        2.
+        3.
+        ...
+      render: bash

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,47 @@
+name: Feature request
+description: Describe a feature the lib is missing which you think should be added.
+labels: enhancement
+assignees: DarkoKukovec
+body:
+  - type: checkboxes
+    id: major-version
+    validations:
+      required: true
+    attributes:
+      label: Relevant version
+      description: Which major version of `@datx` is relevant for you?
+      options:
+        - label: 0.x
+        - label: 1.x
+        - label: 2.x
+  - type: checkboxes
+    id: libs
+    validations:
+      required: true
+    attributes:
+      label: Relevant libraries
+      description: Which `@datx` libraries are relevant for this change?
+      options:
+        - label: utils
+        - label: core
+        - label: network
+        - label: jsonapi
+        - label: jsonapi-angular
+  - type: dropdown
+    id: breaking
+    validations:
+      required: true
+    attributes:
+      label: Breaking change
+      description: Would this change cause a breaking change (where some existing feature would break)?
+      options:
+        - "Yes"
+        - "No"
+        - I'm not sure
+  - type: textarea
+    id: description
+    validations:
+      required: true
+    attributes:
+      label: Description
+      description: Please describe the feature you're suggesting with as many details as possible

.github/ISSUE_TEMPLATE/support_request.yml

@@ -0,0 +1,28 @@
+name: Support request
+description: Have a question that isn't answered in the docs? Have an issue you're not able to resolve?
+labels: support
+assignees: DarkoKukovec
+body:
+  - type: input
+    id: libs
+    validations:
+      required: true
+    attributes:
+      label: Used libraries
+      description: Which `@datx` libraries are you using
+      placeholder: core, jsonapi, ...
+  - type: input
+    id: versions
+    validations:
+      required: true
+    attributes:
+      label: Library version(s)
+      description: Version of the `@datx` libraries you're using
+      placeholder: "@datx/core 2.3.1, @datx/jsonapi 2.3.0"
+  - type: textarea
+    id: issue
+    attributes:
+      label: Issue description
+      description: Please describe your issue with as much details (and examples) as possible
+    validations:
+      required: true

.github/dependabot.yml

@@ -0,0 +1,21 @@
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "daily"
+    labels:
+      - "maintenance"
+    assignees:
+      - "DarkoKukovec"
+    open-pull-requests-limit: 10
+  - package-ecosystem: "npm"
+    directory: "/website"
+    schedule:
+      interval: "daily"
+    labels:
+      - "maintenance"
+      - "documentation"
+    assignees:
+      - "DarkoKukovec"
+    open-pull-requests-limit: 10

.github/workflows/codeql-analysis.yml

@@ -38,7 +38,7 @@ jobs:
 
     # If this run was triggered by a pull request event, then checkout
     # the head of the pull request instead of the merge commit.
-    - run: git checkout HEAD^2
+    - run: git checkout
       if: ${{ github.event_name == 'pull_request' }}
 
     # Initializes the CodeQL tools for scanning.

.gitignore

@@ -26,6 +26,7 @@ typings/
 
 # Optional npm cache directory
 .npm
+.yarn
 
 # Optional eslint cache
 .eslintcache
@@ -48,5 +49,4 @@ website/build
 website/.DS_Store
 .DS_Store
 
-disable-mobx.d.ts
-disable-mobx.js
+**/min/*

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode"]
+}

.vscode/settings.json

@@ -1,4 +1,11 @@
 {
   "typescript.tsdk": "node_modules/typescript/lib",
-  "workbench.colorCustomizations": {}
-}
+  "workbench.colorCustomizations": {},
+  "editor.formatOnPaste": true,
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "angular.enable-strict-mode-prompt": false,
+  "i18n-ally.localesPaths": [
+    "website/i18n"
+  ]
+}

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

CONTRIBUTING.md

@@ -15,3 +15,26 @@ Please note we have a code of conduct, please follow it in all your interactions
    Pull Request would represent. The versioning scheme we use is [SemVer](https://semver.org/).
 4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
    do not have permission to do that, you may request the second reviewer to merge it for you.
+
+## Project setup
+
+1. Install lerna globally `yarn global add lerna`
+2. Run `lerna bootstrap`
+3. If you're getting errors for other datx package imports, also run `lerna run build` and `lerna link`
+
+## Updating local dependencies
+
+Example: If you have made a change in `@datx/utils` and need to use the new change in `@datx/core`, it should be enough to run `yarn build` in the `datx-utils` folder. If the editor doesn't detect the changes, you can try to cmd+click on the error (forcing the editor to reload the typings).
+
+## Testing
+
+To test a specific package, run `yarn test` in its folder. If you want to run all tests, you can run `lerna run test` in the root folder. This will run tests in one of the variants. Once you push the code to the repository, GHA will run tests on all variants (mobx version combinations).
+
+## Writing docs
+
+When writing docs, make sure your updates are writtern in  `versioned_docs/{version}` and `versioned_sidebars/{version}` to be visible once docs are generated and published. Otherwise, only `next` version on the docs website will be updated and published.
+
+## Publishing
+
+1. `lerna publish`
+

README.md

@@ -100,7 +100,7 @@ Want to make your own mixin? Check out [the guide](https://datx.dev/docs/mixins/
 
 ## Troubleshooting
 
-Having issues with the library? Check out the [troubleshooting](https://datx.dev/docs/troubleshooting/known-issues) page or [open](https://github.com/infinum/datx/issues/new) an issue.
+Having issues with the library? Check out the [troubleshooting](https://datx.dev/docs/troubleshooting/known-issues) page or [open](https://github.com/infinum/datx/issues/new/choose) an issue.
 
 ---
 

SECURITY.md

@@ -0,0 +1,13 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 2.x.x   | :white_check_mark: |
+| 1.0.x   | :white_check_mark: |
+| < 1.0   | :x:                |
+
+## Reporting a Vulnerability
+
+If a security issue is discovered, please report it to [email protected]. We'll work on resolving the issue ASAP.

docs/api-reference/attribute.md

@@ -100,6 +100,17 @@ Example:
 
 Sometimes, you'll need to map your data in a way that might not be compatible with your API (or maybe for some other reason specific to your use case). This could range from renaming properties to converting them to other types (e.g. from a date string to a date object). This is where parsers and serializers can be used. The functions are passed as options to the `@Attribute` decorator.
 
+### map
+
+The map property maps a single property from the input object to the model (before the parse call) and back (after the serialize call).
+
+Example:
+
+```typescript
+@Attribute({ map: 'first_name' })
+public firstName: string;
+```
+
 ### parse
 
 The parse function rceives the raw value (first argument is the eact property and the second value is the whole model). It should return the value which should be used to initialize the model.
@@ -121,6 +132,20 @@ public createdBy: string;
 
 ```
 
+## Compound IDs
+
+Altrough there is no out-of-the-box solution for compound IDs in DatX, it is easy to achieve them using the `Attribute` features defined above:
+
+```typescript
+@Attribute({
+  // Set it as an identifier
+  isIdentifier: true,
+  // Combine two (userId, companyId) IDs into a single compound ID
+  parse: (_: never, data: Record<string, string>) => `${data.userId}-${data.companyId}`
+})
+public id: string;
+```
+
 ## Using `Attribute` without decorators
 
 [In some cases](https://github.com/infinum/datx/issues/92), you might not be able to use the `@Attribute()` decorator, but you can still use it as a function. The function has two arguments: the class you're decorating and name of the property you're decorating. You can find the example in the [defining models](https://github.com/infinum/datx/wiki/Defining-models) section.