@arke-institute/sdk 2.3.3 → 2.3.5
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.
- package/dist/generated/index.d.cts +125 -1
- package/dist/generated/index.d.ts +125 -1
- package/openapi/spec.json +189 -0
- package/openapi/version.json +1 -1
- package/package.json +1 -1
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*
|
|
7
7
|
* Source: Arke v1 API
|
|
8
8
|
* Version: 1.0.0
|
|
9
|
-
* Generated: 2026-01-
|
|
9
|
+
* Generated: 2026-01-05T15:10:38.577Z
|
|
10
10
|
*/
|
|
11
11
|
type paths = {
|
|
12
12
|
"/auth/register": {
|
|
@@ -1497,6 +1497,89 @@ type paths = {
|
|
|
1497
1497
|
patch?: never;
|
|
1498
1498
|
trace?: never;
|
|
1499
1499
|
};
|
|
1500
|
+
"/collections/{id}/entities": {
|
|
1501
|
+
parameters: {
|
|
1502
|
+
query?: never;
|
|
1503
|
+
header?: never;
|
|
1504
|
+
path?: never;
|
|
1505
|
+
cookie?: never;
|
|
1506
|
+
};
|
|
1507
|
+
/**
|
|
1508
|
+
* List entities in a collection
|
|
1509
|
+
* @description Returns entities belonging to this collection from the graph database.
|
|
1510
|
+
*
|
|
1511
|
+
* Supports pagination and optional type filtering. Results are ordered by creation date (newest first).
|
|
1512
|
+
*/
|
|
1513
|
+
get: {
|
|
1514
|
+
parameters: {
|
|
1515
|
+
query?: {
|
|
1516
|
+
type?: string;
|
|
1517
|
+
limit?: number;
|
|
1518
|
+
offset?: number | null;
|
|
1519
|
+
};
|
|
1520
|
+
header?: never;
|
|
1521
|
+
path: {
|
|
1522
|
+
/** @description Entity ID (ULID) */
|
|
1523
|
+
id: string;
|
|
1524
|
+
};
|
|
1525
|
+
cookie?: never;
|
|
1526
|
+
};
|
|
1527
|
+
requestBody?: never;
|
|
1528
|
+
responses: {
|
|
1529
|
+
/** @description Entities in collection */
|
|
1530
|
+
200: {
|
|
1531
|
+
headers: {
|
|
1532
|
+
[name: string]: unknown;
|
|
1533
|
+
};
|
|
1534
|
+
content: {
|
|
1535
|
+
"application/json": components["schemas"]["CollectionEntitiesResponse"];
|
|
1536
|
+
};
|
|
1537
|
+
};
|
|
1538
|
+
/** @description Forbidden - Insufficient permissions */
|
|
1539
|
+
403: {
|
|
1540
|
+
headers: {
|
|
1541
|
+
[name: string]: unknown;
|
|
1542
|
+
};
|
|
1543
|
+
content: {
|
|
1544
|
+
/**
|
|
1545
|
+
* @example {
|
|
1546
|
+
* "error": "Forbidden: You do not have permission to perform this action"
|
|
1547
|
+
* }
|
|
1548
|
+
*/
|
|
1549
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1550
|
+
};
|
|
1551
|
+
};
|
|
1552
|
+
/** @description Not Found - Resource does not exist */
|
|
1553
|
+
404: {
|
|
1554
|
+
headers: {
|
|
1555
|
+
[name: string]: unknown;
|
|
1556
|
+
};
|
|
1557
|
+
content: {
|
|
1558
|
+
/**
|
|
1559
|
+
* @example {
|
|
1560
|
+
* "error": "Entity not found"
|
|
1561
|
+
* }
|
|
1562
|
+
*/
|
|
1563
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1564
|
+
};
|
|
1565
|
+
};
|
|
1566
|
+
/** @description GraphDB service unavailable */
|
|
1567
|
+
503: {
|
|
1568
|
+
headers: {
|
|
1569
|
+
[name: string]: unknown;
|
|
1570
|
+
};
|
|
1571
|
+
content?: never;
|
|
1572
|
+
};
|
|
1573
|
+
};
|
|
1574
|
+
};
|
|
1575
|
+
put?: never;
|
|
1576
|
+
post?: never;
|
|
1577
|
+
delete?: never;
|
|
1578
|
+
options?: never;
|
|
1579
|
+
head?: never;
|
|
1580
|
+
patch?: never;
|
|
1581
|
+
trace?: never;
|
|
1582
|
+
};
|
|
1500
1583
|
"/entities": {
|
|
1501
1584
|
parameters: {
|
|
1502
1585
|
query?: never;
|
|
@@ -5618,6 +5701,47 @@ type components = {
|
|
|
5618
5701
|
*/
|
|
5619
5702
|
entity_id: string;
|
|
5620
5703
|
};
|
|
5704
|
+
CollectionEntitySummary: {
|
|
5705
|
+
/** @description Entity persistent identifier */
|
|
5706
|
+
pi: string;
|
|
5707
|
+
/**
|
|
5708
|
+
* @description Entity type
|
|
5709
|
+
* @example document
|
|
5710
|
+
*/
|
|
5711
|
+
type: string;
|
|
5712
|
+
/**
|
|
5713
|
+
* @description Entity display label
|
|
5714
|
+
* @example My Document
|
|
5715
|
+
*/
|
|
5716
|
+
label: string;
|
|
5717
|
+
/**
|
|
5718
|
+
* Format: date-time
|
|
5719
|
+
* @description When the entity was created
|
|
5720
|
+
*/
|
|
5721
|
+
created_at: string;
|
|
5722
|
+
/**
|
|
5723
|
+
* Format: date-time
|
|
5724
|
+
* @description When the entity was last updated
|
|
5725
|
+
*/
|
|
5726
|
+
updated_at: string;
|
|
5727
|
+
};
|
|
5728
|
+
CollectionEntitiesResponse: {
|
|
5729
|
+
/** @description Collection ID */
|
|
5730
|
+
collection_id: string;
|
|
5731
|
+
/** @description Entities in this collection */
|
|
5732
|
+
entities: components["schemas"]["CollectionEntitySummary"][];
|
|
5733
|
+
/** @description Pagination info */
|
|
5734
|
+
pagination: {
|
|
5735
|
+
/** @description Current offset */
|
|
5736
|
+
offset: number;
|
|
5737
|
+
/** @description Requested limit */
|
|
5738
|
+
limit: number;
|
|
5739
|
+
/** @description Number of entities returned */
|
|
5740
|
+
count: number;
|
|
5741
|
+
/** @description Whether more entities exist beyond this page */
|
|
5742
|
+
has_more: boolean;
|
|
5743
|
+
};
|
|
5744
|
+
};
|
|
5621
5745
|
EntityCreatedResponse: {
|
|
5622
5746
|
/**
|
|
5623
5747
|
* @description Entity ID (ULID format)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
*
|
|
7
7
|
* Source: Arke v1 API
|
|
8
8
|
* Version: 1.0.0
|
|
9
|
-
* Generated: 2026-01-
|
|
9
|
+
* Generated: 2026-01-05T15:10:38.577Z
|
|
10
10
|
*/
|
|
11
11
|
type paths = {
|
|
12
12
|
"/auth/register": {
|
|
@@ -1497,6 +1497,89 @@ type paths = {
|
|
|
1497
1497
|
patch?: never;
|
|
1498
1498
|
trace?: never;
|
|
1499
1499
|
};
|
|
1500
|
+
"/collections/{id}/entities": {
|
|
1501
|
+
parameters: {
|
|
1502
|
+
query?: never;
|
|
1503
|
+
header?: never;
|
|
1504
|
+
path?: never;
|
|
1505
|
+
cookie?: never;
|
|
1506
|
+
};
|
|
1507
|
+
/**
|
|
1508
|
+
* List entities in a collection
|
|
1509
|
+
* @description Returns entities belonging to this collection from the graph database.
|
|
1510
|
+
*
|
|
1511
|
+
* Supports pagination and optional type filtering. Results are ordered by creation date (newest first).
|
|
1512
|
+
*/
|
|
1513
|
+
get: {
|
|
1514
|
+
parameters: {
|
|
1515
|
+
query?: {
|
|
1516
|
+
type?: string;
|
|
1517
|
+
limit?: number;
|
|
1518
|
+
offset?: number | null;
|
|
1519
|
+
};
|
|
1520
|
+
header?: never;
|
|
1521
|
+
path: {
|
|
1522
|
+
/** @description Entity ID (ULID) */
|
|
1523
|
+
id: string;
|
|
1524
|
+
};
|
|
1525
|
+
cookie?: never;
|
|
1526
|
+
};
|
|
1527
|
+
requestBody?: never;
|
|
1528
|
+
responses: {
|
|
1529
|
+
/** @description Entities in collection */
|
|
1530
|
+
200: {
|
|
1531
|
+
headers: {
|
|
1532
|
+
[name: string]: unknown;
|
|
1533
|
+
};
|
|
1534
|
+
content: {
|
|
1535
|
+
"application/json": components["schemas"]["CollectionEntitiesResponse"];
|
|
1536
|
+
};
|
|
1537
|
+
};
|
|
1538
|
+
/** @description Forbidden - Insufficient permissions */
|
|
1539
|
+
403: {
|
|
1540
|
+
headers: {
|
|
1541
|
+
[name: string]: unknown;
|
|
1542
|
+
};
|
|
1543
|
+
content: {
|
|
1544
|
+
/**
|
|
1545
|
+
* @example {
|
|
1546
|
+
* "error": "Forbidden: You do not have permission to perform this action"
|
|
1547
|
+
* }
|
|
1548
|
+
*/
|
|
1549
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1550
|
+
};
|
|
1551
|
+
};
|
|
1552
|
+
/** @description Not Found - Resource does not exist */
|
|
1553
|
+
404: {
|
|
1554
|
+
headers: {
|
|
1555
|
+
[name: string]: unknown;
|
|
1556
|
+
};
|
|
1557
|
+
content: {
|
|
1558
|
+
/**
|
|
1559
|
+
* @example {
|
|
1560
|
+
* "error": "Entity not found"
|
|
1561
|
+
* }
|
|
1562
|
+
*/
|
|
1563
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
1564
|
+
};
|
|
1565
|
+
};
|
|
1566
|
+
/** @description GraphDB service unavailable */
|
|
1567
|
+
503: {
|
|
1568
|
+
headers: {
|
|
1569
|
+
[name: string]: unknown;
|
|
1570
|
+
};
|
|
1571
|
+
content?: never;
|
|
1572
|
+
};
|
|
1573
|
+
};
|
|
1574
|
+
};
|
|
1575
|
+
put?: never;
|
|
1576
|
+
post?: never;
|
|
1577
|
+
delete?: never;
|
|
1578
|
+
options?: never;
|
|
1579
|
+
head?: never;
|
|
1580
|
+
patch?: never;
|
|
1581
|
+
trace?: never;
|
|
1582
|
+
};
|
|
1500
1583
|
"/entities": {
|
|
1501
1584
|
parameters: {
|
|
1502
1585
|
query?: never;
|
|
@@ -5618,6 +5701,47 @@ type components = {
|
|
|
5618
5701
|
*/
|
|
5619
5702
|
entity_id: string;
|
|
5620
5703
|
};
|
|
5704
|
+
CollectionEntitySummary: {
|
|
5705
|
+
/** @description Entity persistent identifier */
|
|
5706
|
+
pi: string;
|
|
5707
|
+
/**
|
|
5708
|
+
* @description Entity type
|
|
5709
|
+
* @example document
|
|
5710
|
+
*/
|
|
5711
|
+
type: string;
|
|
5712
|
+
/**
|
|
5713
|
+
* @description Entity display label
|
|
5714
|
+
* @example My Document
|
|
5715
|
+
*/
|
|
5716
|
+
label: string;
|
|
5717
|
+
/**
|
|
5718
|
+
* Format: date-time
|
|
5719
|
+
* @description When the entity was created
|
|
5720
|
+
*/
|
|
5721
|
+
created_at: string;
|
|
5722
|
+
/**
|
|
5723
|
+
* Format: date-time
|
|
5724
|
+
* @description When the entity was last updated
|
|
5725
|
+
*/
|
|
5726
|
+
updated_at: string;
|
|
5727
|
+
};
|
|
5728
|
+
CollectionEntitiesResponse: {
|
|
5729
|
+
/** @description Collection ID */
|
|
5730
|
+
collection_id: string;
|
|
5731
|
+
/** @description Entities in this collection */
|
|
5732
|
+
entities: components["schemas"]["CollectionEntitySummary"][];
|
|
5733
|
+
/** @description Pagination info */
|
|
5734
|
+
pagination: {
|
|
5735
|
+
/** @description Current offset */
|
|
5736
|
+
offset: number;
|
|
5737
|
+
/** @description Requested limit */
|
|
5738
|
+
limit: number;
|
|
5739
|
+
/** @description Number of entities returned */
|
|
5740
|
+
count: number;
|
|
5741
|
+
/** @description Whether more entities exist beyond this page */
|
|
5742
|
+
has_more: boolean;
|
|
5743
|
+
};
|
|
5744
|
+
};
|
|
5621
5745
|
EntityCreatedResponse: {
|
|
5622
5746
|
/**
|
|
5623
5747
|
* @description Entity ID (ULID format)
|
package/openapi/spec.json
CHANGED
|
@@ -1329,6 +1329,93 @@
|
|
|
1329
1329
|
"entity_id"
|
|
1330
1330
|
]
|
|
1331
1331
|
},
|
|
1332
|
+
"CollectionEntitySummary": {
|
|
1333
|
+
"type": "object",
|
|
1334
|
+
"properties": {
|
|
1335
|
+
"pi": {
|
|
1336
|
+
"type": "string",
|
|
1337
|
+
"pattern": "^(?:II[0-9A-HJKMNP-TV-Z]{24}|[FC][0-9A-HJKMNP-TV-Z]{25}|[0-9A-HJKMNP-TV-Z]{26})$",
|
|
1338
|
+
"description": "Entity persistent identifier"
|
|
1339
|
+
},
|
|
1340
|
+
"type": {
|
|
1341
|
+
"type": "string",
|
|
1342
|
+
"description": "Entity type",
|
|
1343
|
+
"example": "document"
|
|
1344
|
+
},
|
|
1345
|
+
"label": {
|
|
1346
|
+
"type": "string",
|
|
1347
|
+
"description": "Entity display label",
|
|
1348
|
+
"example": "My Document"
|
|
1349
|
+
},
|
|
1350
|
+
"created_at": {
|
|
1351
|
+
"type": "string",
|
|
1352
|
+
"format": "date-time",
|
|
1353
|
+
"description": "When the entity was created"
|
|
1354
|
+
},
|
|
1355
|
+
"updated_at": {
|
|
1356
|
+
"type": "string",
|
|
1357
|
+
"format": "date-time",
|
|
1358
|
+
"description": "When the entity was last updated"
|
|
1359
|
+
}
|
|
1360
|
+
},
|
|
1361
|
+
"required": [
|
|
1362
|
+
"pi",
|
|
1363
|
+
"type",
|
|
1364
|
+
"label",
|
|
1365
|
+
"created_at",
|
|
1366
|
+
"updated_at"
|
|
1367
|
+
]
|
|
1368
|
+
},
|
|
1369
|
+
"CollectionEntitiesResponse": {
|
|
1370
|
+
"type": "object",
|
|
1371
|
+
"properties": {
|
|
1372
|
+
"collection_id": {
|
|
1373
|
+
"type": "string",
|
|
1374
|
+
"pattern": "^(?:II[0-9A-HJKMNP-TV-Z]{24}|[FC][0-9A-HJKMNP-TV-Z]{25}|[0-9A-HJKMNP-TV-Z]{26})$",
|
|
1375
|
+
"description": "Collection ID"
|
|
1376
|
+
},
|
|
1377
|
+
"entities": {
|
|
1378
|
+
"type": "array",
|
|
1379
|
+
"items": {
|
|
1380
|
+
"$ref": "#/components/schemas/CollectionEntitySummary"
|
|
1381
|
+
},
|
|
1382
|
+
"description": "Entities in this collection"
|
|
1383
|
+
},
|
|
1384
|
+
"pagination": {
|
|
1385
|
+
"type": "object",
|
|
1386
|
+
"properties": {
|
|
1387
|
+
"offset": {
|
|
1388
|
+
"type": "integer",
|
|
1389
|
+
"description": "Current offset"
|
|
1390
|
+
},
|
|
1391
|
+
"limit": {
|
|
1392
|
+
"type": "integer",
|
|
1393
|
+
"description": "Requested limit"
|
|
1394
|
+
},
|
|
1395
|
+
"count": {
|
|
1396
|
+
"type": "integer",
|
|
1397
|
+
"description": "Number of entities returned"
|
|
1398
|
+
},
|
|
1399
|
+
"has_more": {
|
|
1400
|
+
"type": "boolean",
|
|
1401
|
+
"description": "Whether more entities exist beyond this page"
|
|
1402
|
+
}
|
|
1403
|
+
},
|
|
1404
|
+
"required": [
|
|
1405
|
+
"offset",
|
|
1406
|
+
"limit",
|
|
1407
|
+
"count",
|
|
1408
|
+
"has_more"
|
|
1409
|
+
],
|
|
1410
|
+
"description": "Pagination info"
|
|
1411
|
+
}
|
|
1412
|
+
},
|
|
1413
|
+
"required": [
|
|
1414
|
+
"collection_id",
|
|
1415
|
+
"entities",
|
|
1416
|
+
"pagination"
|
|
1417
|
+
]
|
|
1418
|
+
},
|
|
1332
1419
|
"EntityCreatedResponse": {
|
|
1333
1420
|
"type": "object",
|
|
1334
1421
|
"properties": {
|
|
@@ -5983,6 +6070,108 @@
|
|
|
5983
6070
|
}
|
|
5984
6071
|
}
|
|
5985
6072
|
},
|
|
6073
|
+
"/collections/{id}/entities": {
|
|
6074
|
+
"get": {
|
|
6075
|
+
"tags": [
|
|
6076
|
+
"Collections"
|
|
6077
|
+
],
|
|
6078
|
+
"summary": "List entities in a collection",
|
|
6079
|
+
"description": "Returns entities belonging to this collection from the graph database.\n\nSupports pagination and optional type filtering. Results are ordered by creation date (newest first).",
|
|
6080
|
+
"x-arke-action": "collection:view",
|
|
6081
|
+
"x-arke-auth": "optional",
|
|
6082
|
+
"parameters": [
|
|
6083
|
+
{
|
|
6084
|
+
"schema": {
|
|
6085
|
+
"type": "string",
|
|
6086
|
+
"pattern": "^(?:II[0-9A-HJKMNP-TV-Z]{24}|[FC][0-9A-HJKMNP-TV-Z]{25}|[0-9A-HJKMNP-TV-Z]{26})$",
|
|
6087
|
+
"description": "Entity ID (ULID format)",
|
|
6088
|
+
"example": "01KDETYWYWM0MJVKM8DK3AEXPY"
|
|
6089
|
+
},
|
|
6090
|
+
"required": true,
|
|
6091
|
+
"description": "Entity ID (ULID)",
|
|
6092
|
+
"name": "id",
|
|
6093
|
+
"in": "path"
|
|
6094
|
+
},
|
|
6095
|
+
{
|
|
6096
|
+
"schema": {
|
|
6097
|
+
"type": "string",
|
|
6098
|
+
"description": "Filter entities by type",
|
|
6099
|
+
"example": "document"
|
|
6100
|
+
},
|
|
6101
|
+
"required": false,
|
|
6102
|
+
"name": "type",
|
|
6103
|
+
"in": "query"
|
|
6104
|
+
},
|
|
6105
|
+
{
|
|
6106
|
+
"schema": {
|
|
6107
|
+
"type": "integer",
|
|
6108
|
+
"minimum": 1,
|
|
6109
|
+
"maximum": 10000,
|
|
6110
|
+
"default": 1000,
|
|
6111
|
+
"description": "Maximum number of entities to return",
|
|
6112
|
+
"example": 100
|
|
6113
|
+
},
|
|
6114
|
+
"required": false,
|
|
6115
|
+
"name": "limit",
|
|
6116
|
+
"in": "query"
|
|
6117
|
+
},
|
|
6118
|
+
{
|
|
6119
|
+
"schema": {
|
|
6120
|
+
"type": "integer",
|
|
6121
|
+
"nullable": true,
|
|
6122
|
+
"minimum": 0,
|
|
6123
|
+
"default": 0,
|
|
6124
|
+
"description": "Number of entities to skip",
|
|
6125
|
+
"example": 0
|
|
6126
|
+
},
|
|
6127
|
+
"required": false,
|
|
6128
|
+
"name": "offset",
|
|
6129
|
+
"in": "query"
|
|
6130
|
+
}
|
|
6131
|
+
],
|
|
6132
|
+
"responses": {
|
|
6133
|
+
"200": {
|
|
6134
|
+
"description": "Entities in collection",
|
|
6135
|
+
"content": {
|
|
6136
|
+
"application/json": {
|
|
6137
|
+
"schema": {
|
|
6138
|
+
"$ref": "#/components/schemas/CollectionEntitiesResponse"
|
|
6139
|
+
}
|
|
6140
|
+
}
|
|
6141
|
+
}
|
|
6142
|
+
},
|
|
6143
|
+
"403": {
|
|
6144
|
+
"description": "Forbidden - Insufficient permissions",
|
|
6145
|
+
"content": {
|
|
6146
|
+
"application/json": {
|
|
6147
|
+
"schema": {
|
|
6148
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
6149
|
+
},
|
|
6150
|
+
"example": {
|
|
6151
|
+
"error": "Forbidden: You do not have permission to perform this action"
|
|
6152
|
+
}
|
|
6153
|
+
}
|
|
6154
|
+
}
|
|
6155
|
+
},
|
|
6156
|
+
"404": {
|
|
6157
|
+
"description": "Not Found - Resource does not exist",
|
|
6158
|
+
"content": {
|
|
6159
|
+
"application/json": {
|
|
6160
|
+
"schema": {
|
|
6161
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
6162
|
+
},
|
|
6163
|
+
"example": {
|
|
6164
|
+
"error": "Entity not found"
|
|
6165
|
+
}
|
|
6166
|
+
}
|
|
6167
|
+
}
|
|
6168
|
+
},
|
|
6169
|
+
"503": {
|
|
6170
|
+
"description": "GraphDB service unavailable"
|
|
6171
|
+
}
|
|
6172
|
+
}
|
|
6173
|
+
}
|
|
6174
|
+
},
|
|
5986
6175
|
"/entities": {
|
|
5987
6176
|
"post": {
|
|
5988
6177
|
"tags": [
|
package/openapi/version.json
CHANGED