@twin.org/identity-models 0.0.2-next.8 → 0.0.2-next.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -50,13 +50,13 @@ export interface IIdentityProfileComponent<T extends IJsonLdDocument = IJsonLdDo
50
50
  * @param publicFilters The filters to apply to the identities public profiles.
51
51
  * @param publicPropertyNames The public properties to get for the profile, defaults to all.
52
52
  * @param cursor The cursor for paged requests.
53
- * @param pageSize The maximum number of items in a page.
53
+ * @param limit The maximum number of items in a page.
54
54
  * @returns The list of items and cursor for paging.
55
55
  */
56
56
  list(publicFilters?: {
57
57
  propertyName: string;
58
58
  propertyValue: unknown;
59
- }[], publicPropertyNames?: (keyof T)[], cursor?: string, pageSize?: number): Promise<{
59
+ }[], publicPropertyNames?: (keyof T)[], cursor?: string, limit?: number): Promise<{
60
60
  /**
61
61
  * The identities.
62
62
  */
@@ -44,7 +44,7 @@ export interface IIdentityProfileConnector<T extends IJsonLdDocument = IJsonLdDo
44
44
  * @param publicPropertyNames The public properties to get for the profile, defaults to all.
45
45
  * @param privatePropertyNames The private properties to get for the profile, defaults to all.
46
46
  * @param cursor The cursor for paged requests.
47
- * @param pageSize The maximum number of items in a page.
47
+ * @param limit The maximum number of items in a page.
48
48
  * @returns The list of items and cursor for paging.
49
49
  */
50
50
  list(publicFilters?: {
@@ -53,7 +53,7 @@ export interface IIdentityProfileConnector<T extends IJsonLdDocument = IJsonLdDo
53
53
  }[], privateFilters?: {
54
54
  propertyName: string;
55
55
  propertyValue: unknown;
56
- }[], publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[], cursor?: string, pageSize?: number): Promise<{
56
+ }[], publicPropertyNames?: (keyof T)[], privatePropertyNames?: (keyof U)[], cursor?: string, limit?: number): Promise<{
57
57
  /**
58
58
  * The identity profiles.
59
59
  */
@@ -21,6 +21,6 @@ export interface IIdentityProfileListRequest {
21
21
  /**
22
22
  * Number of items to return.
23
23
  */
24
- pageSize?: number | string;
24
+ limit?: string;
25
25
  };
26
26
  }
package/docs/changelog.md CHANGED
@@ -1,5 +1,12 @@
1
1
  # @twin.org/identity-service-models - Changelog
2
2
 
