@kne/fastify-account 1.0.0-alpha.0 → 1.0.0-alpha.1

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/README.md CHANGED
@@ -22,7 +22,7 @@ npm i --save @kne/fastify-account
22
22
  ### API
23
23
 
24
24
  ---
25
- title: "@kne/fastify-account v1.0.0"
25
+ title: "@kne/fastify-account v1.0.0-alpha.0"
26
26
  language_tabs:
27
27
  - shell: Shell
28
28
  - http: HTTP
@@ -42,7 +42,7 @@ headingLevel: 2
42
42
 
43
43
  <!-- Generator: Widdershins v4.0.1 -->
44
44
 
45
- <h1 id="-kne-fastify-account">@kne/fastify-account v1.0.0</h1>
45
+ <h1 id="-kne-fastify-account">@kne/fastify-account v1.0.0-alpha.0</h1>
46
46
 
47
47
  > Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
48
48
 
@@ -619,6 +619,43 @@ This operation does not require authentication
619
619
  This operation does not require authentication
620
620
  </aside>
621
621
 
622
+ ## post__api_v1_account_admin_openUser
623
+
624
+ `POST /api/v1/account/admin/openUser`
625
+
626
+ > Body parameter
627
+
628
+ ```json
629
+ {
630
+ "type": "object",
631
+ "required": [
632
+ "id"
633
+ ],
634
+ "properties": {
635
+ "id": {
636
+ "type": "string"
637
+ }
638
+ }
639
+ }
640
+ ```
641
+
642
+ <h3 id="post__api_v1_account_admin_openuser-parameters">Parameters</h3>
643
+
644
+ |Name|In|Type|Required|Description|
645
+ |---|---|---|---|---|
646
+ |body|body|object|true|none|
647
+ |» id|body|string|true|none|
648
+
649
+ <h3 id="post__api_v1_account_admin_openuser-responses">Responses</h3>
650
+
651
+ |Status|Meaning|Description|Schema|
652
+ |---|---|---|---|
653
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
654
+
655
+ <aside class="success">
656
+ This operation does not require authentication
657
+ </aside>
658
+
622
659
  ## post__api_v1_account_admin_addApplication
623
660
 
624
661
  `POST /api/v1/account/admin/addApplication`
@@ -1004,6 +1041,7 @@ This operation does not require authentication
1004
1041
  |Name|In|Type|Required|Description|
1005
1042
  |---|---|---|---|---|
1006
1043
  |tenantId|query|string|true|none|
1044
+ |filter|query|object|false|none|
1007
1045
 
1008
1046
  <h3 id="get__api_v1_account_admin_getrolelist-responses">Responses</h3>
1009
1047
 
@@ -1369,6 +1407,34 @@ This operation does not require authentication
1369
1407
  This operation does not require authentication
1370
1408
  </aside>
1371
1409
 
1410
+ ## post__api_v1_account_admin_tenant_editOrg
1411
+
1412
+ `POST /api/v1/account/admin/tenant/editOrg`
1413
+
1414
+ <h3 id="post__api_v1_account_admin_tenant_editorg-responses">Responses</h3>
1415
+
1416
+ |Status|Meaning|Description|Schema|
1417
+ |---|---|---|---|
1418
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1419
+
1420
+ <aside class="success">
1421
+ This operation does not require authentication
1422
+ </aside>
1423
+
1424
+ ## post__api_v1_account_admin_tenant_removeOrg
1425
+
1426
+ `POST /api/v1/account/admin/tenant/removeOrg`
1427
+
1428
+ <h3 id="post__api_v1_account_admin_tenant_removeorg-responses">Responses</h3>
1429
+
1430
+ |Status|Meaning|Description|Schema|
1431
+ |---|---|---|---|
1432
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1433
+
1434
+ <aside class="success">
1435
+ This operation does not require authentication
1436
+ </aside>
1437
+
1372
1438
  ## get__api_v1_account_admin_getTenantUserList
1373
1439
 
1374
1440
  `GET /api/v1/account/admin/getTenantUserList`
@@ -1389,6 +1455,475 @@ This operation does not require authentication
1389
1455
  This operation does not require authentication
1390
1456
  </aside>
