Skip to content

Commit dff0b2c

Browse files
authored
Fix Document and CollectionMappings (#573)
## What does this PR do? Allows to instantiate a `Document` without `_kuzzle_info`. Fix the declaration of properties in `CollectionMappings`
1 parent 4e756a5 commit dff0b2c

File tree

6 files changed

+21
-14
lines changed

6 files changed

+21
-14
lines changed

src/types/ApiKey.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
/**
22
* ApiKey
3+
*
4+
* @see https://docs.kuzzle.io/core/2/guides/advanced/api-keys/
35
*/
46
export type ApiKey = {
57
/**

src/types/Document.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,26 @@ import { JSONObject } from './JSONObject';
22

33
/**
44
* Kuzzle metadata
5-
* @see https://docs.kuzzle.io/core/2/guides/essentials/document-metadata/
5+
* @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#kuzzle-metadata
66
*/
77
export interface DocumentMetadata {
8-
_kuzzle_info: {
8+
_kuzzle_info?: {
99
/**
1010
* Kuid of the user who created the document
1111
*/
12-
author: string,
12+
author?: string,
1313
/**
1414
* Creation date in micro-timestamp
1515
*/
16-
createdAt: number,
16+
createdAt?: number,
1717
/**
1818
* Kuid of the user who last updated the document
1919
*/
20-
updater: string | null,
20+
updater?: string | null,
2121
/**
2222
* Update date in micro-timestamp
2323
*/
24-
updatedAt: number | null
24+
updatedAt?: number | null
2525
}
2626
}
2727

src/types/HttpRoutes.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
/**
22
* HTTP routes definition format
3+
*
4+
* @see https://docs.kuzzle.io/core/2/guides/develop-on-kuzzle/api-controllers/#http-routes
5+
*
36
* @example
47
* {
58
* <controller>: {

src/types/Mappings.ts

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,39 +4,41 @@ export type MappingsProperties = {
44
/**
55
* Properties types definition
66
*
7-
* @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/#properties-types-definition
7+
* @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#mappings-properties
88
*/
99
properties?: MappingsProperties,
1010
/**
1111
* Dynamic mapping policy
1212
*
13-
* @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/#dynamic-mapping-policy
13+
* @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#mappings-dynamic-policy
1414
*/
1515
dynamic?: 'true' | 'false' | 'strict'
16+
17+
[property: string]: JSONObject | string;
1618
}
1719

1820
/**
1921
* Collection mappings definition
2022
*
21-
* @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/
23+
* @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#collection-mappings
2224
*/
2325
export type CollectionMappings = {
2426
/**
2527
* Collection metadata
2628
*
27-
* @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/#collection-metadata
29+
* @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#mappings-metadata
2830
*/
2931
_meta?: JSONObject;
3032
/**
3133
* Properties types definition
3234
*
33-
* @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/#properties-types-definition
35+
* @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#mappings-properties
3436
*/
3537
properties?: MappingsProperties,
3638
/**
3739
* Dynamic mapping policy
3840
*
39-
* @see https://docs.kuzzle.io/core/2/guides/essentials/database-mappings/#dynamic-mapping-policy
41+
* @see https://docs.kuzzle.io/core/2/guides/main-concepts/data-storage/#mappings-dynamic-polic
4042
*/
4143
dynamic?: 'true' | 'false' | 'strict',
4244
}

src/types/ProfilePolicy.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* }
1414
* }
1515
*
16-
* @see https://docs.kuzzle.io/core/2/guides/essentials/security/#defining-profiles
16+
* @see https://docs.kuzzle.io/core/2/guides/main-concepts/permissions/#policies
1717
*/
1818
export type ProfilePolicy = {
1919
/**

src/types/RoleRightsDefinition.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
* }
2020
* }
2121
*
22-
* @see https://docs.kuzzle.io/core/2/guides/essentials/security#defining-roles
22+
* @see https://docs.kuzzle.io/core/2/guides/main-concepts/permissions/#roles
2323
*/
2424
export type RoleRightsDefinition = {
2525
/**

0 commit comments

Comments
 (0)