3
+ ## [0.0.2-next.9](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.8...identity-models-v0.0.2-next.9) (2025-10-09)
4
+
5
+
6
+ ### Features
7
+
8
+ * add validate-locales ([04d74b4](https://github.com/twinfoundation/identity/commit/04d74b4d1ebe42672e8ca75a7bdb8e3556afd0be))
9
+
3
10
  ## [0.0.2-next.8](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.7...identity-models-v0.0.2-next.8) (2025-09-25)
4
11
 
5
12
 
@@ -6,6 +6,14 @@ Interface describing a contract which provides identity operations.
6
6
 
7
7
  - `IComponent`
8
8
 
9
+ ## Indexable
10
+
11
+ \[`key`: `string`\]: `any`
12
+
13
+ All methods are optional, so we introduce an index signature to allow
14
+ any additional properties or methods, which removes the TypeScript error where
15
+ the class has no properties in common with the type.
16
+
9
17
  ## Methods
10
18
 
11
19
  ### identityCreate()
@@ -6,6 +6,14 @@ Interface describing an identity connector.
6
6
 
7
7
  - `IComponent`
8
8
 
9
+ ## Indexable
10
+
11
+ \[`key`: `string`\]: `any`
12
+
13
+ All methods are optional, so we introduce an index signature to allow
14
+ any additional properties or methods, which removes the TypeScript error where
15
+ the class has no properties in common with the type.
16
+
9
17
  ## Methods
10
18
 
11
19
  ### createDocument()
@@ -16,6 +16,14 @@ Interface describing a contract which provides profile operations.
16
16
 
17
17
  `U` *extends* `IJsonLdDocument` = `IJsonLdDocument`
18
18
 
19
+ ## Indexable
20
+
21
+ \[`key`: `string`\]: `any`
22
+
23
+ All methods are optional, so we introduce an index signature to allow
24
+ any additional properties or methods, which removes the TypeScript error where
25
+ the class has no properties in common with the type.
26
+
19
27
  ## Methods
20
28
 
21
29
  ### create()
@@ -172,7 +180,7 @@ Nothing.
172
180
 
173
181
  ### list()
174
182
 
175
- > **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `pageSize?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
183
+ > **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
176
184
 
177
185
  Get a list of the requested identities.
178
186
 
@@ -196,7 +204,7 @@ The public properties to get for the profile, defaults to all.
196
204
 
197
205
  The cursor for paged requests.
198
206
 
199
- ##### pageSize?
207
+ ##### limit?
200
208
 
201
209
  `number`
202
210
 
@@ -16,6 +16,14 @@ Interface describing a contract which provides profile operations.
16
16
 
17
17
  `U` *extends* `IJsonLdDocument` = `IJsonLdDocument`
18
18
 
19
+ ## Indexable
20
+
21
+ \[`key`: `string`\]: `any`
22
+
23
+ All methods are optional, so we introduce an index signature to allow
24
+ any additional properties or methods, which removes the TypeScript error where
25
+ the class has no properties in common with the type.
26
+
19
27
  ## Methods
20
28
 
21
29
  ### create()
@@ -144,7 +152,7 @@ Nothing.
144
152
 
145
153
  ### list()
146
154
 
147
- > **list**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `pageSize?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
155
+ > **list**(`publicFilters?`, `privateFilters?`, `publicPropertyNames?`, `privatePropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
148
156
 
149
157
  Get a list of the requested identities.
150
158
 
@@ -180,7 +188,7 @@ The private properties to get for the profile, defaults to all.
180
188
 
181
189
  The cursor for paged requests.
182
190
 
183
- ##### pageSize?
191
+ ##### limit?
184
192
 
185
193
  `number`
186
194
 
@@ -28,8 +28,8 @@ The public properties to get for the profile, defaults to all, should be a comma
28
28
 
29
29
  The cursor for paged requests.
30
30
 
31
- #### pageSize?
31
+ #### limit?
32
32
 
33
- > `optional` **pageSize**: `string` \| `number`
33
+ > `optional` **limit**: `string`
34
34
 
35
35
  Number of items to return.
@@ -6,6 +6,14 @@ Interface describing a contract which provides identity operations.
6
6
 
7
7
  - `IComponent`
8
8
 
9
+ ## Indexable
10
+
11
+ \[`key`: `string`\]: `any`
12
+
13
+ All methods are optional, so we introduce an index signature to allow
14
+ any additional properties or methods, which removes the TypeScript error where
15
+ the class has no properties in common with the type.
16
+
9
17
  ## Methods
10
18
 
11
19
  ### identityResolve()
@@ -6,6 +6,14 @@ Interface describing an identity connector.
6
6
 
7
7
  - `IComponent`
8
8
 
9
+ ## Indexable
10
+
11
+ \[`key`: `string`\]: `any`
12
+
13
+ All methods are optional, so we introduce an index signature to allow
14
+ any additional properties or methods, which removes the TypeScript error where
15
+ the class has no properties in common with the type.
16
+
9
17
  ## Methods
10
18
 
11
19
  ### resolveDocument()
package/locales/en.json CHANGED
@@ -2,7 +2,6 @@
2
2
  "error": {
3
3
  "verificationHelper": {
4
4
  "jwtDecodeFailed": "Decoding the JWT failed",
5
- "proofTypeNotSupported": "The proof type \"{proofType}\" is not supported",
6
5
  "proofMissingVerificationMethod": "The proof is missing the verification method"
7
6
  },
8
7
  "documentHelper": {
@@ -12,11 +11,5 @@
12
11
  "idHelper": {
13
12
  "invalidDocumentId": "The document id \"{id}\" is invalid"
14
13
  }
15
- },
16
- "verifiableCredentialStates": {
17
- "pendingVerification": "Pending Verification",
18
- "rejected": "Rejected",
19
- "issued": "Issued",
20
- "revoked": "Revoked"
21
14
  }
22
15
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@twin.org/identity-models",
3
- "version": "0.0.2-next.8",
3
+ "version": "0.0.2-next.9",
4
4
  "description": "Models which define the structure of the contracts and connectors",
5
5
  "repository": {
6
6
  "type": "git",
@@ -38,5 +38,23 @@
38
38
  "dist/types",
39
39
  "locales",
40
40
  "docs"
41
- ]
41
+ ],
42
+ "keywords": [
43
+ "twin",
44
+ "trade",
45
+ "iota",
46
+ "framework",
47
+ "blockchain",
48
+ "identity",
49
+ "did",
50
+ "credentials",
51
+ "authentication",
52
+ "models",
53
+ "types",
54
+ "schemas"
55
+ ],
56
+ "bugs": {
57
+ "url": "git+https://github.com/twinfoundation/identity/issues"
58
+ },
59
+ "homepage": "https://twindev.org"
42
60
  }