1391
1457
 
1458
+ ## post__api_v1_account_admin_addTenantUser
1459
+
1460
+ `POST /api/v1/account/admin/addTenantUser`
1461
+
1462
+ > Body parameter
1463
+
1464
+ ```json
1465
+ {
1466
+ "type": "object",
1467
+ "required": [
1468
+ "tenantId",
1469
+ "userId",
1470
+ "name"
1471
+ ],
1472
+ "properties": {
1473
+ "tenantId": {
1474
+ "type": "string"
1475
+ },
1476
+ "roleIds": {
1477
+ "type": "array",
1478
+ "items": {
1479
+ "type": "number"
1480
+ },
1481
+ "default": []
1482
+ },
1483
+ "orgIds": {
1484
+ "type": "array",
1485
+ "items": {
1486
+ "type": "number"
1487
+ },
1488
+ "default": []
1489
+ },
1490
+ "userId": {
1491
+ "type": "string"
1492
+ },
1493
+ "name": {
1494
+ "type": "string"
1495
+ },
1496
+ "avatar": {
1497
+ "type": "string"
1498
+ },
1499
+ "phone": {
1500
+ "type": "string"
1501
+ },
1502
+ "email": {
1503
+ "type": "string"
1504
+ },
1505
+ "description": {
1506
+ "type": "string"
1507
+ }
1508
+ }
1509
+ }
1510
+ ```
1511
+
1512
+ <h3 id="post__api_v1_account_admin_addtenantuser-parameters">Parameters</h3>
1513
+
1514
+ |Name|In|Type|Required|Description|
1515
+ |---|---|---|---|---|
1516
+ |body|body|object|true|none|
1517
+ |» tenantId|body|string|true|none|
1518
+ |» roleIds|body|[number]|false|none|
1519
+ |» orgIds|body|[number]|false|none|
1520
+ |» userId|body|string|true|none|
1521
+ |» name|body|string|true|none|
1522
+ |» avatar|body|string|false|none|
1523
+ |» phone|body|string|false|none|
1524
+ |» email|body|string|false|none|
1525
+ |» description|body|string|false|none|
1526
+
1527
+ <h3 id="post__api_v1_account_admin_addtenantuser-responses">Responses</h3>
1528
+
1529
+ |Status|Meaning|Description|Schema|
1530
+ |---|---|---|---|
1531
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1532
+
1533
+ <aside class="success">
1534
+ This operation does not require authentication
1535
+ </aside>
1536
+
1537
+ ## post__api_v1_account_admin_saveTenantUser
1538
+
1539
+ `POST /api/v1/account/admin/saveTenantUser`
1540
+
1541
+ > Body parameter
1542
+
1543
+ ```json
1544
+ {
1545
+ "type": "object",
1546
+ "required": [
1547
+ "tenantId",
1548
+ "name"
1549
+ ],
1550
+ "properties": {
1551
+ "tenantId": {
1552
+ "type": "string"
1553
+ },
1554
+ "roleIds": {
1555
+ "type": "array",
1556
+ "items": {
1557
+ "type": "number"
1558
+ },
1559
+ "default": []
1560
+ },
1561
+ "orgIds": {
1562
+ "type": "array",
1563
+ "items": {
1564
+ "type": "number"
1565
+ },
1566
+ "default": []
1567
+ },
1568
+ "name": {
1569
+ "type": "string"
1570
+ },
1571
+ "avatar": {
1572
+ "type": "string"
1573
+ },
1574
+ "phone": {
1575
+ "type": "string"
1576
+ },
1577
+ "email": {
1578
+ "type": "string"
1579
+ },
1580
+ "description": {
1581
+ "type": "string"
1582
+ }
1583
+ }
1584
+ }
1585
+ ```
1586
+
1587
+ <h3 id="post__api_v1_account_admin_savetenantuser-parameters">Parameters</h3>
1588
+
1589
+ |Name|In|Type|Required|Description|
1590
+ |---|---|---|---|---|
1591
+ |body|body|object|true|none|
1592
+ |» tenantId|body|string|true|none|
1593
+ |» roleIds|body|[number]|false|none|
1594
+ |» orgIds|body|[number]|false|none|
1595
+ |» name|body|string|true|none|
1596
+ |» avatar|body|string|false|none|
1597
+ |» phone|body|string|false|none|
1598
+ |» email|body|string|false|none|
1599
+ |» description|body|string|false|none|
1600
+
1601
+ <h3 id="post__api_v1_account_admin_savetenantuser-responses">Responses</h3>
1602
+
1603
+ |Status|Meaning|Description|Schema|
1604
+ |---|---|---|---|
1605
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1606
+
1607
+ <aside class="success">
1608
+ This operation does not require authentication
1609
+ </aside>
1610
+
1611
+ ## post__api_v1_account_admin_deleteTenantUser
1612
+
1613
+ `POST /api/v1/account/admin/deleteTenantUser`
1614
+
1615
+ > Body parameter
1616
+
1617
+ ```json
1618
+ {
1619
+ "type": "object",
1620
+ "required": [
1621
+ "tenantId",
1622
+ "tenantUserId"
1623
+ ],
1624
+ "properties": {
1625
+ "tenantId": {
1626
+ "type": "string"
1627
+ },
1628
+ "tenantUserId": {
1629
+ "type": "string"
1630
+ }
1631
+ }
1632
+ }
1633
+ ```
1634
+
1635
+ <h3 id="post__api_v1_account_admin_deletetenantuser-parameters">Parameters</h3>
1636
+
1637
+ |Name|In|Type|Required|Description|
1638
+ |---|---|---|---|---|
1639
+ |body|body|object|true|none|
1640
+ |» tenantId|body|string|true|none|
1641
+ |» tenantUserId|body|string|true|none|
1642
+
1643
+ <h3 id="post__api_v1_account_admin_deletetenantuser-responses">Responses</h3>
1644
+
1645
+ |Status|Meaning|Description|Schema|
1646
+ |---|---|---|---|
1647
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1648
+
1649
+ <aside class="success">
1650
+ This operation does not require authentication
1651
+ </aside>
1652
+
1653
+ ## post__api_v1_account_admin_closeTenant
1654
+
1655
+ `POST /api/v1/account/admin/closeTenant`
1656
+
1657
+ > Body parameter
1658
+
1659
+ ```json
1660
+ {
1661
+ "type": "object",
1662
+ "required": [
1663
+ "tenantId"
1664
+ ],
1665
+ "properties": {
1666
+ "tenantId": {
1667
+ "type": "string"
1668
+ }
1669
+ }
1670
+ }
1671
+ ```
1672
+
1673
+ <h3 id="post__api_v1_account_admin_closetenant-parameters">Parameters</h3>
1674
+
1675
+ |Name|In|Type|Required|Description|
1676
+ |---|---|---|---|---|
1677
+ |body|body|object|true|none|
1678
+ |» tenantId|body|string|true|none|
1679
+
1680
+ <h3 id="post__api_v1_account_admin_closetenant-responses">Responses</h3>
1681
+
1682
+ |Status|Meaning|Description|Schema|
1683
+ |---|---|---|---|
1684
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1685
+
1686
+ <aside class="success">
1687
+ This operation does not require authentication
1688
+ </aside>
1689
+
1690
+ ## post__api_v1_account_admin_openTenant
1691
+
1692
+ `POST /api/v1/account/admin/openTenant`
1693
+
1694
+ > Body parameter
1695
+
1696
+ ```json
1697
+ {
1698
+ "type": "object",
1699
+ "required": [
1700
+ "tenantId"
1701
+ ],
1702
+ "properties": {
1703
+ "tenantId": {
1704
+ "type": "string"
1705
+ }
1706
+ }
1707
+ }
1708
+ ```
1709
+
1710
+ <h3 id="post__api_v1_account_admin_opentenant-parameters">Parameters</h3>
1711
+
1712
+ |Name|In|Type|Required|Description|
1713
+ |---|---|---|---|---|
1714
+ |body|body|object|true|none|
1715
+ |» tenantId|body|string|true|none|
1716
+
1717
+ <h3 id="post__api_v1_account_admin_opentenant-responses">Responses</h3>
1718
+
1719
+ |Status|Meaning|Description|Schema|
1720
+ |---|---|---|---|
1721
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1722
+
1723
+ <aside class="success">
1724
+ This operation does not require authentication
1725
+ </aside>
1726
+
1727
+ ## post__api_v1_account_admin_closeTenantUser
1728
+
1729
+ `POST /api/v1/account/admin/closeTenantUser`
1730
+
1731
+ > Body parameter
1732
+
1733
+ ```json
1734
+ {
1735
+ "type": "object",
1736
+ "required": [
1737
+ "tenantId",
1738
+ "tenantUserId"
1739
+ ],
1740
+ "properties": {
1741
+ "tenantId": {
1742
+ "type": "string"
1743
+ },
1744
+ "tenantUserId": {
1745
+ "type": "string"
1746
+ }
1747
+ }
1748
+ }
1749
+ ```
1750
+
1751
+ <h3 id="post__api_v1_account_admin_closetenantuser-parameters">Parameters</h3>
1752
+
1753
+ |Name|In|Type|Required|Description|
1754
+ |---|---|---|---|---|
1755
+ |body|body|object|true|none|
1756
+ |» tenantId|body|string|true|none|
1757
+ |» tenantUserId|body|string|true|none|
1758
+
1759
+ <h3 id="post__api_v1_account_admin_closetenantuser-responses">Responses</h3>
1760
+
1761
+ |Status|Meaning|Description|Schema|
1762
+ |---|---|---|---|
1763
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1764
+
1765
+ <aside class="success">
1766
+ This operation does not require authentication
1767
+ </aside>
1768
+
1769
+ ## post__api_v1_account_admin_openTenantUser
1770
+
1771
+ `POST /api/v1/account/admin/openTenantUser`
1772
+
1773
+ > Body parameter
1774
+
1775
+ ```json
1776
+ {
1777
+ "type": "object",
1778
+ "required": [
1779
+ "tenantId",
1780
+ "tenantUserId"
1781
+ ],
1782
+ "properties": {
1783
+ "tenantId": {
1784
+ "type": "string"
1785
+ },
1786
+ "tenantUserId": {
1787
+ "type": "string"
1788
+ }
1789
+ }
1790
+ }
1791
+ ```
1792
+
1793
+ <h3 id="post__api_v1_account_admin_opentenantuser-parameters">Parameters</h3>
1794
+
1795
+ |Name|In|Type|Required|Description|
1796
+ |---|---|---|---|---|
1797
+ |body|body|object|true|none|
1798
+ |» tenantId|body|string|true|none|
1799
+ |» tenantUserId|body|string|true|none|
1800
+
1801
+ <h3 id="post__api_v1_account_admin_opentenantuser-responses">Responses</h3>
1802
+
1803
+ |Status|Meaning|Description|Schema|
1804
+ |---|---|---|---|
1805
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1806
+
1807
+ <aside class="success">
1808
+ This operation does not require authentication
1809
+ </aside>
1810
+
1811
+ ## get__api_v1_account_admin_getInviteList
1812
+
1813
+ `GET /api/v1/account/admin/getInviteList`
1814
+
1815
+ <h3 id="get__api_v1_account_admin_getinvitelist-parameters">Parameters</h3>
1816
+
1817
+ |Name|In|Type|Required|Description|
1818
+ |---|---|---|---|---|
1819
+ |tenantId|query|string|true|none|
1820
+
1821
+ <h3 id="get__api_v1_account_admin_getinvitelist-responses">Responses</h3>
1822
+
1823
+ |Status|Meaning|Description|Schema|
1824
+ |---|---|---|---|
1825
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1826
+
1827
+ <aside class="success">
1828
+ This operation does not require authentication
1829
+ </aside>
1830
+
1831
+ ## post__api_v1_account_admin_addInviteToken
1832
+
1833
+ `POST /api/v1/account/admin/addInviteToken`
1834
+
1835
+ > Body parameter
1836
+
1837
+ ```json
1838
+ {
1839
+ "type": "object",
1840
+ "required": [
1841
+ "tenantId"
1842
+ ],
1843
+ "properties": {
1844
+ "tenantId": {
1845
+ "type": "string"
1846
+ },
1847
+ "info": {
1848
+ "type": "object",
1849
+ "properties": {
1850
+ "roleIds": {
1851
+ "type": "array",
1852
+ "items": {
1853
+ "type": "number"
1854
+ },
1855
+ "default": []
1856
+ },
1857
+ "orgIds": {
1858
+ "type": "array",
1859
+ "items": {
1860
+ "type": "number"
1861
+ },
1862
+ "default": []
1863
+ }
1864
+ }
1865
+ }
1866
+ }
1867
+ }
1868
+ ```
1869
+
1870
+ <h3 id="post__api_v1_account_admin_addinvitetoken-parameters">Parameters</h3>
1871
+
1872
+ |Name|In|Type|Required|Description|
1873
+ |---|---|---|---|---|
1874
+ |body|body|object|true|none|
1875
+ |» tenantId|body|string|true|none|
1876
+ |» info|body|object|false|none|
1877
+ |»» roleIds|body|[number]|false|none|
1878
+ |»» orgIds|body|[number]|false|none|
1879
+
1880
+ <h3 id="post__api_v1_account_admin_addinvitetoken-responses">Responses</h3>
1881
+
1882
+ |Status|Meaning|Description|Schema|
1883
+ |---|---|---|---|
1884
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1885
+
1886
+ <aside class="success">
1887
+ This operation does not require authentication
1888
+ </aside>
1889
+
1890
+ ## post__api_v1_account_admin_deleteInviteToken
1891
+
1892
+ `POST /api/v1/account/admin/deleteInviteToken`
1893
+
1894
+ > Body parameter
1895
+
1896
+ ```json
1897
+ {
1898
+ "type": "object",
1899
+ "required": [
1900
+ "id"
1901
+ ],
1902
+ "properties": {
1903
+ "id": {
1904
+ "type": "number"
1905
+ }
1906
+ }
1907
+ }
1908
+ ```
1909
+
1910
+ <h3 id="post__api_v1_account_admin_deleteinvitetoken-parameters">Parameters</h3>
1911
+
1912
+ |Name|In|Type|Required|Description|
1913
+ |---|---|---|---|---|
1914
+ |body|body|object|true|none|
1915
+ |» id|body|number|true|none|
1916
+
1917
+ <h3 id="post__api_v1_account_admin_deleteinvitetoken-responses">Responses</h3>
1918
+
1919
+ |Status|Meaning|Description|Schema|
1920
+ |---|---|---|---|
1921
+ |200|[OK](https://tools.ietf.org/html/rfc7231#section-6.3.1)|Default Response|None|
1922
+
1923
+ <aside class="success">
1924
+ This operation does not require authentication
1925
+ </aside>
1926
+
1392
1927
  ## get__api_v1_account_tenant_getUserTenant
1393
1928
 
1394
1929
  `GET /api/v1/account/tenant/getUserTenant`
@@ -23,6 +23,7 @@ module.exports = (sequelize, DataTypes) => {
23
23
  paranoid: true,
24
24
  indexes: [
25
25
  {
26
+ name: 'application_key',
26
27
  unique: true,
27
28
  fields: ['tenantId', 'applicationId', 'roleId', 'deletedAt']
28
29
  }
@@ -23,6 +23,7 @@ module.exports = (sequelize, DataTypes) => {
23
23
  paranoid: true,
24
24
  indexes: [
25
25
  {
26
+ name: 'permission_key',
26
27
  unique: true,
27
28
  fields: ['tenantId', 'permissionId', 'roleId', 'deletedAt']
28
29
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@kne/fastify-account",
3
- "version": "1.0.0-alpha.0",
3
+ "version": "1.0.0-alpha.1",
4
4
  "description": "fastify的用户管理账号等实现",
5
5
  "main": "index.js",
6
6
  "scripts": {
@@ -39,6 +39,7 @@
39
39
  "devDependencies": {
40
40
  "@fastify/swagger": "^8.14.0",
41
41
  "@kne/fastify-file-manager": "^1.0.0",
42
+ "@kne/fastify-response-data-format": "^0.1.0",
42
43
  "@kne/fastify-sequelize": "^1.0.0",
43
44
  "fastify": "^4.27.0",
44
45
  "husky": "^9.0.11",